Skip to content

version-21-upgrade.md

Latest commit

 

History

History
42 lines (29 loc) · 3.86 KB

version-21-upgrade.md

File metadata and controls

42 lines (29 loc) · 3.86 KB
Raw

Upgrading to AngularFire 21

AngularFire 21 targets Angular 21 and the Firebase JS SDK v12. Most of the upgrade is handled for you by ng update.

Run the update

ng update @angular/core @angular/cli    # move your app to Angular 21 first
ng update @angular/fire                 # then AngularFire 21

ng update @angular/fire runs a migration that:

  • Aligns your firebase dependency to ^12.4.0. AngularFire 21 requires Firebase JS SDK 12. If your app still requested firebase 11, npm would install both 11 and 12 side by side, and the two copies reject each other's objects at runtime. The migration updates the dependency and reinstalls so you end up with a single copy. Verify with npm ls firebase.
  • Rewrites Vertex AI imports to AI Logic (see below).

Vertex AI is now Firebase AI Logic

The Vertex AI module has been renamed to Firebase AI Logic. The @angular/fire/vertexai entry point (and the older @angular/fire/vertexai-preview) are removed in favor of @angular/fire/ai:

Before (@angular/fire/vertexai) After (@angular/fire/ai)
getVertexAI(app?, { location? }) getAI(app, { backend: new VertexAIBackend(location?) })
provideVertexAI provideAI
VertexAI AI
VertexAIError AIError
VertexAIErrorCode AIErrorCode
VertexAIModel AIModel
VertexAIInstances AIInstances
vertexAIInstance$ AIInstance$
VertexAIModule AIModule

getVertexAI is not a plain rename. getAI already existed alongside it, and a plain getAI() call talks to the Gemini Developer API backend, not to Vertex AI. The equivalent of getVertexAI() is getAI(app, { backend: new VertexAIBackend() }), which is what the migration writes, so your app keeps calling the Vertex AI backend it was configured, enabled, and billed for. A location option moves into the VertexAIBackend constructor.

ng update @angular/fire rewrites these imports and identifiers for you and logs every getVertexAI call it rewrites. Code it cannot rewrite safely (for example when the options are not a literal { location } object or that literal references other rewritten symbols, when the function itself is handed around as a value, when a local declaration in the file reuses an imported symbol's name, or when the file already binds getAI or VertexAIBackend from a source other than AI Logic) is left in place with a warning. The import path itself still moves to the new entry point, so the leftover code fails to compile there, and nothing changes backends silently. A file where a named getVertexAI import has any use that cannot be rewritten keeps every use of its named getVertexAI imports in place (namespace-style ns.getVertexAI(...) calls are judged per call), and each skipped call is logged. export * from '@angular/fire/vertexai' is also left alone (rewriting it would silently rename your re-exported public symbols), so replace it with named re-exports by hand. VertexAIOptions was removed rather than renamed (the new AIOptions takes a backend instead of a location), so imports of it are left and warned about. Migrate those sites using the table above. getGenerativeModel and getImagenModel keep their names.

Imports straight from the Firebase SDK (firebase/vertexai, gone in SDK 12) are rewritten to firebase/ai under the same rules. The rewrite parses your sources with the typescript package (an optional peer dependency of @angular/fire). Every Angular workspace already has it, but if the migration warns that it could not be resolved, install typescript and re-run. See ai.md for current usage.

Other notes

  • Angular 21 is required. AngularFire 21 peers @angular/* ^21.0.0 and does not support Angular 22 (a future AngularFire 22 will).
  • The obsolete @angular/platform-browser-dynamic peer dependency was removed. No action is needed.