v17.1.0 (#3524)

* Preview note in README * Bump version * Deprecation note on legacy ng-deploy * Add vertexai wrapper * Drop ng-deploy setup from ng-add * Start moving docs towards standalone
angular · May 14, 2024 · 1302e3a · 1302e3a
1 parent 05e9da2
commit 1302e3a
Show file tree

Hide file tree

Showing 20 changed files with 534 additions and 1,226 deletions.
diff --git a/README.md b/README.md
@@ -19,17 +19,17 @@ by conforming to Angular conventions.
 ## Example use
 
 ```ts
-import { provideFirebaseApp, getApp, initializeApp } from '@angular/fire/app';
+import { provideFirebaseApp, initializeApp } from '@angular/fire/app';
 import { getFirestore, provideFirestore } from '@angular/fire/firestore';
 
-@NgModule({
-  imports: [
+export const appConfig: ApplicationConfig = {
+  providers: [
     provideFirebaseApp(() => initializeApp({ ... })),
     provideFirestore(() => getFirestore()),
+    ...
   ],
   ...
 })
-export class AppModule { }
 ```
 
 ```ts
@@ -44,11 +44,14 @@ interface Item {
 
 @Component({
   selector: 'app-root',
+  standalone: true,
   template: `
   <ul>
-    <li *ngFor="let item of item$ | async">
-      {{ item.name }}
-    </li>
+    @for (item of (item$ | async); track item) {
+      <li>
+        {{ item.name }}
+      </li>
+    }
   </ul>
   `
 })
@@ -96,11 +99,11 @@ We have three sample apps in this repository:
 
 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:** AngularFire is maintained by Googlers but is not a supported Firebase product. 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:** 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/).
 
 ## Developer Guide
 
-This developer guide assumes you're using the new tree-shakable AngularFire API, [if you're looking for the compatability API you can find the documentation here](docs/compat.md).
+This developer guide assumes you're using the new tree-shakable AngularFire API, [if you're looking for the compatibility API you can find the documentation here](docs/compat.md).
 
 [See the v7 upgrade guide for more information on this change.](docs/version-7-upgrade.md).
 
@@ -188,9 +191,3 @@ import { } from '@angular/fire/app-check';
 </td>
   </tr>
 </table>
-
-### Deploying your site
-
-* Deploy to Firebase Hosting
-* Angular Universal: Deploy to Cloud Functions
-* Angular Universal: Deploy to Cloud Run
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@angular/fire",
-  "version": "17.0.0",
+  "version": "17.1.0",
   "description": "Angular + Firebase = ❤️",
   "private": true,
   "scripts": {
@@ -55,7 +55,7 @@
     "@angular/platform-browser-dynamic": "^17.0.0",
     "@angular/router": "^17.0.0",
     "@schematics/angular": "^17.0.0",
-    "firebase": "^10.7.0",
+    "firebase": "^10.12.0",
     "firebase-admin": "^9.11.1",
     "firebase-functions": "^3.6.0",
     "firebase-tools": "^13.0.0",

diff --git a/src/app/firebase.ts b/src/app/firebase.ts
diff --git a/src/package.json b/src/package.json
@@ -34,7 +34,7 @@
     "firebase-tools": { "optional": true }
   },
   "dependencies": {
-    "firebase": "^10.7.0",
+    "firebase": "^10.12.0",
     "rxfire": "^6.0.5",
     "@angular-devkit/schematics": "^17.0.0",
     "@schematics/angular": "^17.0.0",

diff --git a/src/schematics/common.ts b/src/schematics/common.ts
@@ -1,6 +1,6 @@
 import { SchematicContext, SchematicsException, Tree } from '@angular-devkit/schematics';
 import * as semver from 'semver';
-import { FirebaseHostingSite, FirebaseRc } from './interfaces';
+import { FirebaseHostingSite } from './interfaces';
 
 export const shortSiteName = (site?: FirebaseHostingSite) => site?.name?.split('/').pop();
 
@@ -18,44 +18,6 @@ export const overwriteIfExists = (
   }
 };
 
-function emptyFirebaseRc() {
-  return {
-    targets: {}
-  };
-}
-
-function generateFirebaseRcTarget(firebaseProject: string, firebaseHostingSite: FirebaseHostingSite|undefined, project: string) {
-  return {
-    hosting: {
-      [project]: [
-        shortSiteName(firebaseHostingSite) ?? firebaseProject
-      ]
-    }
-  };
-}
-
-export function generateFirebaseRc(
-  tree: Tree,
-  path: string,
-  firebaseProject: string,
-  firebaseHostingSite: FirebaseHostingSite|undefined,
-  project: string
-) {
-  const firebaseRc: FirebaseRc = tree.exists(path)
-    ? safeReadJSON(path, tree)
-    : emptyFirebaseRc();
-
-  firebaseRc.targets = firebaseRc.targets || {};
-  firebaseRc.targets[firebaseProject] = generateFirebaseRcTarget(
-    firebaseProject,
-    firebaseHostingSite,
-    project
-  );
-  firebaseRc.projects = { default: firebaseProject };
-
-  overwriteIfExists(tree, path, stringifyFormatted(firebaseRc));
-}
-
 export function safeReadJSON(path: string, tree: Tree) {
   try {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion

diff --git a/src/schematics/deploy/actions.ts b/src/schematics/deploy/actions.ts
@@ -390,6 +390,8 @@ export default async function deploy(
   options: DeployBuilderOptions,
   firebaseToken?: string,
 ) {
+  const legacyNgDeploy = !options.version || options.version < 2;
+
   if (!firebaseToken && !process.env.GOOGLE_APPLICATION_CREDENTIALS) {
     await firebaseTools.login();
     const user = await firebaseTools.login({ projectRoot: context.workspaceRoot });
@@ -401,6 +403,12 @@ export default async function deploy(
     console.log(`Using Google Application Credentials.`);
   }
 
+  if (legacyNgDeploy) {
+    console.error(`Legacy ng-deploy Firebase is deprecated.
+Please migrate to Firebase Hosting's integration with Angular https://firebase.google.com/docs/hosting/frameworks/angular
+or the new Firebase App Hosting product https://firebase.google.com/docs/app-hosting`);
+  }
+
   if (prerenderBuildTarget) {
     const run = await context.scheduleTarget(
       targetFromTargetString(prerenderBuildTarget.name),
@@ -465,7 +473,7 @@ export default async function deploy(
 
   firebaseTools.logger.logger.add(logger);
 
-  if ((!options.version || options.version < 2) && serverBuildTarget) {
+  if (legacyNgDeploy && serverBuildTarget) {
     if (options.ssr === 'cloud-run') {
       await deployToCloudRun(
         firebaseTools,

diff --git a/src/schematics/interfaces.ts b/src/schematics/interfaces.ts
@@ -1,7 +1,6 @@
 import { RuntimeOptions } from 'firebase-functions';
 
 export const enum FEATURES {
-  Hosting,
   Authentication,
   Analytics,
   AppCheck,
@@ -12,10 +11,10 @@ export const enum FEATURES {
   Firestore,
   Storage,
   RemoteConfig,
+  VertexAI,
 }
 
 export const featureOptions = [
-  { name: 'ng deploy -- hosting', value: FEATURES.Hosting },
   { name: 'Authentication', value: FEATURES.Authentication },
   { name: 'Google Analytics', value: FEATURES.Analytics },
   { name: 'App Check', value: FEATURES.AppCheck },
@@ -26,6 +25,7 @@ export const featureOptions = [
   { name: 'Performance Monitoring', value: FEATURES.Performance },
   { name: 'Cloud Storage', value: FEATURES.Storage },
   { name: 'Remote Config', value: FEATURES.RemoteConfig },
+  { name: 'VertexAI (preview)', value: FEATURES.VertexAI },
 ];
 
 export const enum PROJECT_TYPE { Static, CloudFunctions, CloudRun, WebFrameworks }