8bfcae4 fix(@angular/ssr): support getPrerenderParams for wildcard routes

Author: Angular Builds

fesm2022/ssr.mjs

@@ -818,6 +818,11 @@ class RouteTree {
  * initial scripts.
  */
 const MODULE_PRELOAD_MAX = 10;
+/**
+ * Regular expression to match a catch-all route pattern in a URL path,
+ * specifically one that ends with '/**'.
+ */
+const CATCH_ALL_REGEXP = /\/(\*\*)$/;
 /**
  * Regular expression to match segments preceded by a colon in a string.
  */
@@ -1024,7 +1029,9 @@ async function* handleSSGRoute(serverConfigRouteTree, redirectTo, metadata, pare
     if (redirectTo !== undefined) {
         meta.redirectTo = resolveRedirectTo(currentRoutePath, redirectTo);
     }
-    if (!URL_PARAMETER_REGEXP.test(currentRoutePath)) {
+    const isCatchAllRoute = CATCH_ALL_REGEXP.test(currentRoutePath);
+    if ((isCatchAllRoute && !getPrerenderParams) ||
+        (!isCatchAllRoute && !URL_PARAMETER_REGEXP.test(currentRoutePath))) {
         // Route has no parameters
         yield {
             ...meta,
@@ -1043,7 +1050,9 @@ async function* handleSSGRoute(serverConfigRouteTree, redirectTo, metadata, pare
         }
         if (serverConfigRouteTree) {
             // Automatically resolve dynamic parameters for nested routes.
-            const catchAllRoutePath = joinUrlParts(currentRoutePath, '**');
+            const catchAllRoutePath = isCatchAllRoute
+                ? currentRoutePath
+                : joinUrlParts(currentRoutePath, '**');
             const match = serverConfigRouteTree.match(catchAllRoutePath);
             if (match && match.renderMode === RenderMode.Prerender && !('getPrerenderParams' in match)) {
                 serverConfigRouteTree.insert(catchAllRoutePath, {
@@ -1056,17 +1065,10 @@ async function* handleSSGRoute(serverConfigRouteTree, redirectTo, metadata, pare
         const parameters = await runInInjectionContext(parentInjector, () => getPrerenderParams());
         try {
             for (const params of parameters) {
-                const routeWithResolvedParams = currentRoutePath.replace(URL_PARAMETER_REGEXP, (match) => {
-                    const parameterName = match.slice(1);
-                    const value = params[parameterName];
-                    if (typeof value !== 'string') {
-                        throw new Error(`The 'getPrerenderParams' function defined for the '${stripLeadingSlash(currentRoutePath)}' route ` +
-                            `returned a non-string value for parameter '${parameterName}'. ` +
-                            `Please make sure the 'getPrerenderParams' function returns values for all parameters ` +
-                            'specified in this route.');
-                    }
-                    return value;
-                });
+                const replacer = handlePrerenderParamsReplacement(params, currentRoutePath);
+                const routeWithResolvedParams = currentRoutePath
+                    .replace(URL_PARAMETER_REGEXP, replacer)
+                    .replace(CATCH_ALL_REGEXP, replacer);
                 yield {
                     ...meta,
                     route: routeWithResolvedParams,
@@ -1091,6 +1093,27 @@ async function* handleSSGRoute(serverConfigRouteTree, redirectTo, metadata, pare
         };
     }
 }
+/**
+ * Creates a replacer function used for substituting parameter placeholders in a route path
+ * with their corresponding values provided in the `params` object.
+ *
+ * @param params - An object mapping parameter names to their string values.
+ * @param currentRoutePath - The current route path, used for constructing error messages.
+ * @returns A function that replaces a matched parameter placeholder (e.g., ':id') with its corresponding value.
+ */
+function handlePrerenderParamsReplacement(params, currentRoutePath) {
+    return (match) => {
+        const parameterName = match.slice(1);
+        const value = params[parameterName];
+        if (typeof value !== 'string') {
+            throw new Error(`The 'getPrerenderParams' function defined for the '${stripLeadingSlash(currentRoutePath)}' route ` +
+                `returned a non-string value for parameter '${parameterName}'. ` +
+                `Please make sure the 'getPrerenderParams' function returns values for all parameters ` +
+                'specified in this route.');
+        }
+        return parameterName === '**' ? `/${value}` : value;
+    };
+}
 /**
  * Resolves the `redirectTo` property for a given route.
  *
@@ -1138,8 +1161,8 @@ function buildServerConfigRouteTree({ routes, appShellRoute }) {
             errors.push(`Invalid '${path}' route configuration: the path cannot start with a slash.`);
             continue;
         }
-        if (path.includes('*') && 'getPrerenderParams' in metadata) {
-            errors.push(`Invalid '${path}' route configuration: 'getPrerenderParams' cannot be used with a '*' or '**' route.`);
+        if ('getPrerenderParams' in metadata && (path.includes('/*/') || path.endsWith('/*'))) {
+            errors.push(`Invalid '${path}' route configuration: 'getPrerenderParams' cannot be used with a '*' route.`);
             continue;
         }
         serverConfigRouteTree.insert(path, metadata);

fesm2022/ssr.mjs.map

@@ -105,6 +105,10 @@ interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerender, 'fal
      * A function that returns a Promise resolving to an array of objects, each representing a route path with URL parameters.
      * This function runs in the injector context, allowing access to Angular services and dependencies.
      *
+     * It also works for catch-all routes (e.g., `/**`), where the parameter name will be `**` and the return value will be
+     * the segments of the path, such as `/foo/bar`. These routes can also be combined, e.g., `/product/:id/**`,
+     * where both a parameterized segment (`:id`) and a catch-all segment (`**`) can be used together to handle more complex paths.
+     *
      * @returns A Promise resolving to an array where each element is an object with string keys (representing URL parameter names)
      * and string values (representing the corresponding values for those parameters in the route path).
      *
@@ -118,7 +122,17 @@ interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerender, 'fal
      *       const productService = inject(ProductService);
      *       const ids = await productService.getIds(); // Assuming this returns ['1', '2', '3']
      *
-     *       return ids.map(id => ({ id })); // Generates paths like: [{ id: '1' }, { id: '2' }, { id: '3' }]
+     *       return ids.map(id => ({ id })); // Generates paths like: ['product/1', 'product/2', 'product/3']
+     *     },
+     *   },
+     *   {
+     *     path: '/product/:id/**',
+     *     renderMode: RenderMode.Prerender,
+     *     async getPrerenderParams() {
+     *       return [
+     *         { id: '1', '**': 'laptop/3' },
+     *         { id: '2', '**': 'laptop/4' }
+     *       ]; // Generates paths like: ['product/1/laptop/3', 'product/2/laptop/4']
      *     },
      *   },
      * ];

index.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@angular/ssr",
-  "version": "20.0.0-next.6+sha-e03f2b8",
+  "version": "20.0.0-next.6+sha-8bfcae4",
   "description": "Angular server side rendering utilities",
   "type": "module",
   "license": "MIT",

package.json

@@ -1 +1 @@
-Wed Apr 23 2025 06:30:28 GMT+0000 (Coordinated Universal Time)
+Wed Apr 23 2025 07:49:17 GMT+0000 (Coordinated Universal Time)