@angular/ssr 19.0.0-next.3 → 19.0.0-next.4

package/index.d.ts

@@ -2,6 +2,68 @@ import type { ApplicationRef } from '@angular/core';
 import { default as default_2 } from 'critters';
 import type { Type } from '@angular/core';
 
+/**
+ * Angular server application engine.
+ * Manages Angular server applications (including localized ones), handles rendering requests,
+ * and optionally transforms index HTML before rendering.
+ *
+ * @note This class should be instantiated once and used as a singleton across the server-side
+ * application to ensure consistent handling of rendering requests and resource management.
+ *
+ * @developerPreview
+ */
+export declare class AngularAppEngine {
+    /**
+     * Hooks for extending or modifying the behavior of the server application.
+     * These hooks are used by the Angular CLI when running the development server and
+     * provide extensibility points for the application lifecycle.
+     *
+     * @private
+     */
+    static ɵhooks: Hooks;
+    /**
+     * The manifest for the server application.
+     */
+    private readonly manifest;
+    /**
+     * Renders a response for the given HTTP request using the server application.
+     *
+     * This method processes the request, determines the appropriate route and rendering context,
+     * and returns an HTTP response.
+     *
+     * If the request URL appears to be for a file (excluding `/index.html`), the method returns `null`.
+     * A request to `https://www.example.com/page/index.html` will render the Angular route
+     * corresponding to `https://www.example.com/page`.
+     *
+     * @param request - The incoming HTTP request object to be rendered.
+     * @param requestContext - Optional additional context for the request, such as metadata.
+     * @returns A promise that resolves to a Response object, or `null` if the request URL represents a file (e.g., `./logo.png`)
+     * rather than an application route.
+     */
+    render(request: Request, requestContext?: unknown): Promise<Response | null>;
+    /**
+     * Retrieves the entry point path and locale for the Angular server application based on the provided URL.
+     *
+     * This method determines the appropriate entry point and locale for rendering the application by examining the URL.
+     * If there is only one entry point available, it is returned regardless of the URL.
+     * Otherwise, the method extracts a potential locale identifier from the URL and looks up the corresponding entry point.
+     *
+     * @param url - The URL used to derive the locale and determine the appropriate entry point.
+     * @returns A function that returns a promise resolving to an object with the `EntryPointExports` type,
+     * or `undefined` if no matching entry point is found for the extracted locale.
+     */
+    private getEntryPointFromUrl;
+    /**
+     * Retrieves HTTP headers for a request associated with statically generated (SSG) pages,
+     * based on the URL pathname.
+     *
+     * @param request - The incoming request object.
+     * @returns A `Map` containing the HTTP headers as key-value pairs.
+     * @note This function should be used exclusively for retrieving headers of SSG pages.
+     */
+    getHeaders(request: Request): Readonly<Map<string, string>>;
+}
+
 /**
  * Manifest for the Angular server application engine, defining entry points.
  */
@@ -18,6 +80,15 @@ declare interface AngularAppEngineManifest {
      * This is used to determine the root path of the application.
      */
     readonly basePath: string;
+    /**
+     * A map that associates static paths with their corresponding HTTP headers.
+     * Each entry in the map consists of:
+     * - `key`: The static path as a string.
+     * - `value`: An array of tuples, where each tuple contains:
+     *   - `headerName`: The name of the HTTP header.
+     *   - `headerValue`: The value of the HTTP header.
+     */
+    readonly staticPathsHeaders: Readonly<Map<string, readonly [headerName: string, headerValue: string][]>>;
 }
 
 /**
@@ -33,9 +104,10 @@ declare interface AngularAppManifest {
     readonly assets: Readonly<Map<string, () => Promise<string>>>;
     /**
      * The bootstrap mechanism for the server application.
-     * A function that returns a reference to an NgModule or a function returning a promise that resolves to an ApplicationRef.
+     * A function that returns a promise that resolves to an `NgModule` or a function
+     * returning a promise that resolves to an `ApplicationRef`.
      */
-    readonly bootstrap: () => AngularBootstrap;
+    readonly bootstrap: () => Promise<AngularBootstrap>;
     /**
      * Indicates whether critical CSS should be inlined into the HTML.
      * If set to `true`, critical CSS will be inlined for faster page rendering.
@@ -115,6 +187,10 @@ declare class AngularServerApp {
      * The `inlineCriticalCssProcessor` is responsible for handling critical CSS inlining.
      */
     private inlineCriticalCssProcessor;
+    /**
+     * The bootstrap mechanism for the server application.
+     */
+    private boostrap;
     /**
      * Renders a response for the given HTTP request using the server application.
      *
@@ -147,31 +223,6 @@ declare class AngularServerApp {
     private handleRendering;
 }
 
-/**
- * Angular server application engine.
- * Manages Angular server applications (including localized ones) and handles rendering requests.
-
- * @developerPreview
- */
-export declare interface AngularServerAppManager {
-    /**
-     * Renders a response for the given HTTP request using the server application.
-     *
-     * This method processes the request, determines the appropriate route and rendering context,
-     * and returns an HTTP response.
-     *
-     * If the request URL appears to be for a file (excluding `/index.html`), the method returns `null`.
-     * A request to `https://www.example.com/page/index.html` will render the Angular route
-     * corresponding to `https://www.example.com/page`.
-     *
-     * @param request - The incoming HTTP request object to be rendered.
-     * @param requestContext - Optional additional context for the request, such as metadata.
-     * @returns A promise that resolves to a Response object, or `null` if the request URL represents a file (e.g., `./logo.png`)
-     * rather than an application route.
-     */
-    render(request: Request, requestContext?: unknown): Promise<Response | null>;
-}
-
 declare interface CrittersBase {
     embedLinkedStylesheet(link: PartialHTMLElement, document: PartialDocument): Promise<unknown>;
 }
@@ -179,17 +230,6 @@ declare interface CrittersBase {
 declare class CrittersBase extends default_2 {
 }
 
-/**
- * Destroys the current `AngularAppEngine` instance, releasing any associated resources.
- *
- * This method resets the reference to the `AngularAppEngine` instance to `undefined`, allowing
- * a new instance to be created on the next call to `getOrCreateAngularAppEngine()`. It is typically
- * used when reinitializing the server environment or refreshing the application state is necessary.
- *
- * @developerPreview
- */
-export declare function destroyAngularAppEngine(): void;
-
 /**
  * Represents the exports of an Angular server application entry point.
  */
@@ -206,18 +246,6 @@ declare interface EntryPointExports {
     ɵdestroyAngularServerApp: () => void;
 }
 
-/**
- * Retrieves an existing `AngularAppEngine` instance or creates a new one if none exists.
- *
- * This method ensures that only a single instance of `AngularAppEngine` is created and reused across
- * the application lifecycle, providing efficient resource management. If the instance does not exist,
- * it will be instantiated upon the first call.
- *
- * @developerPreview
- * @returns The existing or newly created instance of `AngularAppEngine`.
- */
-export declare function getOrCreateAngularAppEngine(): AngularServerAppManager;
-
 /**
  * Defines the names of available hooks for registering and triggering custom logic within the application.
  */
@@ -463,54 +491,6 @@ declare type RouteTreeNodeMetadataWithoutRoute = Omit<RouteTreeNodeMetadata, 'ro
  */
 declare type SerializableRouteTreeNode = ReadonlyArray<RouteTreeNodeMetadata>;
 
-/**
- * Angular server application engine.
- * Manages Angular server applications (including localized ones), handles rendering requests,
- * and optionally transforms index HTML before rendering.
- */
-export declare class ɵAngularAppEngine implements AngularServerAppManager {
-    /**
-     * Hooks for extending or modifying the behavior of the server application.
-     * These hooks are used by the Angular CLI when running the development server and
-     * provide extensibility points for the application lifecycle.
-     *
-     * @private
-     */
-    static ɵhooks: Hooks;
-    /**
-     * The manifest for the server application.
-     */
-    private readonly manifest;
-    /**
-     * Renders a response for the given HTTP request using the server application.
-     *
-     * This method processes the request, determines the appropriate route and rendering context,
-     * and returns an HTTP response.
-     *
-     * If the request URL appears to be for a file (excluding `/index.html`), the method returns `null`.
-     * A request to `https://www.example.com/page/index.html` will render the Angular route
-     * corresponding to `https://www.example.com/page`.
-     *
-     * @param request - The incoming HTTP request object to be rendered.
-     * @param requestContext - Optional additional context for the request, such as metadata.
-     * @returns A promise that resolves to a Response object, or `null` if the request URL represents a file (e.g., `./logo.png`)
-     * rather than an application route.
-     */
-    render(request: Request, requestContext?: unknown): Promise<Response | null>;
-    /**
-     * Retrieves the entry point path and locale for the Angular server application based on the provided URL.
-     *
-     * This method determines the appropriate entry point and locale for rendering the application by examining the URL.
-     * If there is only one entry point available, it is returned regardless of the URL.
-     * Otherwise, the method extracts a potential locale identifier from the URL and looks up the corresponding entry point.
-     *
-     * @param url - The URL used to derive the locale and determine the appropriate entry point.
-     * @returns A function that returns a promise resolving to an object with the `EntryPointExports` type,
-     * or `undefined` if no matching entry point is found for the extracted locale.
-     */
-    private getEntryPointFromUrl;
-}
-
 /**
  * Destroys the existing `AngularServerApp` instance, releasing associated resources and resetting the
  * reference to `undefined`.

package/node/index.d.ts

@@ -4,6 +4,61 @@ import type { ServerResponse } from 'node:http';
 import { StaticProvider } from '@angular/core';
 import { Type } from '@angular/core';
 
+/**
+ * Angular server application engine.
+ * Manages Angular server applications (including localized ones), handles rendering requests,
+ * and optionally transforms index HTML before rendering.
+ *
+ * @note This class should be instantiated once and used as a singleton across the server-side
+ * application to ensure consistent handling of rendering requests and resource management.
+ *
+ * @developerPreview
+ */
+export declare class AngularNodeAppEngine {
+    private readonly angularAppEngine;
+    /**
+     * Renders an HTTP response based on the incoming request using the Angular server application.
+     *
+     * The method processes the incoming request, determines the appropriate route, and prepares the
+     * rendering context to generate a response. If the request URL corresponds to a static file (excluding `/index.html`),
+     * the method returns `null`.
+     *
+     * Example: A request to `https://www.example.com/page/index.html` will render the Angular route
+     * associated with `https://www.example.com/page`.
+     *
+     * @param request - The incoming HTTP request object to be rendered.
+     * @param requestContext - Optional additional context for the request, such as metadata or custom settings.
+     * @returns A promise that resolves to a `Response` object, or `null` if the request URL is for a static file
+     * (e.g., `./logo.png`) rather than an application route.
+     */
+    render(request: IncomingMessage, requestContext?: unknown): Promise<Response | null>;
+    /**
+     * Retrieves HTTP headers for a request associated with statically generated (SSG) pages,
+     * based on the URL pathname.
+     *
+     * @param request - The incoming request object.
+     * @returns A `Map` containing the HTTP headers as key-value pairs.
+     * @note This function should be used exclusively for retrieving headers of SSG pages.
+     * @example
+     * ```typescript
+     * const angularAppEngine = new AngularNodeAppEngine();
+     *
+     * app.use(express.static('dist/browser', {
+     *   setHeaders: (res, path) => {
+     *     // Retrieve headers for the current request
+     *     const headers = angularAppEngine.getHeaders(res.req);
+     *
+     *     // Apply the retrieved headers to the response
+     *     for (const { key, value } of headers) {
+     *       res.setHeader(key, value);
+     *     }
+     *   }
+     }));
+     * ```
+     */
+    getHeaders(request: IncomingMessage): Readonly<Map<string, string>>;
+}
+
 /**
  * A common engine to use to server render an application.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular/ssr",
-  "version": "19.0.0-next.3",
+  "version": "19.0.0-next.4",
   "description": "Angular server side rendering utilities",
   "license": "MIT",
   "homepage": "https://github.com/angular/angular-cli",

package/third_party/critters/THIRD_PARTY_LICENSES.txt

@@ -3,15 +3,7 @@
 Package: ansi-styles
 License: "MIT"
 
-MIT License
-
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 --------------------------------------------------------------------------------
 Package: boolbase
 License: "ISC"
@@ -21,15 +13,7 @@ License: "ISC"
 Package: chalk
 License: "MIT"
 
-MIT License
-
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 --------------------------------------------------------------------------------
 Package: color-convert
 License: "MIT"
@@ -337,15 +321,7 @@ License: "MIT"
 Package: supports-color
 License: "MIT"
 
-MIT License
-
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 --------------------------------------------------------------------------------
 Package: unenv
 License: "MIT"