@angular/ssr 19.1.4 → 19.1.5

package/index.d.ts

@@ -1,7 +1,9 @@
 import type { ApplicationRef } from '@angular/core';
 import { default as default_2 } from 'beasties';
+import { DefaultExport } from '@angular/router';
 import { EnvironmentProviders } from '@angular/core';
-import type { Type } from '@angular/core';
+import { Provider } from '@angular/core';
+import { Type } from '@angular/core';
 
 /**
  * Angular server application engine.
@@ -533,13 +535,31 @@ export declare enum PrerenderFallback {
  *
  * @see {@link ServerRoute}
  * @see {@link ServerRoutesConfigOptions}
+ * @see {@link provideServerRouting}
+ * @deprecated use `provideServerRouting`. This will be removed in version 20.
  * @developerPreview
  */
 export declare function provideServerRoutesConfig(routes: ServerRoute[], options?: ServerRoutesConfigOptions): EnvironmentProviders;
 
+/**
+ * Sets up the necessary providers for configuring server routes.
+ * This function accepts an array of server routes and optional configuration
+ * options, returning an `EnvironmentProviders` object that encapsulates
+ * the server routes and configuration settings.
+ *
+ * @param routes - An array of server routes to be provided.
+ * @param features - (Optional) server routes features.
+ * @returns An `EnvironmentProviders` instance with the server routes configuration.
+ *
+ * @see {@link ServerRoute}
+ * @see {@link withAppShell}
+ * @developerPreview
+ */
+export declare function provideServerRouting(routes: ServerRoute[], ...features: ServerRoutesFeature<ServerRoutesFeatureKind>[]): EnvironmentProviders;
+
 /**
  * Different rendering modes for server routes.
- * @see {@link provideServerRoutesConfig}
+ * @see {@link provideServerRouting}
  * @see {@link ServerRoute}
  * @developerPreview
  */
@@ -576,12 +596,6 @@ declare class RouteTree<AdditionalMetadata extends Record<string, unknown> = {}>
      * All routes are stored and accessed relative to this root node.
      */
     private readonly root;
-    /**
-     * A counter that tracks the order of route insertion.
-     * This ensures that routes are matched in the order they were defined,
-     * with earlier routes taking precedence.
-     */
-    private insertionIndexCounter;
     /**
      * Inserts a new route into the route tree.
      * The route is broken down into segments, and each segment is added to the tree.
@@ -641,26 +655,18 @@ declare class RouteTree<AdditionalMetadata extends Record<string, unknown> = {}>
      * This function prioritizes exact segment matches first, followed by wildcard matches (`*`),
      * and finally deep wildcard matches (`**`) that consume all segments.
      *
-     * @param remainingSegments - The remaining segments of the route path to match.
-     * @param node - The current node in the route tree to start traversal from.
+     * @param segments - The array of route path segments to match against the route tree.
+     * @param node - The current node in the route tree to start traversal from. Defaults to the root node.
+     * @param currentIndex - The index of the segment in `remainingSegments` currently being matched.
+     * Defaults to `0` (the first segment).
      *
      * @returns The node that best matches the remaining segments or `undefined` if no match is found.
      */
     private traverseBySegments;
     /**
-     * Compares two nodes and returns the node with higher priority based on insertion index.
-     * A node with a lower insertion index is prioritized as it was defined earlier.
-     *
-     * @param currentBestMatchNode - The current best match node.
-     * @param candidateNode - The node being evaluated for higher priority based on insertion index.
-     * @returns The node with higher priority (i.e., lower insertion index). If one of the nodes is `undefined`, the other node is returned.
-     */
-    private getHigherPriorityNode;
-    /**
-     * Creates an empty route tree node with the specified segment.
+     * Creates an empty route tree node.
      * This helper function is used during the tree construction.
      *
-     * @param segment - The route segment that this node represents.
      * @returns A new, empty route tree node.
      */
     private createEmptyRouteTreeNode;
@@ -672,19 +678,6 @@ declare class RouteTree<AdditionalMetadata extends Record<string, unknown> = {}>
  * The `AdditionalMetadata` type parameter allows for extending the node metadata with custom data.
  */
 declare interface RouteTreeNode<AdditionalMetadata extends Record<string, unknown>> {
-    /**
-     * The segment value associated with this node.
-     * A segment is a single part of a route path, typically delimited by slashes (`/`).
-     * For example, in the route `/users/:id/profile`, the segments are `users`, `:id`, and `profile`.
-     * Segments can also be wildcards (`*`), which match any segment in that position of the route.
-     */
-    segment: string;
-    /**
-     * The index indicating the order in which the route was inserted into the tree.
-     * This index helps determine the priority of routes during matching, with lower indexes
-     * indicating earlier inserted routes.
-     */
-    insertionIndex: number;
     /**
      * A map of child nodes, keyed by their corresponding route segment or wildcard.
      */
@@ -775,7 +768,7 @@ declare interface ServerAsset {
 
 /**
  * Server route configuration.
- * @see {@link provideServerRoutesConfig}
+ * @see {@link provideServerRouting}
  * @developerPreview
  */
 export declare type ServerRoute = ServerRouteClient | ServerRoutePrerender | ServerRoutePrerenderWithParams | ServerRouteServer;
@@ -867,16 +860,15 @@ export declare interface ServerRoutePrerenderWithParams extends Omit<ServerRoute
  * This interface defines the optional settings available for configuring server routes
  * in the server-side environment, such as specifying a path to the app shell route.
  *
- * @see {@link provideServerRoutesConfig}
- * @developerPreview
+ *
+ * @see {@link provideServerRouting}
+ * @deprecated use `provideServerRouting`. This will be removed in version 20.
  */
 export declare interface ServerRoutesConfigOptions {
     /**
      * Defines the route to be used as the app shell, which serves as the main entry
      * point for the application. This route is often used to enable server-side rendering
      * of the application shell for requests that do not match any specific server route.
-     *
-     * @see {@link https://angular.dev/ecosystem/service-workers/app-shell | App shell pattern on Angular.dev}
      */
     appShellRoute?: string;
 }
@@ -891,6 +883,44 @@ export declare interface ServerRouteServer extends ServerRouteCommon {
     renderMode: RenderMode.Server;
 }
 
+/**
+ * Helper type to represent a server routes feature.
+ * @see {@link ServerRoutesFeatureKind}
+ * @developerPreview
+ */
+declare interface ServerRoutesFeature<FeatureKind extends ServerRoutesFeatureKind> {
+    ɵkind: FeatureKind;
+    ɵproviders: Provider[];
+}
+
+/**
+ * Identifies a particular kind of `ServerRoutesFeatureKind`.
+ * @see {@link ServerRoutesFeature}
+ * @developerPreview
+ */
+declare enum ServerRoutesFeatureKind {
+    AppShell = 0
+}
+
+/**
+ * Configures the app shell route with the provided component.
+ *
+ * The app shell serves as the main entry point for the application and is commonly used
+ * to enable server-side rendering (SSR) of the application shell. It handles requests
+ * that do not match any specific server route, providing a fallback mechanism and improving
+ * perceived performance during navigation.
+ *
+ * This configuration is particularly useful in applications leveraging Progressive Web App (PWA)
+ * patterns, such as service workers, to deliver a seamless user experience.
+ *
+ * @param component The Angular component to render for the app shell route.
+ * @returns A server routes feature configuration for the app shell.
+ *
+ * @see {@link provideServerRouting}
+ * @see {@link https://angular.dev/ecosystem/service-workers/app-shell | App shell pattern on Angular.dev}
+ */
+export declare function withAppShell(component: Type<unknown> | (() => Promise<Type<unknown> | DefaultExport<Type<unknown>>>)): ServerRoutesFeature<ServerRoutesFeatureKind.AppShell>;
+
 /**
  * Destroys the existing `AngularServerApp` instance, releasing associated resources and resetting the
  * reference to `undefined`.

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@angular/ssr",
-  "version": "19.1.4",
+  "version": "19.1.5",
   "description": "Angular server side rendering utilities",
+  "type": "module",
   "license": "MIT",
   "homepage": "https://github.com/angular/angular-cli",
   "keywords": [
@@ -43,7 +44,6 @@
   },
   "module": "./fesm2022/ssr.mjs",
   "typings": "./index.d.ts",
-  "type": "module",
   "exports": {
     "./package.json": {
       "default": "./package.json"