@tanstack/router-plugin 1.167.1 → 1.167.3

package/dist/esm/core/code-splitter/compilers.js

@@ -1,5 +1,6 @@
 import { tsrShared, tsrSplit } from "../constants.js";
-import { routeHmrStatement } from "../route-hmr-statement.js";
+import { createRouteHmrStatement } from "../route-hmr-statement.js";
+import { getObjectPropertyKeyName } from "../utils.js";
 import { createIdentifier } from "./path-ids.js";
 import { getFrameworkOptions } from "./framework-options.js";
 import { deadCodeElimination, findReferencedIdentifiers, generateFromAst, parseAst } from "@tanstack/router-utils";
@@ -162,10 +163,12 @@ function computeSharedBindings(opts) {
 	const splitGroupsPresent = /* @__PURE__ */ new Set();
 	let hasNonSplit = false;
 	for (const prop of routeOptions.properties) {
-		if (!t.isObjectProperty(prop) || !t.isIdentifier(prop.key)) continue;
-		if (prop.key.name === "codeSplitGroupings") continue;
+		if (!t.isObjectProperty(prop)) continue;
+		const key = getObjectPropertyKeyName(prop);
+		if (!key) continue;
+		if (key === "codeSplitGroupings") continue;
 		if (t.isIdentifier(prop.value) && prop.value.name === "undefined") continue;
-		const groupIndex = findIndexForSplitNode(prop.key.name);
+		const groupIndex = findIndexForSplitNode(key);
 		if (groupIndex === -1) hasNonSplit = true;
 		else splitGroupsPresent.add(groupIndex);
 	}
@@ -177,8 +180,9 @@ function computeSharedBindings(opts) {
 	const fullDepGraph = buildDependencyGraph(declMap, allLocalBindings);
 	const refsByGroup = /* @__PURE__ */ new Map();
 	for (const prop of routeOptions.properties) {
-		if (!t.isObjectProperty(prop) || !t.isIdentifier(prop.key)) continue;
-		const key = prop.key.name;
+		if (!t.isObjectProperty(prop)) continue;
+		const key = getObjectPropertyKeyName(prop);
+		if (!key) continue;
 		if (key === "codeSplitGroupings") continue;
 		const groupIndex = findIndexForSplitNode(key);
 		const directRefs = collectModuleLevelRefsFromNode(prop.value, localModuleLevelBindings);
@@ -358,6 +362,7 @@ function compileCodeSplitReferenceRoute(opts) {
 	const PACKAGE = frameworkOptions.package;
 	const LAZY_ROUTE_COMPONENT_IDENT = frameworkOptions.idents.lazyRouteComponent;
 	const LAZY_FN_IDENT = frameworkOptions.idents.lazyFn;
+	const stableRouteOptionKeys = [...new Set((opts.compilerPlugins ?? []).flatMap((plugin) => plugin.getStableRouteOptionKeys?.() ?? []))];
 	let createRouteFn;
 	let modified = false;
 	let hmrAdded = false;
@@ -381,20 +386,35 @@ function compileCodeSplitReferenceRoute(opts) {
 				const hasImportedOrDefinedIdentifier = (name) => {
 					return programPath.scope.hasBinding(name);
 				};
+				const addRouteHmr = (insertionPath, routeOptions) => {
+					if (!opts.addHmr || hmrAdded) return;
+					opts.compilerPlugins?.forEach((plugin) => {
+						if ((plugin.onAddHmr?.({
+							programPath,
+							callExpressionPath: path,
+							insertionPath,
+							routeOptions,
+							createRouteFn,
+							opts
+						}))?.modified) modified = true;
+					});
+					programPath.pushContainer("body", createRouteHmrStatement(stableRouteOptionKeys));
+					modified = true;
+					hmrAdded = true;
+				};
 				if (t.isObjectExpression(routeOptions)) {
+					const insertionPath = path.getStatementParent() ?? path;
 					if (opts.deleteNodes && opts.deleteNodes.size > 0) routeOptions.properties = routeOptions.properties.filter((prop) => {
 						if (t.isObjectProperty(prop)) {
-							if (t.isIdentifier(prop.key)) {
-								if (opts.deleteNodes.has(prop.key.name)) {
-									modified = true;
-									return false;
-								}
+							const key = getObjectPropertyKeyName(prop);
+							if (key && opts.deleteNodes.has(key)) {
+								modified = true;
+								return false;
 							}
 						}
 						return true;
 					});
 					if (!splittableCreateRouteFns.includes(createRouteFn)) {
-						const insertionPath = path.getStatementParent() ?? path;
 						opts.compilerPlugins?.forEach((plugin) => {
 							if ((plugin.onUnsplittableRoute?.({
 								programPath,
@@ -405,17 +425,13 @@ function compileCodeSplitReferenceRoute(opts) {
 								opts
 							}))?.modified) modified = true;
 						});
-						if (opts.addHmr && !hmrAdded) {
-							programPath.pushContainer("body", routeHmrStatement);
-							modified = true;
-							hmrAdded = true;
-						}
+						addRouteHmr(insertionPath, routeOptions);
 						return programPath.stop();
 					}
 					routeOptions.properties.forEach((prop) => {
 						if (t.isObjectProperty(prop)) {
-							if (t.isIdentifier(prop.key)) {
-								const key = prop.key.name;
+							const key = getObjectPropertyKeyName(prop);
+							if (key) {
 								const codeSplitGroupingByKey = findIndexForSplitNode(key);
 								if (codeSplitGroupingByKey === -1) return;
 								const codeSplitGroup = [...new Set(opts.codeSplitGroupings[codeSplitGroupingByKey])];
@@ -438,12 +454,26 @@ function compileCodeSplitReferenceRoute(opts) {
 									modified = true;
 									if (!hasImportedOrDefinedIdentifier(LAZY_ROUTE_COMPONENT_IDENT)) programPath.unshiftContainer("body", [template.statement(`import { ${LAZY_ROUTE_COMPONENT_IDENT} } from '${PACKAGE}'`)()]);
 									if (!hasImportedOrDefinedIdentifier(splitNodeMeta.localImporterIdent)) programPath.unshiftContainer("body", [template.statement(`const ${splitNodeMeta.localImporterIdent} = () => import('${splitUrl}')`)()]);
-									prop.value = template.expression(`${LAZY_ROUTE_COMPONENT_IDENT}(${splitNodeMeta.localImporterIdent}, '${splitNodeMeta.exporterIdent}')`)();
-									if (opts.addHmr && !hmrAdded) {
-										programPath.pushContainer("body", routeHmrStatement);
+									const insertionPath = path.getStatementParent() ?? path;
+									let splitPropValue;
+									for (const plugin of opts.compilerPlugins ?? []) {
+										const pluginPropValue = plugin.onSplitRouteProperty?.({
+											programPath,
+											callExpressionPath: path,
+											insertionPath,
+											routeOptions,
+											prop,
+											splitNodeMeta,
+											lazyRouteComponentIdent: LAZY_ROUTE_COMPONENT_IDENT
+										});
+										if (!pluginPropValue) continue;
 										modified = true;
-										hmrAdded = true;
+										splitPropValue = pluginPropValue;
+										break;
 									}
+									if (splitPropValue) prop.value = splitPropValue;
+									else prop.value = template.expression(`${LAZY_ROUTE_COMPONENT_IDENT}(${splitNodeMeta.localImporterIdent}, '${splitNodeMeta.exporterIdent}')`)();
+									addRouteHmr(insertionPath, routeOptions);
 								} else {
 									const value = prop.value;
 									let shouldSplit = true;
@@ -465,6 +495,7 @@ function compileCodeSplitReferenceRoute(opts) {
 						}
 						programPath.scope.crawl();
 					});
+					addRouteHmr(insertionPath, routeOptions);
 				}
 			}
 			if (t.isCallExpression(path.parentPath.node)) babelHandleReference(resolveIdentifier(path, path.parentPath.node.arguments[0]));
@@ -540,7 +571,7 @@ function compileCodeSplitVirtualRoute(opts) {
 				if (t.isObjectExpression(options)) {
 					options.properties.forEach((prop) => {
 						if (t.isObjectProperty(prop)) KNOWN_SPLIT_ROUTE_IDENTS.forEach((splitType) => {
-							if (!t.isIdentifier(prop.key) || prop.key.name !== splitType) return;
+							if (getObjectPropertyKeyName(prop) !== splitType) return;
 							const value = prop.value;
 							if (t.isIdentifier(value) && value.name === "undefined") return;
 							let isExported = false;
@@ -734,18 +765,16 @@ function detectCodeSplitGroupingsFromRoute(opts) {
 			function babelHandleSplittingGroups(routeOptions) {
 				if (t.isObjectExpression(routeOptions)) routeOptions.properties.forEach((prop) => {
 					if (t.isObjectProperty(prop)) {
-						if (t.isIdentifier(prop.key)) {
-							if (prop.key.name === "codeSplitGroupings") {
-								const value = prop.value;
-								if (t.isArrayExpression(value)) codeSplitGroupings = value.elements.map((group) => {
-									if (t.isArrayExpression(group)) return group.elements.map((node) => {
-										if (!t.isStringLiteral(node)) throw new Error("You must provide a string literal for the codeSplitGroupings");
-										return node.value;
-									});
-									throw new Error("You must provide arrays with codeSplitGroupings options.");
+						if (getObjectPropertyKeyName(prop) === "codeSplitGroupings") {
+							const value = prop.value;
+							if (t.isArrayExpression(value)) codeSplitGroupings = value.elements.map((group) => {
+								if (t.isArrayExpression(group)) return group.elements.map((node) => {
+									if (!t.isStringLiteral(node)) throw new Error("You must provide a string literal for the codeSplitGroupings");
+									return node.value;
 								});
-								else throw new Error("You must provide an array of arrays for the codeSplitGroupings.");
-							}
+								throw new Error("You must provide arrays with codeSplitGroupings options.");
+							});
+							else throw new Error("You must provide an array of arrays for the codeSplitGroupings.");
 						}
 					}
 				});