Add ability to add scopes for GoogleAuthProvider #1266

Author: EddyVerbruggen

demo/app/main-view-model.ts

@@ -1146,7 +1146,13 @@ export class HelloWorldModel extends Observable {
   public doLoginByGoogle(): void {
     firebase.login({
       // note that you need to enable Google auth in your firebase instance
-      type: firebase.LoginType.GOOGLE
+      type: firebase.LoginType.GOOGLE,
+      googleOptions: {
+        scopes: [
+            "https://www.googleapis.com/auth/contacts.readonly",
+            "https://www.googleapis.com/auth/user.birthday.read"
+        ]
+      }
     }).then(
         result => {
           console.log("Google login OK: " + JSON.stringify(result));

docs/AUTHENTICATION.md

@@ -534,7 +534,7 @@ Then add the following lines to your code and check for setup instructions for y
     // Optional
     facebookOptions: {
       // defaults to ['public_profile', 'email']
-      scope: ['public_profile', 'email']
+      scopes: ['public_profile', 'email'] // note: this property was renamed from "scope" in 8.4.0
     }
   }).then(
       function (result) {
@@ -611,7 +611,10 @@ Then add the following lines to your code and check for setup instructions for y
     type: firebase.LoginType.GOOGLE,
     // Optional 
     googleOptions: {
-      hostedDomain: "mygsuitedomain.com"
+      hostedDomain: "mygsuitedomain.com",
+      // NOTE: no need to add 'profile' nor 'email', because they are always provided
+      // NOTE 2: requesting scopes means you may access those properties, but they are not automatically fetched by the plugin
+      scopes: ['https://www.googleapis.com/auth/user.birthday.read']
     }
   }).then(
       function (result) {

src/firebase.android.ts

@@ -1113,6 +1113,14 @@ firebase.login = arg => {
           googleSignInOptionsBuilder.setHostedDomain(arg.googleOptions.hostedDomain);
         }
 
+        if (arg.googleOptions && arg.googleOptions.scopes) {
+          const scopesArray = [];
+          if (arg.googleOptions.scopes.length > 1) {
+            arg.googleOptions.scopes.forEach(s => scopesArray.push(new com.google.android.gms.common.api.Scope(s)));
+          }
+          googleSignInOptionsBuilder.requestScopes(new com.google.android.gms.common.api.Scope(arg.googleOptions.scopes[0]), scopesArray);
+        }
+
         const googleSignInOptions = googleSignInOptionsBuilder.build();
 
         const onConnectionFailedListener = new com.google.android.gms.common.api.GoogleApiClient.OnConnectionFailedListener({

src/firebase.d.ts

@@ -267,13 +267,19 @@ export interface FirebasePhoneLoginOptions {
 
 export interface FirebaseGoogleLoginOptions {
   hostedDomain?: string;
+  /**
+   * You can add scopes like "https://www.googleapis.com/auth/contacts.readonly" and "https://www.googleapis.com/auth/user.birthday.read"
+   *
+   * Default: ["profile", "email"]
+   */
+  scopes?: Array<string>;
 }
 
 export interface FirebaseFacebookLoginOptions {
   /**
    * Default: ["public_profile", "email"]
    */
-  scope?: string[];
+  scopes?: Array<string>;
 }
 
 export interface FirebaseCustomLoginOptions {

src/firebase.ios.ts

@@ -950,14 +950,14 @@ firebase.login = arg => {
         // this requires you to set the appid and customurlscheme in app_resources/.plist
         const fbSDKLoginManager = FBSDKLoginManager.new();
         // fbSDKLoginManager.loginBehavior = FBSDKLoginBehavior.Web;
-        let scope: any = ["public_profile", "email"];
+        let scopes: any = ["public_profile", "email"];
 
-        if (arg.facebookOptions && arg.facebookOptions.scope) {
-          scope = arg.facebookOptions.scope;
+        if (arg.facebookOptions && arg.facebookOptions.scopes) {
+          scopes = arg.facebookOptions.scopes;
         }
 
         fbSDKLoginManager.logInWithReadPermissionsFromViewControllerHandler(
-            scope,
+            scopes,
             null, // the viewcontroller param can be null since by default topmost is taken
             onFacebookCompletion);
 
@@ -976,6 +976,10 @@ firebase.login = arg => {
           sIn.hostedDomain = arg.googleOptions.hostedDomain;
         }
 
+        if (arg.googleOptions && arg.googleOptions.scopes) {
+          sIn.scopes = arg.googleOptions.scopes;
+        }
+
         let delegate = GIDSignInDelegateImpl.new().initWithCallback((user: GIDGoogleUser, error: NSError) => {
           if (error === null) {
             // Get a Google ID token and Google access token from the GIDAuthentication object and exchange them for a Firebase credential