@blotch/rsbuild-plugin-angular-lynx 22.2.0 → 22.2.2

package/dist/utils/angular/budgets.d.ts

@@ -0,0 +1,72 @@
+import type { Budget } from './options.js';
+/**
+ * Checks angular.json `budgets` against a Lynx build's output.
+ *
+ * The size parsing, the thresholds and the messages are ported from
+ * `@angular/build`'s bundle calculator (`src/utils/bundle-calculator.js` and
+ * `src/utils/format-bytes.js`), so a Lynx app reports budgets exactly as
+ * `ng build` does for a web app: the same units (1 kB = 1000 bytes), the
+ * same baseline arithmetic and the same wording. It's copied because those
+ * modules are internal to `@angular/build`, not in its package `exports`.
+ *
+ * What each budget type measures differs from the web, because a Lynx app
+ * ships as `.bundle` files rather than separate scripts and stylesheets:
+ *
+ * - `initial`: each entry's bundle, on its own. A Lynx page loads one bundle,
+ *   so a multi-page app's pages are checked separately rather than summed.
+ * - `bundle`: the bundle of the entry named by the budget's `name`.
+ * - `all` / `any`: every bundle and script the `lynx` environment emits,
+ *   together / each. Media and fonts aren't counted, as on the web.
+ * - `allScript` / `anyScript`: the same files as `all` / `any`. A Lynx
+ *   bundle carries the app's scripts (and its styles, encoded together), so
+ *   there is no script-only file to measure.
+ * - `anyComponentStyle`: each component stylesheet, compiled.
+ */
+/** Angular's unit for `kB`, `MB` and `GB`: decimal, not 1024. */
+export declare const BYTES_IN_KILOBYTE = 1000;
+export type BudgetSeverity = 'warning' | 'error';
+export type BudgetThreshold = {
+    readonly limit: number;
+    readonly type: 'maximum' | 'minimum';
+    readonly severity: BudgetSeverity;
+};
+export type BudgetFailure = {
+    readonly severity: BudgetSeverity;
+    readonly label: string;
+    readonly message: string;
+};
+/** A file the `lynx` environment emits that budgets count. */
+export type BudgetAsset = {
+    readonly name: string;
+    readonly size: number;
+    /** Set for an entry's own bundle: the entry (page) it was built from. */
+    readonly entryName?: string;
+};
+/** The compiled size of one component stylesheet. */
+export type ComponentStyleSize = {
+    /** The stylesheet, or for inline styles the component, relative to the workspace. */
+    readonly label: string;
+    readonly size: number;
+};
+/**
+ * Parses a budget size (`'500kB'`, `'1.5mb'`, `'2048'`, `'10%'`) into bytes.
+ * A percentage is of `baseline`; with a baseline, the result is the baseline
+ * moved by the value, up (`factor` 1) or down (`factor` -1). Input it
+ * can't parse gives NaN, which no size crosses, as in Angular.
+ */
+export declare const calculateBytes: (input: string, baseline?: string, factor?: 1 | -1) => number;
+/**
+ * The limits a budget sets, in the order Angular checks them. `warning` and
+ * `error` are relative to the baseline in both directions, so each gives a
+ * minimum and a maximum.
+ */
+export declare const calculateThresholds: (budget: Budget) => BudgetThreshold[];
+/** Formats a byte count the way `ng build`'s budget messages do: `1.23 kB`. */
+export declare const formatSize: (size: number) => string;
+/** The failures of one measured size against a budget's thresholds. */
+export declare const checkThresholds: (thresholds: readonly BudgetThreshold[], size: number, label: string) => BudgetFailure[];
+/** Checks every budget against a build's output. */
+export declare const checkBudgets: (budgets: readonly Budget[], output: {
+    readonly assets: readonly BudgetAsset[];
+    readonly componentStyles: readonly ComponentStyleSize[];
+}) => BudgetFailure[];

package/dist/utils/angular/budgets.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/angular/build-internals.d.ts

@@ -0,0 +1,14 @@
+import type * as AngularCompilationModule from '@angular/build/src/tools/angular/compilation';
+import type * as ComponentStylesheetsModule from '@angular/build/src/tools/esbuild/angular/component-stylesheets';
+import type * as JavaScriptTransformerModule from '@angular/build/src/tools/javascript-transformer';
+/** Absolute path of the installed `@angular/build` package root. */
+export declare const angularBuildRoot: string;
+/**
+ * Loads a module from inside `@angular/build` by its path relative to the
+ * package root, bypassing the `exports` map.
+ */
+export declare const loadAngularBuildInternal: <T>(subpath: string) => T;
+export declare const createAngularCompilation: typeof AngularCompilationModule.createAngularCompilation, DiagnosticModes: typeof AngularCompilationModule.DiagnosticModes;
+export declare const JavaScriptTransformer: typeof JavaScriptTransformerModule.JavaScriptTransformer;
+export declare const ComponentStylesheetBundler: typeof ComponentStylesheetsModule.ComponentStylesheetBundler;
+export type ComponentStylesheetBundler = ComponentStylesheetsModule.ComponentStylesheetBundler;

package/dist/utils/angular/component-style-bundler.d.ts

@@ -1,4 +1,4 @@
-import { ComponentStylesheetBundler } from '@angular/build/src/tools/esbuild/angular/component-stylesheets';
+import { ComponentStylesheetBundler } from './build-internals.js';
 import type { NormalizedOptions } from './options.js';
 /**
  * Creates an Angular `ComponentStylesheetBundler` configured for the current workspace.

package/dist/utils/angular/options.d.ts

@@ -1,4 +1,3 @@
-import type { OutputHashing } from '@angular-devkit/build-angular';
 import type { workspaces } from '@angular-devkit/core';
 import type { TargetDefinition } from '@angular-devkit/core/src/workspace/definitions';
 import { type NormalizedCachedOptions } from './normalize-cache.js';
@@ -40,6 +39,53 @@ export type NormalizedI18nOptions = {
     sourceLocale: string;
     hasDefinedSourceLocale: boolean;
 };
+/**
+ * The values of angular.json's `outputHashing` build option: which emitted
+ * file names get a content hash.
+ *
+ * Copied from the `OutputHashing` enum that Angular's builder schemas
+ * generate, as a string union because angular.json holds plain strings.
+ * Keep it in step with them when Angular adds a value.
+ *
+ * It used to be imported from `@angular-devkit/build-angular`, which made
+ * that package a peer dependency of this plugin. That package is Angular's
+ * legacy webpack-based builder: apps from a current `ng new` don't have it,
+ * and npm installs missing peer dependencies, so every AngularLynx app got it
+ * and its webpack toolchain (about 300 packages) for this one type.
+ *
+ * @see `OutputHashing` in `@angular/build/src/builders/application/schema.d.ts`
+ * @see `OutputHashing` in `@angular-devkit/build-angular/src/builders/browser/schema.d.ts`
+ */
+export type OutputHashing = 'all' | 'bundles' | 'media' | 'none';
+/**
+ * One entry of angular.json's `budgets` build option: a size limit on part
+ * of the build output, which `ng build` reports as a warning or an error
+ * when the output crosses it. See budgets.ts for what each `type` measures
+ * in a Lynx build.
+ *
+ * Copied from the `Budget` type (and its `Type` enum, as a string union) that
+ * Angular's application builder schema generates, for the same reason as
+ * {@link OutputHashing}: importing it would make an Angular builder package a
+ * dependency of this plugin for one type. Keep it in step with Angular's
+ * schema when Angular adds a field or a budget type.
+ *
+ * @see `Budget` in `@angular/build/src/builders/application/schema.d.ts`
+ */
+export type Budget = {
+    readonly type: 'all' | 'allScript' | 'any' | 'anyComponentStyle' | 'anyScript' | 'bundle' | 'initial';
+    /** The bundle a `bundle` budget measures: an entry name. */
+    readonly name?: string;
+    /** The size that the relative thresholds below are relative to. */
+    readonly baseline?: string;
+    readonly maximumWarning?: string;
+    readonly maximumError?: string;
+    readonly minimumWarning?: string;
+    readonly minimumError?: string;
+    /** A threshold in both directions from `baseline`. */
+    readonly warning?: string;
+    /** A threshold in both directions from `baseline`. */
+    readonly error?: string;
+};
 export type NormalizedOptions = {
     tsconfig: string;
     aot: boolean;
@@ -56,7 +102,7 @@ export type NormalizedOptions = {
     };
     fileReplacements: Record<string, string> | undefined;
     polyfills?: string[];
-    index: string;
+    index: string | undefined;
     browser: string;
     advancedOptimizations: boolean;
     outputPath: string | undefined;
@@ -71,9 +117,41 @@ export type NormalizedOptions = {
     styles: string[];
     i18n: NormalizedI18nOptions;
     i18nMissingTranslation: 'error' | 'warning' | 'ignore';
+    budgets: readonly Budget[];
 };
 export declare const readTarget: (project: workspaces.ProjectDefinition, target?: string) => TargetDefinition | undefined;
+/**
+ * Resolves angular.json's `index` option to an absolute path the way
+ * `@angular/build`'s application builder does. Projects from recent `ng new`
+ * omit it and rely on the builder's default of `<sourceRoot>/index.html`, so
+ * assuming a string here crashed on every freshly generated app. It may also be
+ * an `{ input, output }` object, or a boolean to build without an index page.
+ */
+export declare const resolveIndexPath: (index: unknown, project: workspaces.ProjectDefinition, workspaceRoot: string) => string | undefined;
+/**
+ * Resolves angular.json's `outputPath`, which may be a string or a
+ * `{ base, browser, ... }` object. Recent `ng new` omits it; returning
+ * `undefined` then keeps rspeedy's own `dist` directory (see
+ * `applyAngularConfig`) rather than crashing on `path.join(root, undefined)`.
+ */
+export declare const resolveOutputPath: (outputPath: unknown, workspaceRoot: string) => string | undefined;
+/**
+ * Reads the build target's options from angular.json, merged the way Angular
+ * CLI merges them: the selected configuration's keys (by default the
+ * target's `defaultConfiguration`) over the base options, leaving the keys it
+ * doesn't mention at their base values.
+ *
+ * Only for plain rspeedy runs. Under `ng build` / `ng serve`, Angular CLI has
+ * already merged them, `-c` and command-line overrides included, and the
+ * builders pass them in (see angular-cli-context.ts).
+ */
+export declare const readBuildTargetOptions: (project: workspaces.ProjectDefinition, configurationName?: string) => Record<string, unknown>;
 export declare const readBuildOptions: (project: workspaces.ProjectDefinition, basePath: string, configurationName?: string) => Promise<NormalizedOptions>;
+/**
+ * Turns a build target's options into the shape the compile pipeline uses:
+ * absolute paths, and the expanded forms of Angular's shorthand options.
+ */
+export declare const normalizeBuildOptions: (buildOptions: Readonly<Record<string, unknown>>, project: workspaces.ProjectDefinition, basePath: string) => Promise<NormalizedOptions>;
 /**
  * Normalizes the `i18n` section from angular.json's project definition.
  * Angular supports `sourceLocale` as either a string ('en-US') or an object

package/dist/utils/angular/read-workspace.d.ts

@@ -3,5 +3,9 @@ export type AngularWorkspace = {
     workspace: workspaces.WorkspaceDefinition;
     basePath: string;
 };
-export declare const getAngularWorkspace: () => Promise<AngularWorkspace>;
+/**
+ * Reads the angular.json found by searching up from `from`: the workspace
+ * root Angular CLI passed in, or the working directory under plain rspeedy.
+ */
+export declare const getAngularWorkspace: (from?: string) => Promise<AngularWorkspace>;
 export declare const getProjectByCwd: (workspace: workspaces.WorkspaceDefinition, basePath: string) => string | null;

package/dist/utils/angular/resolve-primary-build.d.ts

@@ -0,0 +1,26 @@
+import type { workspaces } from '@angular-devkit/core';
+import type { AngularCliContext } from '../../angular-cli-context.js';
+import { type NormalizedOptions } from './options.js';
+/**
+ * Picks the project whose build target configures the compile (tsconfig,
+ * polyfills, global styles, output path), and normalizes its options.
+ *
+ * The project is the one Angular CLI is building, when there is one: one of
+ * the `pages` if the plugin builds several, otherwise any. Without Angular
+ * CLI it is the first of the `pages`, or the project the working directory
+ * is in.
+ *
+ * The options are the ones Angular CLI resolved for that project (with `-c`
+ * and command-line overrides applied) when it is the one being built, and
+ * otherwise the target's options in angular.json under its default
+ * configuration.
+ */
+export declare const resolvePrimaryBuild: ({ workspace, basePath, pages, cli, }: {
+    workspace: workspaces.WorkspaceDefinition;
+    basePath: string;
+    pages: string[] | "all" | undefined;
+    cli: AngularCliContext | undefined;
+}) => Promise<{
+    projectName: string;
+    buildOptions: NormalizedOptions;
+}>;

package/dist/utils/angular/resolve-primary-build.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotch/rsbuild-plugin-angular-lynx",
-  "version": "22.2.0",
+  "version": "22.2.2",
   "description": "Rsbuild plugin for building AngularLynx applications",
   "homepage": "https://github.com/Blotch-Smart-Frames/AngularLynx#readme",
   "bugs": {
@@ -13,8 +13,7 @@
     "directory": "packages/rsbuild-plugin-angular-lynx"
   },
   "files": [
-    "dist",
-    "patch"
+    "dist"
   ],
   "type": "module",
   "module": "./dist/index.js",
@@ -23,7 +22,8 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
     "build": "rslib build",
@@ -37,7 +37,6 @@
     "format": "oxfmt --write .",
     "format:check": "oxfmt --check .",
     "cspell": "cspell .",
-    "postinstall": "node ./patch/patch-angular-build.cjs",
     "publish:local": "yalc publish --push"
   },
   "dependencies": {
@@ -50,7 +49,6 @@
     "tiny-invariant": "^1.3.3"
   },
   "devDependencies": {
-    "@angular-devkit/build-angular": "^22.2.2",
     "@angular-devkit/core": "^22.2.2",
     "@angular/build": "^22.2.2",
     "@rsbuild/core": "^2.2.9",
@@ -61,7 +59,6 @@
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
-    "@angular-devkit/build-angular": "^22.2.0",
     "@angular-devkit/core": "^22.2.0",
     "@angular/build": "^22.2.0",
     "@angular/localize": "^22.2.0",
@@ -71,5 +68,14 @@
     "@angular/localize": {
       "optional": true
     }
+  },
+  "ng-update": {
+    "packageGroup": [
+      "@blotch/angular-lynx",
+      "@blotch/angular-lynx-build",
+      "@blotch/angular-lynx-testing-library",
+      "@blotch/rsbuild-plugin-angular-lynx",
+      "@blotch/angular-lynx-native"
+    ]
   }
 }

package/patch/patch-angular-build.cjs

@@ -1,27 +0,0 @@
-const { readFileSync, writeFileSync } = require('node:fs');
-
-const main = () => {
-  const angularBuildPackageJson =
-    require.resolve('@angular/build/package.json');
-  const fileContentsJson = JSON.parse(
-    readFileSync(angularBuildPackageJson, 'utf8'),
-  );
-  // Angular 22.2 moved the transformer out of `src/tools/esbuild/`.
-  fileContentsJson.exports['./src/tools/javascript-transformer'] =
-    './src/tools/javascript-transformer/index.js';
-  fileContentsJson.exports['./src/tools/angular/compilation'] =
-    './src/tools/angular/compilation/index.js';
-  fileContentsJson.exports[
-    './src/tools/esbuild/angular/file-reference-tracker'
-  ] = './src/tools/esbuild/angular/file-reference-tracker.js';
-  fileContentsJson.exports[
-    './src/tools/esbuild/angular/component-stylesheets'
-  ] = './src/tools/esbuild/angular/component-stylesheets.js';
-
-  writeFileSync(
-    angularBuildPackageJson,
-    JSON.stringify(fileContentsJson, null, 2),
-  );
-};
-
-main();