@angular-devkit/build-angular 17.1.0-next.3 → 17.1.0-rc.0

package/src/builders/web-test-runner/schema.d.ts

@@ -0,0 +1,188 @@
+/**
+ * Web Test Runner target options for Build Facade.
+ */
+export interface Schema {
+    /**
+     * List of static application assets.
+     */
+    assets?: AssetPattern[];
+    /**
+     * Override which browsers tests are run against.
+     */
+    browsers?: string;
+    /**
+     * Output a code coverage report.
+     */
+    codeCoverage?: boolean;
+    /**
+     * Globs to exclude from code coverage.
+     */
+    codeCoverageExclude?: string[];
+    /**
+     * Globs of files to exclude, relative to the project root.
+     */
+    exclude?: string[];
+    /**
+     * Replace compilation source files with other compilation source files in the build.
+     */
+    fileReplacements?: FileReplacement[];
+    /**
+     * Globs of files to include, relative to project root.
+     * There are 2 special cases:
+     * - when a path to directory is provided, all spec files ending ".spec.@(ts|tsx)" will be
+     * included
+     * - when a path to a file is provided, and a matching spec file exists it will be included
+     * instead.
+     */
+    include?: string[];
+    /**
+     * The stylesheet language to use for the application's inline component styles.
+     */
+    inlineStyleLanguage?: InlineStyleLanguage;
+    /**
+     * The name of the main entry-point file.
+     */
+    main?: string;
+    /**
+     * Enable and define the file watching poll time period in milliseconds.
+     */
+    poll?: number;
+    /**
+     * Polyfills to be included in the build.
+     */
+    polyfills?: Polyfills;
+    /**
+     * Do not use the real path when resolving modules. If unset then will default to `true` if
+     * NodeJS option --preserve-symlinks is set.
+     */
+    preserveSymlinks?: boolean;
+    /**
+     * Log progress to the console while building.
+     */
+    progress?: boolean;
+    /**
+     * Global scripts to be included in the build.
+     */
+    scripts?: ScriptElement[];
+    /**
+     * Output source maps for scripts and styles. For more information, see
+     * https://angular.io/guide/workspace-config#source-map-configuration.
+     */
+    sourceMap?: SourceMapUnion;
+    /**
+     * Options to pass to style preprocessors
+     */
+    stylePreprocessorOptions?: StylePreprocessorOptions;
+    /**
+     * Global styles to be included in the build.
+     */
+    styles?: StyleElement[];
+    /**
+     * The name of the TypeScript configuration file.
+     */
+    tsConfig: string;
+    /**
+     * Run build when files change.
+     */
+    watch?: boolean;
+    /**
+     * TypeScript configuration for Web Worker modules.
+     */
+    webWorkerTsConfig?: string;
+}
+export type AssetPattern = AssetPatternClass | string;
+export interface AssetPatternClass {
+    /**
+     * The pattern to match.
+     */
+    glob: string;
+    /**
+     * An array of globs to ignore.
+     */
+    ignore?: string[];
+    /**
+     * The input directory path in which to apply 'glob'. Defaults to the project root.
+     */
+    input: string;
+    /**
+     * Absolute path within the output.
+     */
+    output: string;
+}
+export interface FileReplacement {
+    replace?: string;
+    replaceWith?: string;
+    src?: string;
+    with?: string;
+}
+/**
+ * The stylesheet language to use for the application's inline component styles.
+ */
+export declare enum InlineStyleLanguage {
+    Css = "css",
+    Less = "less",
+    Sass = "sass",
+    Scss = "scss"
+}
+/**
+ * Polyfills to be included in the build.
+ */
+export type Polyfills = string[] | string;
+export type ScriptElement = ScriptClass | string;
+export interface ScriptClass {
+    /**
+     * The bundle name for this extra entry point.
+     */
+    bundleName?: string;
+    /**
+     * If the bundle will be referenced in the HTML file.
+     */
+    inject?: boolean;
+    /**
+     * The file to include.
+     */
+    input: string;
+}
+/**
+ * Output source maps for scripts and styles. For more information, see
+ * https://angular.io/guide/workspace-config#source-map-configuration.
+ */
+export type SourceMapUnion = boolean | SourceMapClass;
+export interface SourceMapClass {
+    /**
+     * Output source maps for all scripts.
+     */
+    scripts?: boolean;
+    /**
+     * Output source maps for all styles.
+     */
+    styles?: boolean;
+    /**
+     * Resolve vendor packages source maps.
+     */
+    vendor?: boolean;
+}
+/**
+ * Options to pass to style preprocessors
+ */
+export interface StylePreprocessorOptions {
+    /**
+     * Paths to include. Paths will be resolved to workspace root.
+     */
+    includePaths?: string[];
+}
+export type StyleElement = StyleClass | string;
+export interface StyleClass {
+    /**
+     * The bundle name for this extra entry point.
+     */
+    bundleName?: string;
+    /**
+     * If the bundle will be referenced in the HTML file.
+     */
+    inject?: boolean;
+    /**
+     * The file to include.
+     */
+    input: string;
+}

package/src/builders/web-test-runner/schema.js

@@ -0,0 +1,15 @@
+"use strict";
+// THIS FILE IS AUTOMATICALLY GENERATED. TO UPDATE THIS FILE YOU NEED TO CHANGE THE
+// CORRESPONDING JSON SCHEMA FILE, THEN RUN devkit-admin build (or bazel build ...).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InlineStyleLanguage = void 0;
+/**
+ * The stylesheet language to use for the application's inline component styles.
+ */
+var InlineStyleLanguage;
+(function (InlineStyleLanguage) {
+    InlineStyleLanguage["Css"] = "css";
+    InlineStyleLanguage["Less"] = "less";
+    InlineStyleLanguage["Sass"] = "sass";
+    InlineStyleLanguage["Scss"] = "scss";
+})(InlineStyleLanguage || (exports.InlineStyleLanguage = InlineStyleLanguage = {}));

package/src/builders/web-test-runner/schema.json

@@ -0,0 +1,291 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "Web Test Runner Target",
+  "description": "Web Test Runner target options for Build Facade.",
+  "type": "object",
+  "properties": {
+    "main": {
+      "type": "string",
+      "description": "The name of the main entry-point file."
+    },
+    "tsConfig": {
+      "type": "string",
+      "description": "The name of the TypeScript configuration file."
+    },
+    "polyfills": {
+      "description": "Polyfills to be included in the build.",
+      "oneOf": [
+        {
+          "type": "array",
+          "description": "A list of polyfills to include in the build. Can be a full path for a file, relative to the current workspace or module specifier. Example: 'zone.js'.",
+          "items": {
+            "type": "string",
+            "uniqueItems": true
+          },
+          "default": []
+        },
+        {
+          "type": "string",
+          "description": "The full path for the polyfills file, relative to the current workspace or a module specifier. Example: 'zone.js'."
+        }
+      ]
+    },
+    "assets": {
+      "type": "array",
+      "description": "List of static application assets.",
+      "default": [],
+      "items": {
+        "$ref": "#/definitions/assetPattern"
+      }
+    },
+    "scripts": {
+      "description": "Global scripts to be included in the build.",
+      "type": "array",
+      "default": [],
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "input": {
+                "type": "string",
+                "description": "The file to include.",
+                "pattern": "\\.[cm]?jsx?$"
+              },
+              "bundleName": {
+                "type": "string",
+                "pattern": "^[\\w\\-.]*$",
+                "description": "The bundle name for this extra entry point."
+              },
+              "inject": {
+                "type": "boolean",
+                "description": "If the bundle will be referenced in the HTML file.",
+                "default": true
+              }
+            },
+            "additionalProperties": false,
+            "required": ["input"]
+          },
+          {
+            "type": "string",
+            "description": "The file to include.",
+            "pattern": "\\.[cm]?jsx?$"
+          }
+        ]
+      }
+    },
+    "styles": {
+      "description": "Global styles to be included in the build.",
+      "type": "array",
+      "default": [],
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "input": {
+                "type": "string",
+                "description": "The file to include.",
+                "pattern": "\\.(?:css|scss|sass|less)$"
+              },
+              "bundleName": {
+                "type": "string",
+                "pattern": "^[\\w\\-.]*$",
+                "description": "The bundle name for this extra entry point."
+              },
+              "inject": {
+                "type": "boolean",
+                "description": "If the bundle will be referenced in the HTML file.",
+                "default": true
+              }
+            },
+            "additionalProperties": false,
+            "required": ["input"]
+          },
+          {
+            "type": "string",
+            "description": "The file to include.",
+            "pattern": "\\.(?:css|scss|sass|less)$"
+          }
+        ]
+      }
+    },
+    "inlineStyleLanguage": {
+      "description": "The stylesheet language to use for the application's inline component styles.",
+      "type": "string",
+      "default": "css",
+      "enum": ["css", "less", "sass", "scss"]
+    },
+    "stylePreprocessorOptions": {
+      "description": "Options to pass to style preprocessors",
+      "type": "object",
+      "properties": {
+        "includePaths": {
+          "description": "Paths to include. Paths will be resolved to workspace root.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": []
+        }
+      },
+      "additionalProperties": false
+    },
+    "include": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": ["**/*.spec.ts"],
+      "description": "Globs of files to include, relative to project root. \nThere are 2 special cases:\n - when a path to directory is provided, all spec files ending \".spec.@(ts|tsx)\" will be included\n - when a path to a file is provided, and a matching spec file exists it will be included instead."
+    },
+    "exclude": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": [],
+      "description": "Globs of files to exclude, relative to the project root."
+    },
+    "sourceMap": {
+      "description": "Output source maps for scripts and styles. For more information, see https://angular.io/guide/workspace-config#source-map-configuration.",
+      "default": true,
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "scripts": {
+              "type": "boolean",
+              "description": "Output source maps for all scripts.",
+              "default": true
+            },
+            "styles": {
+              "type": "boolean",
+              "description": "Output source maps for all styles.",
+              "default": true
+            },
+            "vendor": {
+              "type": "boolean",
+              "description": "Resolve vendor packages source maps.",
+              "default": false
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "boolean"
+        }
+      ]
+    },
+    "progress": {
+      "type": "boolean",
+      "description": "Log progress to the console while building.",
+      "default": true
+    },
+    "watch": {
+      "type": "boolean",
+      "description": "Run build when files change."
+    },
+    "poll": {
+      "type": "number",
+      "description": "Enable and define the file watching poll time period in milliseconds."
+    },
+    "preserveSymlinks": {
+      "type": "boolean",
+      "description": "Do not use the real path when resolving modules. If unset then will default to `true` if NodeJS option --preserve-symlinks is set."
+    },
+    "browsers": {
+      "type": "string",
+      "description": "Override which browsers tests are run against."
+    },
+    "codeCoverage": {
+      "type": "boolean",
+      "description": "Output a code coverage report.",
+      "default": false
+    },
+    "codeCoverageExclude": {
+      "type": "array",
+      "description": "Globs to exclude from code coverage.",
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "fileReplacements": {
+      "description": "Replace compilation source files with other compilation source files in the build.",
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "src": {
+                "type": "string"
+              },
+              "replaceWith": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": false,
+            "required": ["src", "replaceWith"]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "replace": {
+                "type": "string"
+              },
+              "with": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": false,
+            "required": ["replace", "with"]
+          }
+        ]
+      },
+      "default": []
+    },
+    "webWorkerTsConfig": {
+      "type": "string",
+      "description": "TypeScript configuration for Web Worker modules."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["tsConfig"],
+  "definitions": {
+    "assetPattern": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "glob": {
+              "type": "string",
+              "description": "The pattern to match."
+            },
+            "input": {
+              "type": "string",
+              "description": "The input directory path in which to apply 'glob'. Defaults to the project root."
+            },
+            "output": {
+              "type": "string",
+              "description": "Absolute path within the output."
+            },
+            "ignore": {
+              "description": "An array of globs to ignore.",
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false,
+          "required": ["glob", "input", "output"]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    }
+  }
+}

package/src/builders/web-test-runner/test_page.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf8">
+    <title>Unit tests</title>
+
+    <script type="module">
+      (async () => {
+        // To initialize tests correctly we load things in a very particular order.
+
+        // Step 1. Load user polyfills (including `zone.js`). Does *not* include `zone.js/testing`, which gets executed after Jasmine.
+        await import('./polyfills.js');
+
+        // Step 2. Import Jasmine.
+        // Jasmine gets wrapped into a CommonJS context by the bundling process which makes it think it is running in NodeJS, so it does not
+        // find the `window` global. Assign this to the NodeJS `global` symbol so Jasmine initializes correctly.
+        window.global = window;
+        const { default: jasmineRequire } = await import('./jasmine.js');
+        delete window.global; // Avoid leaking `global` into user tests or libraries, which might think they are running in NodeJS.
+
+        // Step 3. Initialize Jasmine on the page. Doing this after `zone.js` means Zone can patch browser globals before Jasmine runs.
+        // Doing this before `zone.js/testing`, means Zone can patch Jasmine-defined globals.
+        const jasmine = jasmineRequire.core(jasmineRequire);
+        const jasmineGlobal = jasmine.getGlobal();
+        jasmineGlobal.jasmine = jasmine;
+        const jasmineEnv = jasmine.getEnv();
+        Object.assign(window, jasmineRequire.interface(jasmine, jasmineEnv));
+
+        // Step 4. Import `zone.js/testing`, which will find and patch Jasmine globals from steps 2. and 3.
+        // https://github.com/angular/angular/blob/af4f5df150d527a1b523def1eb51d2b661a25f83/packages/zone.js/lib/jasmine/jasmine.ts
+        await import('./testing.js');
+
+        // Step 5. Run the actual tests.
+        const { runJasmineTests } = await import('./jasmine_runner.js');
+        await runJasmineTests(jasmineEnv);
+      })();
+    </script>
+  </head>
+  <body></body>
+</html>

package/src/tools/esbuild/angular/component-stylesheets.js

@@ -14,17 +14,8 @@ exports.ComponentStylesheetBundler = void 0;
 const node_crypto_1 = require("node:crypto");
 const node_path_1 = __importDefault(require("node:path"));
 const bundler_context_1 = require("../bundler-context");
+const cache_1 = require("../cache");
 const bundle_options_1 = require("../stylesheets/bundle-options");
-class BundlerContextCache extends Map {
-    getOrCreate(key, creator) {
-        let value = this.get(key);
-        if (value === undefined) {
-            value = creator();
-            this.set(key, value);
-        }
-        return value;
-    }
-}
 /**
  * Bundles component stylesheets. A stylesheet can be either an inline stylesheet that
  * is contained within the Component's metadata definition or an external file referenced
@@ -33,8 +24,8 @@ class BundlerContextCache extends Map {
 class ComponentStylesheetBundler {
     options;
     incremental;
-    #fileContexts = new BundlerContextCache();
-    #inlineContexts = new BundlerContextCache();
+    #fileContexts = new cache_1.MemoryCache();
+    #inlineContexts = new cache_1.MemoryCache();
     /**
      *
      * @param options An object containing the stylesheet bundling options.
@@ -45,7 +36,7 @@ class ComponentStylesheetBundler {
         this.incremental = incremental;
     }
     async bundleFile(entry) {
-        const bundlerContext = this.#fileContexts.getOrCreate(entry, () => {
+        const bundlerContext = await this.#fileContexts.getOrCreate(entry, () => {
             return new bundler_context_1.BundlerContext(this.options.workspaceRoot, this.incremental, (loadCache) => {
                 const buildOptions = (0, bundle_options_1.createStylesheetBundleOptions)(this.options, loadCache);
                 buildOptions.entryPoints = [entry];
@@ -60,7 +51,7 @@ class ComponentStylesheetBundler {
         // TODO: Consider xxhash instead for hashing
         const id = (0, node_crypto_1.createHash)('sha256').update(data).digest('hex');
         const entry = [language, id, filename].join(';');
-        const bundlerContext = this.#inlineContexts.getOrCreate(entry, () => {
+        const bundlerContext = await this.#inlineContexts.getOrCreate(entry, () => {
             const namespace = 'angular:styles/component';
             return new bundler_context_1.BundlerContext(this.options.workspaceRoot, this.incremental, (loadCache) => {
                 const buildOptions = (0, bundle_options_1.createStylesheetBundleOptions)(this.options, loadCache, {

package/src/tools/esbuild/cache.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+/**
+ * @fileoverview
+ * Provides infrastructure for common caching functionality within the build system.
+ */
+/**
+ * A backing data store for one or more Cache instances.
+ * The interface is intentionally designed to support using a JavaScript
+ * Map instance as a potential cache store.
+ */
+export interface CacheStore<V> {
+    /**
+     * Returns the specified value from the cache store or `undefined` if not found.
+     * @param key The key to retrieve from the store.
+     */
+    get(key: string): V | undefined | Promise<V | undefined>;
+    /**
+     * Returns whether the provided key is present in the cache store.
+     * @param key The key to check from the store.
+     */
+    has(key: string): boolean | Promise<boolean>;
+    /**
+     * Adds a new value to the cache store if the key is not present.
+     * Updates the value for the key if already present.
+     * @param key The key to associate with the value in the cache store.
+     * @param value The value to add to the cache store.
+     */
+    set(key: string, value: V): this | Promise<this>;
+}
+/**
+ * A cache object that allows accessing and storing key/value pairs in
+ * an underlying CacheStore. This class is the primary method for consumers
+ * to use a cache.
+ */
+export declare class Cache<V, S extends CacheStore<V> = CacheStore<V>> {
+    protected readonly store: S;
+    readonly namespace?: string | undefined;
+    constructor(store: S, namespace?: string | undefined);
+    /**
+     * Prefixes a key with the cache namespace if present.
+     * @param key A key string to prefix.
+     * @returns A prefixed key if a namespace is present. Otherwise the provided key.
+     */
+    protected withNamespace(key: string): string;
+    /**
+     * Gets the value associated with a provided key if available.
+     * Otherwise, creates a value using the factory creator function, puts the value
+     * in the cache, and returns the new value.
+     * @param key A key associated with the value.
+     * @param creator A factory function for the value if no value is present.
+     * @returns A value associated with the provided key.
+     */
+    getOrCreate(key: string, creator: () => V | Promise<V>): Promise<V>;
+    /**
+     * Gets the value associated with a provided key if available.
+     * @param key A key associated with the value.
+     * @returns A value associated with the provided key if present. Otherwise, `undefined`.
+     */
+    get(key: string): Promise<V | undefined>;
+    /**
+     * Puts a value in the cache and associates it with the provided key.
+     * If the key is already present, the value is updated instead.
+     * @param key A key associated with the value.
+     * @param value A value to put in the cache.
+     */
+    put(key: string, value: V): Promise<void>;
+}
+/**
+ * A lightweight in-memory cache implementation based on a JavaScript Map object.
+ */
+export declare class MemoryCache<V> extends Cache<V, Map<string, V>> {
+    constructor();
+    /**
+     * Removes all entries from the cache instance.
+     */
+    clear(): void;
+    /**
+     * Provides all the values currently present in the cache instance.
+     * @returns An iterable of all values in the cache.
+     */
+    values(): IterableIterator<V>;
+}