Renamed AuthCredential into OAuthCredential and added extra optional … (#255)

Author: AlexandreRoba

packages/firebase-dart/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 7.0.0-dev
+
+- **BREAKING** renamed `AuthCredential` into `OAuthCredential` to align with JS API
+- Added `idToken`, `accessToken` and `secret` to `OAuthCredential`
+
 ## 6.0.0
 
 - **BREAKING** Removed and renamed members across `auth` and `firestore` to

packages/firebase-dart/lib/src/auth.dart

@@ -15,7 +15,7 @@ export 'interop/auth_interop.dart'
     show
         ActionCodeInfo,
         ActionCodeEmail,
-        AuthCredential,
+        OAuthCredential,
         ActionCodeSettings,
         IosSettings,
         AndroidSettings,
@@ -107,7 +107,7 @@ class User extends UserInfo<firebase_interop.UserJsImpl> {
 
   /// Links the user account with the given credentials, and returns any
   /// available additional user information, such as user name.
-  Future<UserCredential> linkWithCredential(AuthCredential credential) =>
+  Future<UserCredential> linkWithCredential(OAuthCredential credential) =>
       handleThenable(jsObject.linkWithCredential(credential))
           .then((u) => UserCredential.fromJsObject(u));
 
@@ -136,7 +136,7 @@ class User extends UserInfo<firebase_interop.UserJsImpl> {
   /// Re-authenticates a user using a fresh credential, and returns any
   /// available additional user information, such as user name.
   Future<UserCredential> reauthenticateWithCredential(
-          AuthCredential credential) =>
+          OAuthCredential credential) =>
       handleThenable(jsObject.reauthenticateWithCredential(credential))
           .then((o) => UserCredential.fromJsObject(o));
 
@@ -202,7 +202,7 @@ class User extends UserInfo<firebase_interop.UserJsImpl> {
       handleThenable(jsObject.updatePassword(newPassword));
 
   /// Updates the user's phone number.
-  Future updatePhoneNumber(AuthCredential phoneCredential) =>
+  Future updatePhoneNumber(OAuthCredential phoneCredential) =>
       handleThenable(jsObject.updatePhoneNumber(phoneCredential));
 
   /// Updates a user's [profile] data.
@@ -416,7 +416,7 @@ class Auth extends JsObjectWrapper<AuthJsImpl> {
 
   /// Asynchronously signs in with the given credentials, and returns any
   /// available additional user information, such as user name.
-  Future<UserCredential> signInWithCredential(AuthCredential credential) =>
+  Future<UserCredential> signInWithCredential(OAuthCredential credential) =>
       handleThenable(jsObject.signInWithCredential(credential))
           .then((u) => UserCredential.fromJsObject(u));
 
@@ -534,7 +534,7 @@ class EmailAuthProvider extends AuthProvider<EmailAuthProviderJsImpl> {
       : super.fromJsObject(jsObject);
 
   /// Creates a credential for e-mail.
-  static AuthCredential credential(String email, String password) =>
+  static OAuthCredential credential(String email, String password) =>
       EmailAuthProviderJsImpl.credential(email, password);
 }
 
@@ -570,7 +570,7 @@ class FacebookAuthProvider extends AuthProvider<FacebookAuthProviderJsImpl> {
           jsObject.setCustomParameters(jsify(customOAuthParameters)));
 
   /// Creates a credential for Facebook.
-  static AuthCredential credential(String token) =>
+  static OAuthCredential credential(String token) =>
       FacebookAuthProviderJsImpl.credential(token);
 }
 
@@ -606,7 +606,7 @@ class GithubAuthProvider extends AuthProvider<GithubAuthProviderJsImpl> {
           jsObject.setCustomParameters(jsify(customOAuthParameters)));
 
   /// Creates a credential for GitHub.
-  static AuthCredential credential(String token) =>
+  static OAuthCredential credential(String token) =>
       GithubAuthProviderJsImpl.credential(token);
 }
 
@@ -644,7 +644,7 @@ class GoogleAuthProvider extends AuthProvider<GoogleAuthProviderJsImpl> {
 
   /// Creates a credential for Google.
   /// At least one of [idToken] and [accessToken] is required.
-  static AuthCredential credential([String idToken, String accessToken]) =>
+  static OAuthCredential credential([String idToken, String accessToken]) =>
       GoogleAuthProviderJsImpl.credential(idToken, accessToken);
 }
 
@@ -676,7 +676,7 @@ class OAuthProvider extends AuthProvider<OAuthProviderJsImpl> {
 
   /// Creates a credential for Google.
   /// At least one of [idToken] and [accessToken] is required.
-  AuthCredential credential([String idToken, String accessToken]) =>
+  OAuthCredential credential([String idToken, String accessToken]) =>
       jsObject.credential(idToken, accessToken);
 }
 
@@ -705,7 +705,7 @@ class TwitterAuthProvider extends AuthProvider<TwitterAuthProviderJsImpl> {
           jsObject.setCustomParameters(jsify(customOAuthParameters)));
 
   /// Creates a credential for Twitter.
-  static AuthCredential credential(String token, String secret) =>
+  static OAuthCredential credential(String token, String secret) =>
       TwitterAuthProviderJsImpl.credential(token, secret);
 }
 
@@ -740,7 +740,7 @@ class PhoneAuthProvider extends AuthProvider<PhoneAuthProviderJsImpl> {
   /// Creates a phone auth credential given the verification ID
   /// from [verifyPhoneNumber] and the [verificationCode] that was sent to the
   /// user's mobile device.
-  static AuthCredential credential(
+  static OAuthCredential credential(
           String verificationId, String verificationCode) =>
       PhoneAuthProviderJsImpl.credential(verificationId, verificationCode);
 }
@@ -836,7 +836,7 @@ class ConfirmationResult extends JsObjectWrapper<ConfirmationResultJsImpl> {
           .then((u) => UserCredential.fromJsObject(u));
 }
 
-/// A structure containing a [User], an [AuthCredential] and [operationType].
+/// A structure containing a [User], an [OAuthCredential] and [operationType].
 /// operationType could be 'signIn' for a sign-in operation, 'link' for a
 /// linking operation and 'reauthenticate' for a reauthentication operation.
 ///
@@ -846,7 +846,7 @@ class UserCredential extends JsObjectWrapper<UserCredentialJsImpl> {
   User get user => User.getInstance(jsObject.user);
 
   /// Returns the auth credential.
-  AuthCredential get credential => jsObject.credential;
+  OAuthCredential get credential => jsObject.credential;
 
   /// Returns the operation type.
   String get operationType => jsObject.operationType;

packages/firebase-dart/lib/src/interop/auth_interop.dart

@@ -35,7 +35,7 @@ abstract class AuthJsImpl {
   external PromiseJsImpl<UserCredentialJsImpl> signInAnonymously();
 
   external PromiseJsImpl<UserCredentialJsImpl> signInWithCredential(
-      AuthCredential credential);
+      OAuthCredential credential);
   external PromiseJsImpl<UserCredentialJsImpl> signInWithCustomToken(
       String token);
   external PromiseJsImpl<UserCredentialJsImpl>
@@ -74,11 +74,29 @@ class Persistence {
 /// Implementations specify the details about each auth provider's credential
 /// requirements.
 ///
-/// See: <https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential>.
-@JS()
-abstract class AuthCredential {
+/// See: <https://firebase.google.com/docs/reference/js/firebase.auth.OAuthCredential>.
+@JS('OAuthCredential')
+abstract class OAuthCredential {
   /// The authentication provider ID for the credential.
   external String get providerId;
+
+  /// The OAuth access token associated with the credential if it belongs to
+  /// an OAuth provider, such as facebook.com, twitter.com, etc.
+  external String get accessToken;
+
+  /// The OAuth ID token associated with the credential if it belongs to an
+  /// OIDC provider, such as google.com.
+  external String get idToken;
+
+  /// The OAuth access token secret associated with the credential if it
+  /// belongs to an OAuth 1.0 provider, such as twitter.com.
+  external String get secret;
+
+  /// The authentication sign in method for the credential. For example,
+  /// 'password', or 'emailLink. This corresponds to the sign-in method
+  /// identifier as returned in: fetchsigninmethodsforemail
+  /// See <https://firebase.google.com/docs/reference/js/firebase.auth.Auth.html#fetchsigninmethodsforemail>
+  external String get signInMethod;
 }
 
 @JS('AuthProvider')
@@ -90,7 +108,7 @@ abstract class AuthProviderJsImpl {
 class EmailAuthProviderJsImpl extends AuthProviderJsImpl {
   external factory EmailAuthProviderJsImpl();
   external static String get PROVIDER_ID;
-  external static AuthCredential credential(String email, String password);
+  external static OAuthCredential credential(String email, String password);
 }
 
 @JS('FacebookAuthProvider')
@@ -100,7 +118,7 @@ class FacebookAuthProviderJsImpl extends AuthProviderJsImpl {
   external FacebookAuthProviderJsImpl addScope(String scope);
   external FacebookAuthProviderJsImpl setCustomParameters(
       customOAuthParameters);
-  external static AuthCredential credential(String token);
+  external static OAuthCredential credential(String token);
 }
 
 @JS('GithubAuthProvider')
@@ -109,7 +127,7 @@ class GithubAuthProviderJsImpl extends AuthProviderJsImpl {
   external static String get PROVIDER_ID;
   external GithubAuthProviderJsImpl addScope(String scope);
   external GithubAuthProviderJsImpl setCustomParameters(customOAuthParameters);
-  external static AuthCredential credential(String token);
+  external static OAuthCredential credential(String token);
 }
 
 @JS('GoogleAuthProvider')
@@ -118,7 +136,7 @@ class GoogleAuthProviderJsImpl extends AuthProviderJsImpl {
   external static String get PROVIDER_ID;
   external GoogleAuthProviderJsImpl addScope(String scope);
   external GoogleAuthProviderJsImpl setCustomParameters(customOAuthParameters);
-  external static AuthCredential credential(
+  external static OAuthCredential credential(
       [String idToken, String accessToken]);
 }
 
@@ -127,15 +145,15 @@ class OAuthProviderJsImpl extends AuthProviderJsImpl {
   external factory OAuthProviderJsImpl(String providerId);
   external OAuthProviderJsImpl addScope(String scope);
   external OAuthProviderJsImpl setCustomParameters(customOAuthParameters);
-  external AuthCredential credential([String idToken, String accessToken]);
+  external OAuthCredential credential([String idToken, String accessToken]);
 }
 
 @JS('TwitterAuthProvider')
 class TwitterAuthProviderJsImpl extends AuthProviderJsImpl {
   external factory TwitterAuthProviderJsImpl();
   external static String get PROVIDER_ID;
   external TwitterAuthProviderJsImpl setCustomParameters(customOAuthParameters);
-  external static AuthCredential credential(String token, String secret);
+  external static OAuthCredential credential(String token, String secret);
 }
 
 @JS('PhoneAuthProvider')
@@ -145,7 +163,7 @@ class PhoneAuthProviderJsImpl extends AuthProviderJsImpl {
   external PromiseJsImpl<String> verifyPhoneNumber(
       String phoneNumber, ApplicationVerifierJsImpl applicationVerifier);
   // TODO official documentation says PromiseJsImpl<AuthCredential> return type
-  external static AuthCredential credential(
+  external static OAuthCredential credential(
       String verificationId, String verificationCode);
 }
 
@@ -292,7 +310,7 @@ class AndroidSettings {
 @anonymous
 class UserCredentialJsImpl {
   external UserJsImpl get user;
-  external AuthCredential get credential;
+  external OAuthCredential get credential;
   external String get operationType;
   external AdditionalUserInfoJsImpl get additionalUserInfo;
 }

packages/firebase-dart/lib/src/interop/firebase_interop.dart

@@ -49,15 +49,15 @@ abstract class UserJsImpl extends UserInfoJsImpl {
   external PromiseJsImpl delete();
   external PromiseJsImpl<String> getIdToken([bool opt_forceRefresh]);
   external PromiseJsImpl<UserCredentialJsImpl> linkWithCredential(
-      AuthCredential credential);
+      OAuthCredential credential);
   external PromiseJsImpl<ConfirmationResultJsImpl> linkWithPhoneNumber(
       String phoneNumber, ApplicationVerifierJsImpl applicationVerifier);
   external PromiseJsImpl<UserCredentialJsImpl> linkWithPopup(
       AuthProviderJsImpl provider);
   external PromiseJsImpl linkWithRedirect(AuthProviderJsImpl provider);
 
   external PromiseJsImpl reauthenticateWithCredential(
-      AuthCredential credential);
+      OAuthCredential credential);
   external PromiseJsImpl<ConfirmationResultJsImpl>
       reauthenticateWithPhoneNumber(
           String phoneNumber, ApplicationVerifierJsImpl applicationVerifier);
@@ -71,7 +71,7 @@ abstract class UserJsImpl extends UserInfoJsImpl {
   external PromiseJsImpl<UserJsImpl> unlink(String providerId);
   external PromiseJsImpl updateEmail(String newEmail);
   external PromiseJsImpl updatePassword(String newPassword);
-  external PromiseJsImpl updatePhoneNumber(AuthCredential phoneCredential);
+  external PromiseJsImpl updatePhoneNumber(OAuthCredential phoneCredential);
   external PromiseJsImpl updateProfile(UserProfile profile);
   external Object toJSON();
 }

packages/firebase-dart/pubspec.yaml

@@ -1,6 +1,6 @@
 name: firebase
 description: Firebase libraries for Dart on the web and server
-version: 6.0.0
+version: 7.0.0-dev
 authors:
 - Jana Moudra <[email protected]>
 - Kevin Moore <[email protected]>