@angular/fire 20.1.0 → 21.0.0-canary.a2662fe

package/README.md

@@ -5,48 +5,47 @@ AngularFire smooths over the rough edges an Angular developer might encounter wh
 [Firebase JS SDK](https://github.com/firebase/firebase-js-sdk) & aims to provide a more natural developer experience
 by conforming to Angular conventions.
 
-<strong><pre>ng add @angular/fire</pre></strong>
+<strong><pre>ng add @angular/fire@next</pre></strong>
 
 - **Dependency injection** - Provide and Inject Firebase services in your components.
 - **Zone.js wrappers** - Stable zones allow proper functionality of service workers, forms, SSR, and pre-rendering.
 - **Observable based** - Utilize RxJS rather than callbacks for real-time streams.
 - **NgRx friendly API** - Integrate with NgRx using AngularFire's action based APIs.
 - **Lazy-loading** - AngularFire dynamically imports much of Firebase, reducing the time to load your app.
-- **Deploy schematics** - Get your Angular application deployed on Firebase Hosting with a single command.
 - **Google Analytics** - Zero-effort Angular Router awareness in Google Analytics.
 - **Router Guards** - Guard your Angular routes with built-in Firebase Authentication checks.
 
 ## Example use
 
 ```ts
+import { ApplicationConfig } from '@angular/core';
 import { provideFirebaseApp, initializeApp } from '@angular/fire/app';
 import { getFirestore, provideFirestore } from '@angular/fire/firestore';
 
 export const appConfig: ApplicationConfig = {
   providers: [
-    provideFirebaseApp(() => initializeApp({ ... })),
+    provideFirebaseApp(() => initializeApp({ /* ...your Firebase config... */ })),
     provideFirestore(() => getFirestore()),
-    ...
+    // ...
   ],
-  ...
-})
+  // ...
+}
 ```
 
 ```ts
 import { AsyncPipe } from '@angular/common';
-import { inject } from '@angular/core';
+import { Component, inject } from '@angular/core';
 import { Firestore, collectionData, collection } from '@angular/fire/firestore';
 
 interface Item {
-  name: string,
-  ...
+  name: string;
 };
 
 @Component({
   selector: 'app-root',
   template: `
   <ul>
-    @for (item of (item$ | async); track item) {
+    @for (item of (items$ | async); track item) {
       <li>
         {{ item.name }}
       </li>
@@ -55,10 +54,10 @@ interface Item {
   `,
   imports: [AsyncPipe]
 })
-export class AppComponent {
+export class App {
   firestore = inject(Firestore);
   itemCollection = collection(this.firestore, 'items');
-  item$ = collectionData<Item>(itemCollection);
+  items$ = collectionData<Item>(this.itemCollection);
 }
 ```
 
@@ -66,12 +65,16 @@ export class AppComponent {
 
 [Quickstart](docs/install-and-setup.md) - Get your first application up and running by following our quickstart guide.
 
+[Deploying SSR to App Hosting](docs/app-hosting.md) - Deploy a server-rendered app to Firebase App Hosting, and avoid the silent SSR-to-CSR fallback.
+
 [Contributing](CONTRIBUTING.md)
 
-[Stackblitz Template](https://stackblitz.com/edit/angular-fire-start) - Remember to set your Firebase configuration in `app/app.module.ts`.
+[Stackblitz Template](https://stackblitz.com/edit/angular-fire-start) - A runnable AngularFire example. Add your own Firebase configuration to connect it to your project.
 
 [Upgrading from v6.0? Check out our guide.](docs/version-7-upgrade.md)
 
+[Upgrading from AngularFire 20? See the v21 upgrade guide.](docs/version-21-upgrade.md)
+
 ### Sample app
 
 The [`sample`](sample) folder contains a kitchen sink application that demonstrates use of the "modular" API, in a zoneless server-rendered application, with all the bells and whistles.
@@ -80,7 +83,7 @@ The [`sample`](sample) folder contains a kitchen sink application that demonstra
 
 Get help on our [Q&A board](https://github.com/angular/angularfire/discussions?discussions_q=category%3AQ%26A), the official [Firebase Mailing List](https://groups.google.com/forum/#!forum/firebase-talk), the [Firebase Community Slack](https://firebase.community/) (`#angularfire2`), the [Angular Community Discord](http://discord.gg/angular) (`#firebase`), [Gitter](https://gitter.im/angular/angularfire2), the [Firebase subreddit](https://www.reddit.com/r/firebase), or [Stack Overflow](https://stackoverflow.com/questions/tagged/angularfire2).
 
-> **NOTE:** While relatively stable, AngularFire is a [developer preview](https://angular.io/guide/releases#developer-preview) and is subject to change before general availability. Questions on the mailing list and issues filed here are answered on a <strong>best-effort basis</strong> by maintainers and other community members. If you are able to reproduce a problem with Firebase <em>outside of AngularFire's implementation</em>, please [file an issue on the Firebase JS SDK](https://github.com/firebase/firebase-js-sdk/issues) or reach out to the personalized [Firebase support channel](https://firebase.google.com/support/).
+> **NOTE:** Questions on the mailing list and issues filed here are answered on a <strong>best-effort basis</strong> by maintainers and other community members. If you are able to reproduce a problem with Firebase <em>outside of AngularFire's implementation</em>, please [file an issue on the Firebase JS SDK](https://github.com/firebase/firebase-js-sdk/issues) or reach out to the personalized [Firebase support channel](https://firebase.google.com/support/).
 
 ## Developer Guide
 
@@ -94,10 +97,26 @@ This developer guide assumes you're using the new tree-shakable AngularFire API,
   <tr>
     <td>
 
+#### [AI Logic](docs/ai.md#ai-logic)
+```ts
+import { } from '@angular/fire/ai';
+```
+</td>
+    <td>
+
 #### [Analytics](docs/analytics.md#analytics)
 ```ts
 import { } from '@angular/fire/analytics';
 ```
+</td>
+  </tr>
+  <tr>
+    <td>
+
+#### [App Check](docs/app-check.md#app-check)
+```ts
+import { } from '@angular/fire/app-check';
+```
 </td>
     <td>
 
@@ -142,43 +161,33 @@ import { } from '@angular/fire/storage';
   <tr>
     <td>
 
-#### [Performance Monitoring](docs/performance.md#performance-monitoring)
+#### [Data Connect](docs/data-connect.md#data-connect)
 ```ts
-import { } from '@angular/fire/performance';
+import { } from '@angular/fire/data-connect';
 ```
 </td>
     <td>
 
-#### [Realtime Database](docs/database.md#realtime-database)
+#### [Performance Monitoring](docs/performance.md#performance-monitoring)
 ```ts
-import { } from '@angular/fire/database';
+import { } from '@angular/fire/performance';
 ```
 </td>
   </tr>
   <tr>
     <td>
 
-#### [Remote Config](docs/remote-config.md#remote-config)
-```ts
-import { } from '@angular/fire/remote-config';
-```
-</td>
-    <td>
-
-#### [App Check](docs/app-check.md#app-check)
+#### [Realtime Database](docs/database.md#realtime-database)
 ```ts
-import { } from '@angular/fire/app-check';
+import { } from '@angular/fire/database';
 ```
 </td>
-  </tr>
-  <tr>
     <td>
 
-#### [Vertex AI](docs/vertexai.md#vertex-ai)
+#### [Remote Config](docs/remote-config.md#remote-config)
 ```ts
-import { } from '@angular/fire/vertexai';
+import { } from '@angular/fire/remote-config';
 ```
 </td>
-
   </tr>
 </table>

package/ai/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-ai.mjs"
+  "module": "../fesm2022/angular-fire-ai.mjs",
+  "typings": "../types/angular-fire-ai.d.ts"
 }

package/analytics/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-analytics.mjs"
+  "module": "../fesm2022/angular-fire-analytics.mjs",
+  "typings": "../types/angular-fire-analytics.d.ts"
 }

package/app/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-app.mjs"
+  "module": "../fesm2022/angular-fire-app.mjs",
+  "typings": "../types/angular-fire-app.d.ts"
 }

package/app-check/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-app-check.mjs"
+  "module": "../fesm2022/angular-fire-app-check.mjs",
+  "typings": "../types/angular-fire-app-check.d.ts"
 }

package/auth/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-auth.mjs"
+  "module": "../fesm2022/angular-fire-auth.mjs",
+  "typings": "../types/angular-fire-auth.d.ts"
 }

package/auth-guard/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-auth-guard.mjs"
+  "module": "../fesm2022/angular-fire-auth-guard.mjs",
+  "typings": "../types/angular-fire-auth-guard.d.ts"
 }

package/compat/analytics/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-analytics.mjs"
+  "module": "../../fesm2022/angular-fire-compat-analytics.mjs",
+  "typings": "../../types/angular-fire-compat-analytics.d.ts"
 }

package/compat/auth/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-auth.mjs"
+  "module": "../../fesm2022/angular-fire-compat-auth.mjs",
+  "typings": "../../types/angular-fire-compat-auth.d.ts"
 }

package/compat/auth-guard/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-auth-guard.mjs"
+  "module": "../../fesm2022/angular-fire-compat-auth-guard.mjs",
+  "typings": "../../types/angular-fire-compat-auth-guard.d.ts"
 }

package/compat/database/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-database.mjs"
+  "module": "../../fesm2022/angular-fire-compat-database.mjs",
+  "typings": "../../types/angular-fire-compat-database.d.ts"
 }

package/compat/firestore/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-firestore.mjs"
+  "module": "../../fesm2022/angular-fire-compat-firestore.mjs",
+  "typings": "../../types/angular-fire-compat-firestore.d.ts"
 }

package/compat/functions/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-functions.mjs"
+  "module": "../../fesm2022/angular-fire-compat-functions.mjs",
+  "typings": "../../types/angular-fire-compat-functions.d.ts"
 }

package/compat/messaging/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-messaging.mjs"
+  "module": "../../fesm2022/angular-fire-compat-messaging.mjs",
+  "typings": "../../types/angular-fire-compat-messaging.d.ts"
 }

package/compat/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-compat.mjs"
+  "module": "../fesm2022/angular-fire-compat.mjs",
+  "typings": "../types/angular-fire-compat.d.ts"
 }

package/compat/performance/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-performance.mjs"
+  "module": "../../fesm2022/angular-fire-compat-performance.mjs",
+  "typings": "../../types/angular-fire-compat-performance.d.ts"
 }

package/compat/remote-config/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-remote-config.mjs"
+  "module": "../../fesm2022/angular-fire-compat-remote-config.mjs",
+  "typings": "../../types/angular-fire-compat-remote-config.d.ts"
 }

package/compat/storage/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../../fesm2022/angular-fire-compat-storage.mjs"
+  "module": "../../fesm2022/angular-fire-compat-storage.mjs",
+  "typings": "../../types/angular-fire-compat-storage.d.ts"
 }

package/data-connect/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-data-connect.mjs"
+  "module": "../fesm2022/angular-fire-data-connect.mjs",
+  "typings": "../types/angular-fire-data-connect.d.ts"
 }

package/database/package.json

@@ -1,3 +1,4 @@
 {
-  "module": "../fesm2022/angular-fire-database.mjs"
+  "module": "../fesm2022/angular-fire-database.mjs",
+  "typings": "../types/angular-fire-database.d.ts"
 }

package/docs/ai.md

@@ -0,0 +1,52 @@
+<small>
+<a href="https://github.com/angular/angularfire">AngularFire</a> &#10097; <a href="../README.md#developer-guide">Developer Guide</a> &#10097; AI Logic
+</small>
+
+# AI Logic
+
+Firebase AI Logic gives you access to the latest generative AI models from Google: the Gemini models, including the Gemini image models.
+
+[Learn more](https://firebase.google.com/docs/ai-logic)
+
+> Firebase AI Logic was previously called **Vertex AI in Firebase**. If you are upgrading from AngularFire 20, the module moved from `@angular/fire/vertexai` to `@angular/fire/ai` and most symbols were renamed (`provideVertexAI` to `provideAI`, `VertexAI` to `AI`). One is not a rename: plain `getAI()` uses the Gemini Developer API backend, so the old `getVertexAI()` maps to `getAI(app, { backend: new AgentPlatformBackend() })`. Running the `ng update` command in the [AngularFire 20 to 21 upgrade guide](./version-21-upgrade.md) rewrites all of this for you and keeps your app on the same backend, though a call that passed no `location` moves from `us-central1` to `global`.
+
+## Dependency Injection
+
+As a prerequisite, ensure that `AngularFire` has been added to your project as described in the [Quickstart](./install-and-setup.md).
+
+Provide an AI instance in the application's `app.config.ts`:
+
+```ts
+import { provideFirebaseApp, initializeApp } from '@angular/fire/app';
+import { provideAI, getAI } from '@angular/fire/ai';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideFirebaseApp(() => initializeApp({ ... })),
+    provideAI(() => getAI()),
+    ...
+  ],
+  ...,
+}
+```
+
+Next inject `AI` into your component:
+
+```typescript
+import { Component, inject } from '@angular/core';
+import { AI } from '@angular/fire/ai';
+
+@Component({ ... })
+export class MyComponent {
+    private ai = inject(AI);
+    ...
+}
+```
+
+## Firebase API
+
+AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
+
+Update the imports from `import { ... } from 'firebase/ai'` to `import { ... } from '@angular/fire/ai'` and follow the official documentation.
+
+[Getting Started](https://firebase.google.com/docs/ai-logic/get-started?platform=web) | [API Reference](https://firebase.google.com/docs/reference/js/ai)

package/docs/analytics.md

@@ -12,12 +12,9 @@ Google Analytics is an app measurement solution, available at no charge, that pr
 
 ## Dependency Injection
 
-As a prerequisite, ensure that `AngularFire` has been added to your project via
-```bash
-ng add @angular/fire
-```
+As a prerequisite, ensure that `AngularFire` has been added to your project as described in the [Quickstart](./install-and-setup.md).
 
-Provide a Analytics instance in the application's `app.config.ts`:
+Provide an Analytics instance in the application's `app.config.ts`:
 
 ```ts
 import { provideFirebaseApp, initializeApp } from '@angular/fire/app';

package/docs/app-check.md

@@ -12,15 +12,13 @@ App Check helps protect your API resources from abuse by preventing unauthorized
 
 ## Dependency Injection
 
-As a prerequisite, ensure that `AngularFire` has been added to your project via
-```bash
-ng add @angular/fire
-```
+As a prerequisite, ensure that `AngularFire` has been added to your project as described in the [Quickstart](./install-and-setup.md).
 
-Provide a App Check instance in the application's `app.config.ts`:
+Provide an App Check instance in the application's `app.config.ts`:
 
 ```ts
-import { provideFirebaseApp, initializeApp } from '@angular/fire/app';
+import { ApplicationConfig } from '@angular/core';
+import { provideFirebaseApp, initializeApp, getApp } from '@angular/fire/app';
 import { provideAppCheck, initializeAppCheck, ReCaptchaV3Provider } from '@angular/fire/app-check';
 
 export const appConfig: ApplicationConfig = {
@@ -32,7 +30,7 @@ export const appConfig: ApplicationConfig = {
     ...
   ],
   ...
-})
+}
 ```
 
 Next inject `AppCheck` it into your component:
@@ -54,4 +52,4 @@ AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular,
 
 Update the imports from `import { ... } from 'firebase/app-check'` to `import { ... } from '@angular/fire/app-check'` and follow the official documentation.
 
-[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-enterprise-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check)
+[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check)

package/docs/app-hosting.md

@@ -0,0 +1,95 @@
+<small>
+<a href="https://github.com/angular/angularfire">AngularFire</a> &#10097; <a href="../README.md#developer-guide">Developer Guide</a> &#10097; Deploying SSR to Firebase App Hosting
+</small>
+
+# Deploying a server-rendered app to Firebase App Hosting
+
+[Firebase App Hosting](https://firebase.google.com/docs/app-hosting) is Firebase's recommended way to deploy a server-side-rendered (SSR) Angular application. It builds your app in Google Cloud Build, runs the Node server, and serves it behind Google's CDN and proxy. This applies to either way of deploying to App Hosting, a connected GitHub repository or `firebase deploy` from your own machine; both build the same way and are affected the same way.
+
+This guide covers one thing that trips up almost every new SSR deployment: **the server can silently stop server-rendering and fall back to client-side rendering (CSR), with no error anywhere obvious.** It explains how to detect that in 30 seconds and how to fix it.
+
+## How to deploy
+
+If you have not deployed yet, follow Firebase's own guides: [Get started with App Hosting](https://firebase.google.com/docs/app-hosting/get-started) to connect a GitHub repository (App Hosting builds and deploys on every push), or [Alternative ways to deploy](https://firebase.google.com/docs/app-hosting/alt-deploy) to deploy with `firebase deploy` from your own machine. Both build your app the same way in Google Cloud Build. The rest of this guide covers an Angular-specific issue you can hit once your app is deployed either way.
+
+## The symptom: SSR silently downgrades to CSR
+
+A freshly deployed Angular SSR app usually *looks* fine in a browser, the page renders and works. But the server may be sending an almost-empty HTML shell and letting the browser do all the rendering. When that happens you lose the whole point of SSR: crawlers and link previews see no content, and first paint on slow devices is worse.
+
+There is no error in the deploy output and no error in the browser. The only trace is in your backend's server logs, which nothing prompts you to check.
+
+App Hosting runs on Cloud Run, not Cloud Functions, so its logs live in Cloud Logging:
+
+- In the Firebase console, open your backend and go to its **Logs** tab, then look at **Runtime logs**.
+- From a terminal, use `gcloud`:
+
+  ```bash
+  gcloud logging read 'resource.type=cloud_run_revision AND resource.labels.service_name=YOUR_BACKEND_ID' --project YOUR_PROJECT_ID --limit 10
+  ```
+
+See Firebase's [View logs and metrics](https://firebase.google.com/docs/app-hosting/logging) guide for more.
+
+## The 30-second check to run after every deploy
+
+Pick an SSR route (not an SSG/prerendered one) and fetch it:
+
+```bash
+curl -s https://YOUR-SITE/ | grep ng-server-context
+```
+
+Angular's server renderer stamps a `ng-server-context` attribute on the app's root element:
+
+- `ng-server-context="ssr"` - the route was server-rendered (SSR). This is what you want.
+- `ng-server-context="ssg"` - the route was prerendered (SSG). Fine in itself, but not the SSR path this guide is about.
+- **No `ng-server-context` at all** - the server returned a client-only shell and the browser is doing all the rendering. This is the silent CSR fallback described above, regardless of how the page looks in a browser.
+
+## Why it happens
+
+Angular's server engine only trusts the `X-Forwarded-*` headers a proxy attaches to a request when it is told to. App Hosting's proxy adds several of these headers (for example `x-forwarded-for` and `x-forwarded-proto`). If Angular does not trust the full set the platform sends, it treats the request as untrusted and de-optimizes to CSR on every request.
+
+<!--
+  Maintainer note (2026-07-19): the two-step fix below is a workaround for a lag in
+  Firebase App Hosting's build image. The underlying fix (injecting the full
+  X-Forwarded-* set into NG_TRUST_PROXY_HEADERS) is already merged upstream in
+  GoogleCloudPlatform/buildpacks (commit 9346e60b, 2026-06-17) but had not reached
+  production builders as of 2026-07-19. Once it ships, `npm update` alone suffices
+  and the trustProxyHeaders step becomes optional; revisit and simplify this guide.
+-->
+
+## The Fix
+
+Two steps are needed together.
+
+**1. Update Angular to the latest patch:**
+
+```bash
+npm update @angular/core @angular/ssr
+```
+
+**2. Turn on proxy-header trust when you create the server engine.** In `src/server.ts`, pass `trustProxyHeaders: true` to `AngularNodeAppEngine`:
+
+```ts
+import { AngularNodeAppEngine } from '@angular/ssr/node';
+
+const angularApp = new AngularNodeAppEngine({
+  trustProxyHeaders: true,
+});
+```
+
+Redeploy, then run the 30-second check above. You should now see `ng-server-context="ssr"`.
+
+### Why both steps
+
+The two steps address different halves of the same handshake, and neither alone is enough:
+
+- Recent Angular patches let the `trustProxyHeaders` engine option take effect on App Hosting; on older patches a platform environment variable wins instead, so the code option is ignored. The `npm update` gets you onto a patch where the option is honored.
+- Even on the latest patch, you still have to *set* the option, so App Hosting's proxy headers are trusted.
+
+This matches Firebase's own guidance. For the current, authoritative version of this fix (including any App Hosting or Angular version notes), see Firebase's [App Hosting troubleshooting guide](https://firebase.google.com/docs/app-hosting/troubleshooting#angular-proxy-trust).
+
+> Note: App Hosting also has an experimental, opt-in local-build deploy option (you build on your own machine, then `firebase deploy`) in which the Firebase CLI applies this proxy-header configuration for you. It is off by default and not a documented, supported workflow, so this guide targets the standard source deploy; apply the fix above.
+
+## Related Angular documentation
+
+- [Angular SSR guide](https://angular.dev/guide/ssr)
+- [Configuring trusted proxy headers](https://angular.dev/best-practices/security#configuring-trusted-proxy-headers)