From ab190706874317cc36b44efb562db3c5d71201c6 Mon Sep 17 00:00:00 2001 From: jwngr Date: Wed, 1 Jun 2016 15:12:04 -0700 Subject: [PATCH 1/2] Added change log for upcoming 2.0.0 release --- README.md | 2 ++ changelog.txt | 5 +++++ docs/migration/1XX-to-2XX.md | 11 +++++++---- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f54bcc4d..74329502 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ services: Join our [Firebase + Angular Google Group](https://groups.google.com/forum/#!forum/firebase-angular) to ask questions, provide feedback, and share apps you've built with AngularFire. +**Looking for Angular 2 support?** Visit the AngularFire2 project [here](https://github.com/angular/angularfire2). + ## Table of Contents diff --git a/changelog.txt b/changelog.txt index e69de29b..8c078a5f 100644 --- a/changelog.txt +++ b/changelog.txt @@ -0,0 +1,5 @@ +important - See the [migration guide](https://github.com/firebase/angularfire/blob/master/docs/migration/1XX-to-2XX.md) for detailed instructions on how to upgrade. +feature - Upgraded the `firebase` dependency to `3.x.x`. AngularFire will no longer work with Firebase `2.x.x`. +changed - `angular` and `firebase` are now listed as peer dependencies in the `package.json`. +changed - Several auth methods have been renamed and have had their method signatures changed. See the [migration guide](https://github.com/firebase/angularfire/blob/master/docs/migration/1XX-to-2XX.md) for the full details. +changed - The auth payload returned from the authentication methods has changed format. See the new [authentication documentation](https://firebase.google.com/docs/auth/) for details. diff --git a/docs/migration/1XX-to-2XX.md b/docs/migration/1XX-to-2XX.md index ce2167fa..a6d85693 100644 --- a/docs/migration/1XX-to-2XX.md +++ b/docs/migration/1XX-to-2XX.md @@ -8,7 +8,7 @@ change log](https://github.com/firebase/angularfire/releases/tag/v2.0.0). to use Firebase with Angular 2. -## Upgrade your Firebase SDK +## Upgrade to the Firebase `3.x.x` SDK Ensure you're using a `3.x.x` version of the Firebase SDK in your project. Version `2.x.x` of the Firebase SDK is no longer supported with AngularFire version `2.x.x`. @@ -18,10 +18,13 @@ Firebase SDK is no longer supported with AngularFire version `2.x.x`. | 3.x.x | 2.x.x | | 2.x.x | 1.x.x | +Consult the Firebase [web / Node.js migration guide](https://firebase.google.com/support/guides/firebase-web) +for details on how to upgrade to the Firebase `3.x.x` SDK. -## `$firebaseAuth` Updates -Several authentication methods have been renamed and / or have different return values. +## `$firebaseAuth` Method Renames / Signature Changes + +Several authentication methods have been renamed and / or have different method signatures: | Old Method | New Method | Notes | |------------|------------|------------------| @@ -38,7 +41,7 @@ Several authentication methods have been renamed and / or have different return | `$onAuth(callback)` | `$onAuthStateChanged(callback)` |   | -## Auth Payload Notes +## Auth Payload Format Changes Although all your promises and `$getAuth()` calls will continue to function, the auth payload will differ slightly. Ensure that your code is expecting the new payload that is documented in the From 64214431865b421872cae526e0508277d0ce925a Mon Sep 17 00:00:00 2001 From: jwngr Date: Wed, 1 Jun 2016 15:24:03 -0700 Subject: [PATCH 2/2] Fixed some wording in the 2.x.x migration guide --- docs/migration/1XX-to-2XX.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/migration/1XX-to-2XX.md b/docs/migration/1XX-to-2XX.md index a6d85693..27c7bdc9 100644 --- a/docs/migration/1XX-to-2XX.md +++ b/docs/migration/1XX-to-2XX.md @@ -33,9 +33,9 @@ Several authentication methods have been renamed and / or have different method | `$authWithOAuthPopup(provider[, options])` | `$signInWithPopup(provider)` | `options` can be provided by passing a configured `firebase.database.AuthProvider` instead of a `provider` string | | `$authWithOAuthRedirect(provider[, options])` | `$signInWithRedirect(provider)` | `options` can be provided by passing a configured `firebase.database.AuthProvider` instead of a `provider` string | | `$createUser(credentials)` | `$createUserWithEmailAndPassword(email, password)` | | -| `$removeUser(credentials)` | `$deleteUser()` | Deletes the currently logged in user | -| `$changeEmail(credentials)` | `$updateEmail(newEmail)` | Changes the email of the currently logged in user | -| `$changePassword(credentials)` | `$updatePassword(newPassword)` | Changes the password of the currently logged in user | +| `$removeUser(credentials)` | `$deleteUser()` | Deletes the currently signed in user | +| `$changeEmail(credentials)` | `$updateEmail(newEmail)` | Changes the email of the currently signed in user | +| `$changePassword(credentials)` | `$updatePassword(newPassword)` | Changes the password of the currently signed in user | | `$resetPassword(credentials)` | `$sendPasswordResetEmail(email)` | | | `$unauth()` | `$signOut()` | | | `$onAuth(callback)` | `$onAuthStateChanged(callback)` |   | @@ -45,4 +45,4 @@ Several authentication methods have been renamed and / or have different method Although all your promises and `$getAuth()` calls will continue to function, the auth payload will differ slightly. Ensure that your code is expecting the new payload that is documented in the -[Firebase Authentication for Web documentation](https://firebase.google.com/docs/auth/). +[Firebase Authentication guide](https://firebase.google.com/docs/auth/).