#1145 Added option to retrieve Firebase custom claims

Author: EddyVerbruggen

demo/app/main-view-model.ts

@@ -1,20 +1,21 @@
-import { RewardedVideoAdReward } from "nativescript-plugin-firebase/admob/admob";
-import { Observable } from "tns-core-modules/data/observable";
-import { alert, prompt } from "tns-core-modules/ui/dialogs";
-import { isAndroid, isIOS } from "tns-core-modules/platform";
 import * as firebase from "nativescript-plugin-firebase";
 import {
   AddEventListenerResult,
   admob as firebaseAdMob,
   crashlytics as firebaseCrashlytics,
+  GetAuthTokenResult,
+  LogComplexEventTypeParameter,
   performance as firebasePerformance,
   storage as firebaseStorage,
-  User,
-  LogComplexEventTypeParameter
+  User
 } from "nativescript-plugin-firebase";
+import { RewardedVideoAdReward } from "nativescript-plugin-firebase/admob/admob";
+import { FirebaseTrace } from "nativescript-plugin-firebase/performance/performance";
+import { Observable } from "tns-core-modules/data/observable";
 import * as fs from "tns-core-modules/file-system";
+import { isAndroid, isIOS } from "tns-core-modules/platform";
+import { alert, prompt } from "tns-core-modules/ui/dialogs";
 import { MessagingViewModel } from './messaging-view-model';
-import { FirebaseTrace } from "nativescript-plugin-firebase/performance/performance";
 
 const firebaseWebApi = require("nativescript-plugin-firebase/app");
 
@@ -1012,16 +1013,12 @@ export class HelloWorldModel extends Observable {
           });
 
           // now retrieve an auth token we can use to access Firebase from our server
-          firebase.getAuthToken({
-            forceRefresh: false
-          }).then(
-              token => {
-                console.log("Auth token retrieved: " + token);
-              },
-              errorMessage => {
-                console.log("Auth token retrieval error: " + errorMessage);
-              }
-          );
+          firebase.getAuthToken(
+              {
+                forceRefresh: false
+              })
+              .then((result: GetAuthTokenResult) => console.log("Auth token retrieved: " + JSON.stringify(result)))
+              .catch(errorMessage => console.log("Auth token retrieval error: " + errorMessage));
         },
         errorMessage => {
           console.log("Login error: " + errorMessage);

src/firebase.android.ts

@@ -2,7 +2,14 @@ import * as appModule from "tns-core-modules/application";
 import { AndroidActivityResultEventData } from "tns-core-modules/application";
 import lazy from "tns-core-modules/utils/lazy";
 import { ad as AndroidUtils } from "tns-core-modules/utils/utils";
-import { DataSnapshot, firestore, OnDisconnect as OnDisconnectBase, User } from "./firebase";
+import {
+  DataSnapshot,
+  firestore,
+  GetAuthTokenOptions,
+  GetAuthTokenResult,
+  OnDisconnect as OnDisconnectBase,
+  User
+} from "./firebase";
 import {
   DocumentSnapshot as DocumentSnapshotBase,
   FieldValue,
@@ -128,7 +135,7 @@ firebase.toHashMap = obj => {
           if (fieldValue.type === "ARRAY_UNION") {
             // nested arrays are not allowed, so harden against wrong usage: arrayUnion(["foo", "bar"]) vs arrayUnion("foo", "bar")
             let values: Array<any> = Array.isArray(fieldValue.value[0]) ? fieldValue.value[0] : fieldValue.value;
-            values = values.map(v => typeof(v) === "object" ? firebase.toHashMap(v) : v);
+            values = values.map(v => typeof (v) === "object" ? firebase.toHashMap(v) : v);
             node.put(property, com.google.firebase.firestore.FieldValue.arrayUnion(values));
           } else if (fieldValue.type === "ARRAY_REMOVE") {
             node.put(property, com.google.firebase.firestore.FieldValue.arrayRemove(Array.isArray(fieldValue.value[0]) ? fieldValue.value[0] : fieldValue.value));
@@ -696,26 +703,19 @@ firebase.unlink = providerId => {
   });
 };
 
-firebase.getAuthToken = arg => {
+firebase.getAuthToken = (arg: GetAuthTokenOptions): Promise<GetAuthTokenResult> => {
   return new Promise((resolve, reject) => {
     try {
       const firebaseAuth = com.google.firebase.auth.FirebaseAuth.getInstance();
       const user = firebaseAuth.getCurrentUser();
       if (user !== null) {
         const onSuccessListener = new gmsTasks.OnSuccessListener({
-          onSuccess: getTokenResult => {
-            if (arg.withClaims) {
-               /* get token and custom claims previously set via the Firebase Admin SDK. */
-              resolve(
-                  {
-                      token: getTokenResult.getToken(),
-                      claims: getTokenResult.getClaims()
-             }
-              );
-          } else {
-             /* get just token without custom claims */
-              resolve(getTokenResult.getToken());
-          }
+          onSuccess: tokenResult => {
+            resolve({
+              token: tokenResult.getToken(),
+              claims: firebase.toJsObject(tokenResult.getClaims()),
+              signInProvider: tokenResult.getSignInProvider()
+            });
           }
         });
 

src/firebase.d.ts

@@ -202,8 +202,12 @@ export interface GetAuthTokenOptions {
    * Default false.
    */
   forceRefresh?: boolean;
-  /* Set this to true if you want any custom claims returned that you previously set via the Firebase Admin SDK. */
-  withClaims?: boolean;
+}
+
+export interface GetAuthTokenResult {
+  token: string;
+  claims: { [key: string]: any; };
+  signInProvider: string;
 }
 
 export interface Provider {
@@ -565,6 +569,7 @@ export function removeEventListeners(listeners: Array<any>, path: string): Promi
 export function onDisconnect(path: string): OnDisconnect;
 
 export function enableLogging(logger?: boolean | ((a: string) => any), persistent?: boolean);
+
 /**
  * Tells the client to keep its local cache in sync with the server automatically.
  */
@@ -875,7 +880,7 @@ export function reauthenticate(options: ReauthenticateOptions): Promise<any>;
 
 export function reloadUser(): Promise<void>;
 
-export function getAuthToken(option: GetAuthTokenOptions): Promise<any>;
+export function getAuthToken(option: GetAuthTokenOptions): Promise<GetAuthTokenResult>;
 
 export function logout(): Promise<any>;
 

src/firebase.ios.ts

@@ -1,5 +1,12 @@
 import * as application from "tns-core-modules/application/application";
-import { DataSnapshot, firestore, OnDisconnect as OnDisconnectBase, User } from "./firebase";
+import {
+  DataSnapshot,
+  firestore,
+  GetAuthTokenOptions,
+  GetAuthTokenResult,
+  OnDisconnect as OnDisconnectBase,
+  User
+} from "./firebase";
 import {
   DocumentSnapshot as DocumentSnapshotBase,
   FieldValue,
@@ -662,7 +669,7 @@ function toLoginResult(user, additionalUserInfo?: FIRAdditionalUserInfo): User {
   return loginResult;
 }
 
-firebase.getAuthToken = arg => {
+firebase.getAuthToken = (arg: GetAuthTokenOptions): Promise<GetAuthTokenResult> => {
   return new Promise((resolve, reject) => {
     try {
       const fAuth = FIRAuth.auth();
@@ -673,20 +680,17 @@ firebase.getAuthToken = arg => {
 
       const user = fAuth.currentUser;
       if (user) {
-        const onCompletion = (token, error) => {
+        user.getIDTokenResultForcingRefreshCompletion(arg.forceRefresh, (result: FIRAuthTokenResult, error: NSError) => {
           if (error) {
             reject(error.localizedDescription);
           } else {
-            resolve(token);
+            resolve({
+              token: result.token,
+              claims: firebaseUtils.toJsObject(result.claims),
+              signInProvider: result.signInProvider
+            });
           }
-        };
-        /* get token and custom claims previously set via the Firebase Admin SDK. */
-        if(arg.withClaims) {
-          user.getIDTokenResultForcingRefreshCompletion(arg.forceRefresh, onCompletion);
-      } else {
-        /* get just token without custom claims */
-          user.getIDTokenForcingRefreshCompletion(arg.forceRefresh, onCompletion);
-      }
+        });
       } else {
         reject("Log in first");
       }