Builder

The @angular-architects/native-federation:build target — what it puts in angular.json, how it wraps Angular's ApplicationBuilder, and every option it accepts.

The @angular-architects/native-federation:build target is a thin wrapper around @angular/build:application. It runs the Native Federation build (shared bundles, exposed modules, remoteEntry.json), then delegates to Angular's Application Builder for the host/remote app itself. The same builder is used for both build and serve; the difference is configured by options.

On Angular 22+ the adapter ships under the base package @angular-architects/native-federation (22.x) — the names on this page assume it. On Angular 20/21 the identical builder is published as @angular-architects/native-federation-v4:build; substitute the -v4 package name throughout. See Getting Started for the version matrix.

On this page

The angular.json Layout

The init schematic doesn't replace your existing build — it shifts everything sideways and slots the federation builder on top. After running it, every federated project has four targets:

{
  "architect": {
    "build":           { "builder": "@angular-architects/native-federation:build", ... },
    "serve":           { "builder": "@angular-architects/native-federation:build", ... },
    "esbuild":         { "builder": "@angular/build:application", ... },        // ← old build
    "serve-original":  { "builder": "@angular/build:dev-server", ... }          // ← old serve
  }
}

The schematic's defaults look like this:

"build": {
  "builder": "@angular-architects/native-federation:build",
  "options": {
    "projectName": "mfe1",
    "tsConfig": "projects/mfe1/tsconfig.federation.json",
    "cacheExternalArtifacts": true,
    "entryPoints": ["projects/mfe1/src/main.ts"]
  },
  "configurations": {
    "production":  { "target": "mfe1:esbuild:production" },
    "development": { "target": "mfe1:esbuild:development", "dev": true }
  },
  "defaultConfiguration": "production"
},
"serve": {
  "builder": "@angular-architects/native-federation:build",
  "options": {
    "projectName": "mfe1",
    "tsConfig": "projects/mfe1/tsconfig.federation.json",
    "target": "mfe1:serve-original:development",
    "rebuildDelay": 500,
    "cacheExternalArtifacts": true,
    "dev": true,
    "devServer": true,
    "port": 0,
    "entryPoints": ["projects/mfe1/src/main.ts"]
  }
}

What the Builder Does

For every ng build or ng serve the federation builder runs roughly the following sequence:

  1. Resolve the underlying target (the esbuild or serve-original target referenced by options.target) and load its options.
  2. Construct an NFBuildAdapter over esbuild and Angular's SourceFileCache (see below).
  3. Call the core's normalizeFederationOptions with the project's federation.config.mjs (falling back to federation.config.js if no .mjs file exists, or the explicit federationConfigPath option if set) and tsconfig.federation.json.
  4. Validate that there are no invalid .-imports in the externals (a current Vite limitation — see vitejs/vite#21036). Shared mappings are checked by the core itself, at the end of normalizeFederationOptions — on the set left after pruning and wildcard expansion, so paths that were never going to be published stay quiet.
  5. Run the core's buildForFederation — this writes the shared bundles, exposed modules and remoteEntry.json into the configured output directory.
  6. If I18N is configured, post-process the federation artifacts with localize-translate (one bundle copy per target locale).
  7. Hand off to buildApplication (build) or serveWithVite (serve), passing the computed externals through to esbuild and registering federation middleware on the dev server.
  8. In watch / dev mode: re-run steps 5–6 on every Angular rebuild, debounced by rebuildDelay.

The build is rejected entirely (no federation artifacts written) when the underlying Angular build fails. Federation rebuilds in dev mode are cancellable: a new file change aborts an in-flight federation rebuild via an AbortSignal instead of stacking up.

Builder Options

Every property below comes from src/builders/build/schema.json:

OptionTypeDefaultDescription
targetstringThe Angular target this builder delegates to (e.g. mfe1:esbuild:production, or for serve mfe1:serve-original:development). Required when used as a serve builder; for build it's set per configuration.
projectNamestringThe Angular project name. Used for the federation cache key and for default output paths.
tsConfigstringunderlying target's tsconfigA specific tsconfig used only for the federation build (exposed modules + shared mappings). The schematic creates tsconfig.federation.json for this purpose so the federation build doesn't pick up your test types or app-only paths. It also drives esbuild's module resolution, so it must declare or extend the workspace baseUrl/paths (see below).
federationConfigPathstringfederation.config.mjsPath to the project's federation config file. Point it elsewhere if your config doesn't sit next to the project or isn't named federation.config.mjs. Added in 22.0.1.
entryPointsstring[][<tsConfig dir>/src/main.ts]Entry points used to detect which dependencies are actually used. Combined with features.ignoreUnusedDeps in federation.config.mjs this drives shaking of unused shared externals. Seeded by the init / update-v4 schematics; defaults to [<sourceRoot>/main.ts].
devbooleanfalseEnables development mode for the federation build: source maps, unminified output, watch-mode SSE notifications, and (for SSR) the dev host-instance bridge that registers the federation loader inside Vite's SSR graph. Set automatically by the development configuration.
watchbooleanfalseRe-runs the federation build on file changes. Set automatically when serving; useful for ng build --watch.
devServerbooleaninferred from target nameForce the builder into dev-server mode. By default the builder serves whenever the target name contains "serve"; override here if your naming is unusual.
portnumber0Port for the dev server. 0 inherits the underlying serve-original target's port (which the schematic seeds with the --port argument).
rebuildDelaynumber (ms)2000Debounce window before re-running the federation build after Angular reports a change. Bursts of file saves get coalesced; in-flight rebuilds are cancelled in favour of the latest. The schematic seeds 500 for serve for snappy DX.
cacheExternalArtifacts (alias cache)booleantrueReuse the bundled external artifacts from node_modules/.cache/native-federation/<project> across builds. See core caching for the checksum logic.
baseHrefstringOverrides the underlying Angular target's baseHref. Also used by the dev server to strip the prefix from federation artifact requests.
outputPathstringdist/<project>Output base directory. The federation artifacts land in <outputPath>/browser/<sourceLocale?>.
ssrbooleanfalseMarks this build as SSR-capable. When true, externals are passed through Angular's externalDependencies instead of an esbuild plugin (the SSR build path doesn't run that plugin). The CLI's server.mjs is emitted as-is; the federation loader is registered at launch via the node --import @angular-architects/native-federation/node-preload … preload (prod) or the dev host-instance bridge (ng serve). See SSR & Hydration.
esmsInitOptionsobject{ shimMode: true }Options injected into the <script type="esms-options"> tag added to index.html. Forwarded to es-module-shims. Set { shimMode: false } to opt out of shim mode and use the browser's native import maps instead.
skipHtmlTransformbooleanfalseSkip the index.html rewrite (script tags → type="module-shim" + esms-options). Useful if you template index.html yourself.
buildNotificationsobject{ enable: true, endpoint: '/@angular-architects/native-federation:build-notifications' }Server-Sent Events stream that notifies a host when a remote finishes (re)building. See below.

tsConfig and Module Resolution

The tsConfig option doesn't only select which files are compiled — it is passed through to esbuild's BuildOptions, so it also decides how bare specifiers resolve.

The reason is that Angular's compiler plugin only hooks onLoad, leaving esbuild to resolve specifiers itself. Without an explicit tsconfig, esbuild only honours baseUrl/paths from an auto-discovered file named exactly tsconfig.json — which misses tsconfig.app.json / tsconfig.lib.json layouts and breaks workspace imports with Could not resolve. Angular's own application builder passes the same normalized path.

Practically: the tsconfig you point tsConfig at must declare the workspace baseUrl and paths, or extends a config that does. The tsconfig.federation.json the schematic generates already extends the workspace root config, so generated projects need no change.

Native Import Maps

Since 22.0.3. By default the adapter runs es-module-shims in shim mode (esmsInitOptions: { shimMode: true }), which rewrites the app's script tags to type="module-shim". Modern browsers now support import maps natively, so you can opt out of shim mode and let the browser resolve the import map directly:

"options": {
  "esmsInitOptions": { "shimMode": false }
}

The build and runtime sides must agree. If you disable shim mode in the builder, disable it on the runtime too — pass shimMode: false to the orchestrator's useShimImportMap (or initFederation) in your main.ts:

initFederation('federation.manifest.json', {
  ...useShimImportMap({ shimMode: false }),
  // ...
});

Native import maps require a recent browser (Chrome/Edge 133+, Safari 18.4+, Firefox 150+); shim mode remains the default for broader compatibility. See Runtime for the runtime side.

Subresource Integrity

Since 22.0.1. When Angular's own subresourceIntegrity option is enabled, the CLI stamps integrity and crossorigin attributes onto the polyfills and main script tags. The federation builder now preserves those attributes when it rewrites the tags for federation — only the type attribute is changed. This keeps SRI hashes intact for environments that require them (e.g. PCI DSS compliance).

Dev Server & Hot Reload

When serving, the builder layers two things on top of Angular's Vite-based dev server:

Developing npm-linked Shared Libraries

A common local-development setup is to build a shared library in its own repo with ng build --watch (ng-packagr) and pull it into the host with npm link.

Because Native Federation shares such a library as an external, it is excluded from Angular's own build — the change lands under node_modules, which Angular's build watcher skips. The federation builder covers that gap: it detects linked shared packages and re-bundles them on change, so no cache clear or dev-server restart is needed.

Requirements:

# 1. In the shared library's repo — build to dist/ and keep watching
ng build --watch

# 2. Publish the built package to the local npm link registry
cd dist/my-lib && npm link

# 3. In the host repo — link the package into node_modules
npm link @my-scope/my-lib

# 4. Run the host as usual
ng serve

Editing a source file in the library now rebuilds its dist/, and the builder re-bundles the affected shared external and logs Done!. To also refresh the browser automatically, enable SSE-based reloading with initFederation(manifest, { sse: true }); otherwise refresh manually.

Under the hood the builder resolves the real path of each symlinked shared package and adds it to the federation file watcher. Linked packages live under node_modules, so they are watched by polling, and a short debounce coalesces ng-packagr's atomic multi-file writes into one rebuild. Only the affected shared externals are re-bundled; registry-installed dependencies keep the version-only cache fast path (see core caching).

Nx and @angular/build Preloading

The builder disables two Angular build features by setting environment variables before @angular/build loads:

@angular/build reads those variables once, when it is first loaded. Under the Angular CLI the builder is loaded first, so this works. Nx loads @angular/build before it resolves the builder (nx/src/adapter/compat.js requires @angular/build/private to stub a version assertion), so the variables arrive too late and both features stay on — see #107 / #114.

The builder detects this and re-applies both settings to the already-loaded @angular/build, logging:

INFO  @angular/build was already loaded when this builder started (Nx preloads it),
      so its build environment was stale; re-applied useParallelTs=false,
      optimizeChunksThreshold=Infinity.

That line is informational — the problem was corrected and no action is needed. Two things are worth knowing:

If the builder instead warns that it could not re-apply a setting, @angular/build has changed internally: use the .env approach and report it upstream.

Locale-aware Output Paths

When the underlying Angular target has localize enabled (or an array of locales) the federation artifacts are written under the source-locale subfolder, mirroring Angular's convention:

dist/mfe1/browser/
├── en/                    ← source locale, original federation artifacts
│   ├── remoteEntry.json
│   ├── _angular_core.<hash>.js
│   └── ...
├── de/                    ← translated copy, generated by localize-translate
│   ├── remoteEntry.json
│   └── ...
└── fr/
    └── ...

Configure your production federation.manifest.json to point at the locale-specific URL (/de/remoteEntry.json). See I18N for the details.

How the Adapter Wraps esbuild

For builds that emit federation artifacts (shared externals, exposed modules, mapped paths) the adapter creates two distinct esbuild contexts:

Both contexts share the same SourceFileCache Angular uses for incremental rebuilds, so a TypeScript file invalidated in the federation build is also picked up by the next Angular rebuild.