Merge branch 'main' into patch-1

Author: armando-navarro

.github/workflows/codeql-analysis.yml

@@ -24,6 +24,10 @@ jobs:
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
 
     strategy:
       fail-fast: false
@@ -35,11 +39,13 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      with:
+        persist-credentials: false
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@54f647b7e1bb85c95cddabcd46b0c578ec92bc1a # v4.36.3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@54f647b7e1bb85c95cddabcd46b0c578ec92bc1a # v4.36.3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +70,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@54f647b7e1bb85c95cddabcd46b0c578ec92bc1a # v4.36.3

.github/workflows/test.yml

@@ -15,39 +15,29 @@ on:
   schedule:
     - cron: 0 0 * * 1-5
 
+permissions:
+  contents: read
+
 jobs:
   build:
     runs-on: ubuntu-latest
     name: Build
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
-          node-version: '18'
+          node-version: '20'
           check-latest: false
-      - name: angular build cache
-        uses: actions/cache@v3
-        with:
-          path: ./.angular
-          key: angular-cache
-      - name: node_modules cache
-        uses: actions/cache@v3
-        id: node_modules_cache
-        with:
-          path: ./node_modules
-          key: ${{ runner.os }}-18-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-18-
       - name: Install deps
-        if: steps.node_modules_cache.outputs.cache-hit != 'true'
-        run: |
-          npm ci
+        run: npm ci
       - name: Build
         run: ./tools/build.sh
       - name: 'Upload Artifact'
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
           name: angularfire-${{ github.run_id }}
           path: dist
@@ -59,32 +49,26 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
-        node: ["18", "20"]
+        node: ["20", "22", "24"]
       fail-fast: false
     name: Test Node ${{ matrix.node }} (${{ matrix.os }})
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
           node-version: ${{ matrix.node }}
           check-latest: true
-      - name: node_modules cache
-        id: node_modules_cache
-        uses: actions/cache@v3
-        with:
-          path: ./node_modules
-          key: ${{ runner.os }}-${{ matrix.node }}-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.node }}-
       - name: Install deps
-        if: steps.node_modules_cache.outputs.cache-hit != 'true'
         run: npm ci
       - name: Download Artifacts
-        uses: actions/download-artifact@v3
-      - name: Relocate Artifacts
-        run: mv angularfire-${{ github.run_id }} dist
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: angularfire-${{ github.run_id }}
+          path: dist
       - name: Test Node
         run: |
           npm run build:jasmine
@@ -105,37 +89,26 @@ jobs:
       fail-fast: false
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
-          node-version: 18
+          node-version: 20
           check-latest: false
       - name: Setup java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520 # v5.4.0
         with:
           distribution: 'temurin'
-          java-version: '11'
-      - name: node_modules cache
-        id: node_modules_cache
-        uses: actions/cache@v3
-        with:
-          path: ./node_modules
-          key: ${{ runner.os }}-${{ matrix.node }}-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.node }}-
+          java-version: '21'
       - name: Install deps
-        if: steps.node_modules_cache.outputs.cache-hit != 'true'
         run: npm ci
-      - name: Firebase emulator cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/firebase/emulators
-          key: firebase_emulators
       - name: Download Artifacts
-        uses: actions/download-artifact@v3
-      - name: Relocate Artifacts
-        run: mv angularfire-${{ github.run_id }} dist
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: angularfire-${{ github.run_id }}
+          path: dist
       - name: Test browser
         run: npm run test:${{ matrix.browser }}
 
@@ -145,26 +118,19 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
-        node: ["18"]
+        node: ["20"]
       fail-fast: false
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
           node-version: ${{ matrix.node }}
           check-latest: true
-      - name: node_modules cache
-        uses: actions/cache@v3
-        id: node_modules_cache
-        with:
-          path: ./node_modules
-          key: ${{ runner.os }}-${{ matrix.node }}-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.node }}-
       - name: Install deps
-        if: steps.node_modules_cache.outputs.cache-hit != 'true'
         run: npm ci
       #- name: Lint
       #  run: npm run lint
@@ -174,16 +140,11 @@ jobs:
         run: |
           npm run build:jasmine
           npm run test:node
-      - name: Firebase emulator cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/firebase/emulators
-          key: firebase_emulators
       - name: Setup java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520 # v5.4.0
         with:
           distribution: 'temurin'
-          java-version: '11'
+          java-version: '21'
       - name: Test headless
         run: npm run test:chrome-headless
         # Tests are flaky on Windows
@@ -204,16 +165,19 @@ jobs:
     if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'release' }}
     steps:
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
-          node-version: '18'
+          node-version: '20'
           registry-url: 'https://registry.npmjs.org'
           check-latest: false
       - name: 'Download Artifacts'
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: angularfire-${{ github.run_id }}
+          path: dist
       - name: Publish
         run: |
-          cd ./angularfire-${{ github.run_id }}/packages-dist
+          cd ./dist/packages-dist
           chmod +x publish.sh
           ./publish.sh
         env:

README.md

@@ -33,9 +33,9 @@ export const appConfig: ApplicationConfig = {
 ```
 
 ```ts
+import { AsyncPipe } from '@angular/common';
 import { inject } from '@angular/core';
 import { Firestore, collectionData, collection } from '@angular/fire/firestore';
-import { Observable } from 'rxjs';
 
 interface Item {
   name: string,
@@ -44,39 +44,24 @@ interface Item {
 
 @Component({
   selector: 'app-root',
-  standalone: true,
   template: `
   <ul>
-    @for (item of (item$ | async); track item) {
+    @for (item of (items$ | async); track item) {
       <li>
         {{ item.name }}
       </li>
     }
   </ul>
-  `
+  `,
+  imports: [AsyncPipe]
 })
 export class AppComponent {
-  item$: Observable<Item[]>;
-  firestore: Firestore = inject(Firestore);
-
-  constructor() {
-    const itemCollection = collection(this.firestore, 'items');
-    this.item$ = collectionData<Item>(itemCollection);
-  }
+  firestore = inject(Firestore);
+  itemCollection = collection(this.firestore, 'items');
+  items$ = collectionData<Item>(this.itemCollection);
 }
 ```
 
-### Polyfills
-
-Neither AngularFire nor Firebase ship with polyfills. To have compatibility across a wide-range of environments, we suggest the following polyfills be added to your application:
-
-| API | Environments | Suggested Polyfill | License |
-|-----|--------------|--------------------|---------|
-| Various ES5+ features  | Safari &lt; 10 | [`core-js/stable`](https://github.com/zloirock/core-js#readme) | MIT |
-| `globalThis` | [Chrome &lt; 71<br>Safari &lt; 12.1<br>iOS &lt; 12.2<br>Node &lt; 12](https://caniuse.com/mdn-javascript_builtins_globalthis) | [`globalThis`](https://github.com/es-shims/globalThis#readme) | MIT |
-| `Proxy` | [Safari &lt; 10](https://caniuse.com/proxy) | [`proxy-polyfill`](https://github.com/GoogleChrome/proxy-polyfill#readme) | Apache 2.0 |
-| `fetch` | [Safari &lt; 10.1<br>iOS &lt; 10.3](https://caniuse.com/fetch) | [`cross-fetch`](https://github.com/lquixada/cross-fetch#readme) | MIT |
-
 ## Resources
 
 [Quickstart](docs/install-and-setup.md) - Get your first application up and running by following our quickstart guide.
@@ -85,15 +70,11 @@ Neither AngularFire nor Firebase ship with polyfills. To have compatibility acro
 
 [Stackblitz Template](https://stackblitz.com/edit/angular-fire-start) - Remember to set your Firebase configuration in `app/app.module.ts`.
 
-[Upgrading to v7.0? Check out our guide.](docs/version-7-upgrade.md)
-
-### Sample apps
+[Upgrading from v6.0? Check out our guide.](docs/version-7-upgrade.md)
 
-We have three sample apps in this repository:
+### Sample app
 
-1. [`samples/compat`](samples/compat) a kitchen sink application that demonstrates use of the "compatibility" API
-1. [`samples/modular`](samples/modular) a kitchen sink application that demonstrates the new tree-shakable API
-1. [`samples/advanced`](samples/advanced) the same app as `samples/modular` but demonstrates more advanced concepts such as Angular Universal state-transfer, dynamically importing Firebase feature modules, and Firestore data bundling.
+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.
 
 ### Having troubles?
 
@@ -193,9 +174,9 @@ import { } from '@angular/fire/app-check';
   <tr>
     <td>
 
-#### [Vertex AI](docs/vertexai.md#vertex-ai-preview)
+#### [Vertex AI](docs/vertexai.md#vertex-ai)
 ```ts
-import { } from '@angular/fire/vertexai-preview';
+import { } from '@angular/fire/vertexai';
 ```
 </td>
 

docs/auth.md

@@ -106,7 +106,7 @@ import { Auth, User, user } from '@angular/fire/auth';
 
 export class UserComponent implements OnDestroy {
   private auth: Auth = inject(Auth);
-  user$ = user(auth);
+  user$ = user(this.auth);
   userSubscription: Subscription;
   ...
 
@@ -136,7 +136,7 @@ import { Auth, authState } from '@angular/fire/auth';
 
 export class UserComponent implements OnDestroy {
   private auth: Auth = inject(Auth);
-  authState$ = authState(auth);
+  authState$ = authState(this.auth);
   authStateSubscription: Subscription;
   ...
 
@@ -165,7 +165,7 @@ import { Auth, idToken } from '@angular/fire/auth';
 
 export class UserComponent implements OnDestroy {
   private auth: Auth = inject(Auth);
-  idToken$ = idToken(auth);
+  idToken$ = idToken(this.auth);
   idTokenSubscription: Subscription;
   ...