Adding additionalUserInfo and metadata to sign in response #763 #764

Author: EddyVerbruggen

demo/app/main-page.xml

@@ -121,7 +121,7 @@
             <Button row="12" col="1" text="send email conf" tap="{{ doSendEmailVerification }}" class="button"/>
 
             <Button row="13" col="0" text="get current user" tap="{{ doGetCurrentUser }}" class="button"/>
-            <Button row="13" col="1" text="logout" tap="{{ doLogout }}" class="button"/>
+            <Button row="13" col="1" text="logout" tap="{{ doLogout }}" class="button button-user"/>
 
             <Label row="14" colSpan="2" text="Methods on path /users" class="subtitle"/>
 

demo/app/main-view-model.ts

@@ -733,6 +733,7 @@ export class HelloWorldModel extends Observable {
       type: firebase.LoginType.ANONYMOUS
     }).then(
         result => {
+          console.log("Anonymous login OK: " + JSON.stringify(result));
           alert({
             title: "Login OK",
             message: JSON.stringify(result),
@@ -862,6 +863,7 @@ export class HelloWorldModel extends Observable {
       }
     }).then(
         result => {
+          console.log("Password login OK: " + JSON.stringify(result));
           alert({
             title: "Login OK",
             message: JSON.stringify(result),
@@ -881,6 +883,8 @@ export class HelloWorldModel extends Observable {
           );
         },
         errorMessage => {
+          console.log("Login error: " + errorMessage);
+          this.set("userEmailOrPhone", errorMessage);
           alert({
             title: "Login error",
             message: errorMessage,
@@ -909,6 +913,7 @@ export class HelloWorldModel extends Observable {
         }
       }).then(
           result => {
+            console.log("Phone login OK: " + JSON.stringify(result));
             alert({
               title: "Phone login OK",
               message: JSON.stringify(result),
@@ -945,6 +950,7 @@ export class HelloWorldModel extends Observable {
         }
       }).then(
           result => {
+            console.log("Email link sent");
             alert({
               title: "Email link sent",
               message: "Check your email :)",
@@ -968,6 +974,7 @@ export class HelloWorldModel extends Observable {
       type: firebase.LoginType.FACEBOOK
     }).then(
         result => {
+          console.log("Facebook login OK: " + JSON.stringify(result));
           alert({
             title: "Login OK",
             message: JSON.stringify(result),
@@ -990,6 +997,7 @@ export class HelloWorldModel extends Observable {
       type: firebase.LoginType.GOOGLE
     }).then(
         result => {
+          console.log("Google login OK: " + JSON.stringify(result));
           alert({
             title: "Login OK",
             message: JSON.stringify(result),
@@ -1010,13 +1018,16 @@ export class HelloWorldModel extends Observable {
     firebase.resetPassword({
       email: '[email protected]'
     }).then(
-        result => {
+        () => {
+          console.log("Password reset. Check your email.");
+          this.set("userEmailOrPhone", "Password reset mail sent to [email protected].");
           alert({
             title: "Password reset. Check your email.",
             okButtonText: "OK, nice!"
           });
         },
         error => {
+          console.log("Password reset error: " + error);
           alert({
             title: "Password reset error",
             message: error,
@@ -1048,12 +1059,14 @@ export class HelloWorldModel extends Observable {
     firebase.logout().then(
         () => {
           this.set("userEmailOrPhone", null);
+          console.log("Logout OK");
           alert({
             title: "Logout OK",
             okButtonText: "OK, bye!"
           });
         },
         error => {
+          console.log("Logout error: " + error);
           alert({
             title: "Logout error",
             message: error,

docs/AUTHENTICATION.md

@@ -27,7 +27,24 @@ All login functions below, as well as `getCurrentUser` return a 'User' object wi
 |`profileImageURL`|yes|A string containing a link to a user image on the web
 |`phoneNumber`|yes|The user's phone number
 |`refreshToken`|yes|iOS only
+|`additionalUserInfo`|no|See `AdditionalUserInfo` below
+|`metadata`|no|See `UserMetadata` below
 
+### `AdditionalUserInfo`
+
+|param|optional|description
+|---|---|---
+|`profile`|yes|Any profile data the auth provider may supply. Type is `Map<string, any>`.
+|`providerId`|no|The provider that was used to login this time. Example: `password` or `google.com`.
+|`username`|yes|The username, usually `null`.
+|`isNewUser`|no|Whether or not the user was just created.
+
+### `UserMetadata`
+
+|param|optional|description
+|---|---|---
+|`creationTimestamp`|no|Type is `Date`.
+|`lastSignInTimestamp`|no|Type is `Date`.
 
 ## Functions
 You can either use the Native API, or the Web API. It's just a matter of personal background or preference. Under the hood the implementations are identical.

src/firebase.android.ts

@@ -5,7 +5,7 @@ import { ad as AndroidUtils, layout } from "tns-core-modules/utils/utils";
 import lazy from "tns-core-modules/utils/lazy";
 import { topmost } from "tns-core-modules/ui/frame";
 import { File } from "tns-core-modules/file-system";
-import {firestore, User} from "./firebase";
+import { firestore, User } from "./firebase";
 
 declare const android, com, org: any;
 
@@ -20,7 +20,6 @@ let fbCallbackManager = null;
 const GOOGLE_SIGNIN_INTENT_ID = 123;
 const REQUEST_INVITE_INTENT_ID = 48;
 
-// const gson = lazy(() => typeof(com.google.gson) === "undefined" ? null : new com.google.gson.Gson());
 const messagingEnabled = lazy(() => typeof(com.google.firebase.messaging) !== "undefined");
 const dynamicLinksEnabled = lazy(() => typeof(com.google.android.gms.appinvite) !== "undefined");
 
@@ -199,21 +198,7 @@ firebase.toValue = val => {
   return returnVal;
 };
 
-// no longer using Gson as fi Firestore's DocumentReference isn't serialized (also removed it from the dependencies)
 firebase.toJsObject = javaObj => {
-  // if (gson() !== null) {
-  //   try {
-  //     return JSON.parse(gson().toJson(javaObj)); // this may fail if fi a DocumentReference is encountered
-  //   } catch (ignore) {
-  //     return firebase.toJsObjectLegacy(javaObj);
-  //   }
-  // } else {
-  // fallback for folks not having fetched gson yet in their build for some reason
-  return firebase.toJsObjectLegacy(javaObj);
-  // }
-};
-
-firebase.toJsObjectLegacy = javaObj => {
   if (javaObj === null || typeof javaObj !== "object") {
     return javaObj;
   }
@@ -242,7 +227,7 @@ firebase.toJsObjectLegacy = javaObj => {
     case 'java.util.ArrayList':
       node = [];
       for (let i = 0; i < javaObj.size(); i++) {
-        node[i] = firebase.toJsObjectLegacy(javaObj.get(i));
+        node[i] = firebase.toJsObject(javaObj.get(i));
       }
       break;
     default:
@@ -251,7 +236,7 @@ firebase.toJsObjectLegacy = javaObj => {
         const iterator = javaObj.entrySet().iterator();
         while (iterator.hasNext()) {
           const item = iterator.next();
-          node[item.getKey()] = firebase.toJsObjectLegacy(item.getValue());
+          node[item.getKey()] = firebase.toJsObject(item.getValue());
         }
       } catch (e) {
         console.log("PLEASE REPORT THIS AT https://github.com/NativeScript/NativeScript/issues: Tried to serialize an unsupported type: javaObj.getClass().getName(), error: " + e);
@@ -316,7 +301,7 @@ firebase.init = arg => {
             const user = fbAuth.getCurrentUser();
             arg.onAuthStateChanged({
               loggedIn: user !== null,
-              user: toLoginResult(user, null)
+              user: toLoginResult(user)
             });
           }
         });
@@ -330,7 +315,7 @@ firebase.init = arg => {
             const user = fbAuth.getCurrentUser();
             firebase.notifyAuthStateListeners({
               loggedIn: user !== null,
-              user: toLoginResult(user, null)
+              user: toLoginResult(user)
             });
           }
         });
@@ -882,7 +867,7 @@ firebase.getCurrentUser = arg => {
       const firebaseAuth = com.google.firebase.auth.FirebaseAuth.getInstance();
       const user = firebaseAuth.getCurrentUser();
       if (user !== null) {
-        resolve(toLoginResult(user, null));
+        resolve(toLoginResult(user));
       } else {
         reject();
       }
@@ -974,7 +959,7 @@ firebase.getAuthToken = arg => {
   });
 };
 
-function toLoginResult(user, additionalUserInfo): User {
+function toLoginResult(user, additionalUserInfo?): User {
   if (user === null) {
     return null;
   }
@@ -992,33 +977,33 @@ function toLoginResult(user, additionalUserInfo): User {
     }
   }
 
-    const loginResult: User = {
-        uid: user.getUid(),
-        name: user.getDisplayName(),
-        email: user.getEmail(),
-        emailVerified: user.isEmailVerified(),
-        // provider: user.getProviderId(), // always 'firebase'
-        providers: providers,
-        anonymous: user.isAnonymous(),
-        isAnonymous: user.isAnonymous(),
-        phoneNumber: user.getPhoneNumber(),
-        profileImageURL: user.getPhotoUrl() ? user.getPhotoUrl().toString() : null,
-        metadata: {
-            creationTimestamp: new Date(user.getMetadata().getCreationTimestamp() as number),
-            lastSignInTimestamp: new Date(user.getMetadata().getLastSignInTimestamp() as number)
-        }
-    };
+  const loginResult: User = {
+    uid: user.getUid(),
+    name: user.getDisplayName(),
+    email: user.getEmail(),
+    emailVerified: user.isEmailVerified(),
+    // provider: user.getProviderId(), // always 'firebase'
+    providers: providers,
+    anonymous: user.isAnonymous(),
+    isAnonymous: user.isAnonymous(),
+    phoneNumber: user.getPhoneNumber(),
+    profileImageURL: user.getPhotoUrl() ? user.getPhotoUrl().toString() : null,
+    metadata: {
+      creationTimestamp: new Date(user.getMetadata().getCreationTimestamp() as number),
+      lastSignInTimestamp: new Date(user.getMetadata().getLastSignInTimestamp() as number)
+    }
+  };
 
-    if (additionalUserInfo !== null) {
-        loginResult.additionalUserInfo = {
-            profile: additionalUserInfo.getProfile(),
-            providerId: additionalUserInfo.getProviderId(),
-            username: additionalUserInfo.getUsername(),
-            isNewUser: additionalUserInfo.isNewUser()
-        };
+  if (additionalUserInfo) {
+    loginResult.additionalUserInfo = {
+      providerId: additionalUserInfo.getProviderId(),
+      username: additionalUserInfo.getUsername(),
+      isNewUser: additionalUserInfo.isNewUser(),
+      profile: firebase.toJsObject(additionalUserInfo.getProfile())
     }
+  }
 
-    return loginResult;
+  return loginResult;
 }
 
 firebase.login = arg => {
@@ -1086,7 +1071,7 @@ firebase.login = arg => {
         }
 
         const actionCodeSettings = com.google.firebase.auth.ActionCodeSettings.newBuilder()
-            // URL you want to redirect back to. The domain must be whitelisted in the Firebase Console.
+        // URL you want to redirect back to. The domain must be whitelisted in the Firebase Console.
             .setUrl(arg.emailLinkOptions.url)
             .setHandleCodeInApp(true)
             .setIOSBundleId(arg.emailLinkOptions.iOS ? arg.emailLinkOptions.iOS.bundleId : appModule.android.context.getPackageName())
@@ -1122,7 +1107,7 @@ firebase.login = arg => {
 
         if (user && firebase._alreadyLinkedToAuthProvider(user, "phone")) {
           // skip sending an SMS if user is already linked to the phone-provider
-          resolve(toLoginResult(user, null));
+          resolve(toLoginResult(user));
           return;
         }
 

src/firebase.d.ts

@@ -300,7 +300,7 @@ export interface User {
   providers: Array<Provider>;
   profileImageURL?: string;
   metadata: UserMetadata;
-  additionalUserInfo?: AdditionalUserInfo
+  additionalUserInfo?: AdditionalUserInfo;
   /** iOS only */
   refreshToken?: string;
 }
@@ -309,18 +309,18 @@ export interface User {
  * The metadata of the user
  */
 export interface UserMetadata {
-  creationTimestamp: Date,
-  lastSignInTimestamp: Date
+  creationTimestamp: Date;
+  lastSignInTimestamp: Date;
 }
 
 /**
  * Contains additional user information
  */
 export interface AdditionalUserInfo {
-    profile: Map<string, any>;
-    providerId: string;
-    username: string;
-    isNewUser: boolean
+  profile: Map<string, any>;
+  providerId: string;
+  username: string;
+  isNewUser: boolean;
 }
 
 /**
@@ -416,9 +416,9 @@ export interface GetRemoteConfigOptions {
   /**
    * The configuration properties to retrieve for your app. Specify as:
    *  properties: [{
-         *    key: "holiday_promo_enabled",
-         *    default: false
-         *  }, ..]
+   *    key: "holiday_promo_enabled",
+   *    default: false
+   *  }, ..]
    */
   properties: Array<RemoteConfigProperty>;
 }
@@ -441,9 +441,9 @@ export interface GetRemoteConfigResult {
    * A JS Object with properties and values.
    * If you previously requested keys ["foo", "is_enabled"] then this will be like:
    *   properties: {
-       *     foo: "bar",
-       *     is_enabled: true
-       *   }
+   *     foo: "bar",
+   *     is_enabled: true
+   *   }
    */
   properties: Object;
 }
@@ -726,7 +726,9 @@ export namespace firestore {
     get: () => Promise<DocumentSnapshot>;
     update: (document: any) => Promise<void>;
     delete: () => Promise<void>;
+
     onSnapshot(callback: (doc: DocumentSnapshot) => void): () => void;
+
     android?: any;
     ios?: any;
   }