flow type defs for auth()

Author: Salakar

android/src/main/java/io/fullstack/firestack/FirestackAuth.java

@@ -627,7 +627,7 @@ private WritableMap getUserMap() {
       userMap.putString("uid", uid);
       userMap.putString("providerId", provider);
       userMap.putBoolean("emailVerified", verified);
-      
+
       if (name != null) {
         userMap.putString("name", name);
       }

lib/modules/auth.js

@@ -1,3 +1,4 @@
+// @flow
 import { NativeModules, NativeEventEmitter } from 'react-native';
 
 import { Base } from './base';
@@ -7,26 +8,30 @@ import promisify from '../utils/promisify';
 const FirestackAuth = NativeModules.FirestackAuth;
 const FirestackAuthEvt = new NativeEventEmitter(FirestackAuth);
 
+type AuthResultType = { authenticated: boolean, user: Object|null };
+
 export default class Auth extends Base {
-  constructor(firestack, options = {}) {
+  _user: User|null;
+  _authResult: AuthResultType | null;
+  authenticated: boolean;
+
+  constructor(firestack: Object, options: Object = {}) {
     super(firestack, options);
+    this._user = null;
     this._authResult = null;
     this.authenticated = false;
-    this._user = null;
 
     // start listening straight away
     // generally though the initial event fired will get ignored
     // but this is ok as we fake it with the getCurrentUser below
     FirestackAuth.listenForAuth();
 
-    this.getCurrentUser().then((u) => {
-      const authResult = { authenticated: !!u };
-      if (u) authResult.user = u;
-      this._onAuthStateChanged(authResult);
+    this.getCurrentUser().then((u: Object) => {
+      this._onAuthStateChanged({ authenticated: !!u, user: u || null });
       this._startListening();
     }).catch(() => {
       // todo check if error contains user disabled message maybe and add a disabled flag?
-      this._onAuthStateChanged({ authenticated: false });
+      this._onAuthStateChanged({ authenticated: false, user: null });
       this._startListening();
     });
   }
@@ -45,13 +50,13 @@ export default class Auth extends Base {
    * @param auth
    * @private
    */
-  _onAuthStateChanged(auth) {
+  _onAuthStateChanged(auth: AuthResultType) {
     this._authResult = auth;
-    this.emit('onAuthStateChanged', this._authResult.user || null);
     this.authenticated = auth ? auth.authenticated || false : false;
     if (auth && auth.user && !this._user) this._user = new User(this, auth);
     else if ((!auth || !auth.user) && this._user) this._user = null;
-    else this._user ? this._user._updateValues(auth) : null;
+    else if (this._user) this._user._updateValues(auth);
+    this.emit('onAuthStateChanged', this._authResult.user || null);
   }
 
   /*
@@ -62,7 +67,7 @@ export default class Auth extends Base {
    * Listen for auth changes.
    * @param listener
    */
-  onAuthStateChanged(listener) {
+  onAuthStateChanged(listener: Function) {
     this.log.info('Creating onAuthStateChanged listener');
     this.on('onAuthStateChanged', listener);
     if (this._authResult) listener(this._authResult.user || null);
@@ -72,7 +77,7 @@ export default class Auth extends Base {
    * Remove auth change listener
    * @param listener
    */
-  offAuthStateChanged(listener) {
+  offAuthStateChanged(listener: Function) {
     this.log.info('Removing onAuthStateChanged listener');
     this.removeListener('onAuthStateChanged', listener);
   }
@@ -83,7 +88,7 @@ export default class Auth extends Base {
    * @param  {string} password The user's password
    * @return {Promise}         A promise indicating the completion
    */
-  createUserWithEmailAndPassword(email, password) {
+  createUserWithEmailAndPassword(email: string, password: string): Promise<Object> {
     this.log.info('Creating user with email and password', email);
     return promisify('createUserWithEmail', FirestackAuth)(email, password);
   }
@@ -94,9 +99,9 @@ export default class Auth extends Base {
    * @param  {string} password The user's password
    * @return {Promise}         A promise that is resolved upon completion
    */
-  signInWithEmailAndPassword(email, password) {
+  signInWithEmailAndPassword(email: string, password: string): Promise<Object> {
     this.log.info('Signing in user with email and password', email);
-    return promisify('signInWithEmail', FirestackAuth)(email, password)
+    return promisify('signInWithEmail', FirestackAuth)(email, password);
   }
 
 
@@ -105,14 +110,14 @@ export default class Auth extends Base {
    * @param  {string} email The user's _new_ email
    * @return {Promise}       A promise resolved upon completion
    */
-  updateEmail(email) {
+  updateEmail(email: string): Promise<Object> {
     return promisify('updateUserEmail', FirestackAuth)(email);
   }
 
   /**
    * Send verification email to current user.
    */
-  sendEmailVerification() {
+  sendEmailVerification(): Promise<Object> {
     return promisify('sendEmailVerification', FirestackAuth)();
   }
 
@@ -121,7 +126,7 @@ export default class Auth extends Base {
    * @param  {string} password the new password
    * @return {Promise}
    */
-  updatePassword(password) {
+  updatePassword(password: string): Promise<Object> {
     return promisify('updateUserPassword', FirestackAuth)(password);
   }
 
@@ -130,7 +135,7 @@ export default class Auth extends Base {
    * @param  {Object} updates An object containing the keys listed [here](https://firebase.google.com/docs/auth/ios/manage-users#update_a_users_profile)
    * @return {Promise}
    */
-  updateProfile(updates) {
+  updateProfile(updates: Object = {}): Promise<Object> {
     return promisify('updateUserProfile', FirestackAuth)(updates);
   }
 
@@ -139,62 +144,63 @@ export default class Auth extends Base {
    * @param  {string} customToken  A self-signed custom auth token.
    * @return {Promise}             A promise resolved upon completion
    */
-  signInWithCustomToken(customToken) {
-    return promisify('signInWithCustomToken', FirestackAuth)(customToken)
+  signInWithCustomToken(customToken: string): Promise<Object> {
+    return promisify('signInWithCustomToken', FirestackAuth)(customToken);
   }
 
+  // TODO - below methods are not in web api / i think the're signInWithCredential
   /**
    * Sign the user in with a third-party authentication provider
    * @param  {string} provider   The name of the provider to use for login
    * @param  {string} authToken  The authToken granted by the provider
    * @param  {string} authSecret The authToken secret granted by the provider
    * @return {Promise}           A promise resolved upon completion
    */
-  signInWithProvider(provider, authToken, authSecret) {
-    return promisify('signInWithProvider', FirestackAuth)(provider, authToken, authSecret)
+  signInWithProvider(provider: string, authToken: string, authSecret: string): Promise<Object> {
+    return promisify('signInWithProvider', FirestackAuth)(provider, authToken, authSecret);
   }
 
   /**
-   * Reauthenticate a user with a third-party authentication provider
+   * Re-authenticate a user with a third-party authentication provider
    * @param  {string} provider The provider name
    * @param  {string} token    The authToken granted by the provider
    * @param  {string} secret   The authTokenSecret granted by the provider
    * @return {Promise}         A promise resolved upon completion
    */
-  reauthenticateWithCredentialForProvider(provider, token, secret) {
-    return promisify('reauthenticateWithCredentialForProvider', FirestackAuth)(provider, token, secret)
+  reauthenticateWithCredentialForProvider(provider: string, token: string, secret: string): Promise<Object> {
+    return promisify('reauthenticateWithCredentialForProvider', FirestackAuth)(provider, token, secret);
   }
 
 
   /**
    * Sign a user in anonymously
    * @return {Promise}            A promise resolved upon completion
    */
-  signInAnonymously() {
+  signInAnonymously(): Promise<Object> {
     return promisify('signInAnonymously', FirestackAuth)();
   }
 
   /**
    * Send reset password instructions via email
    * @param {string} email The email to send password reset instructions
    */
-  sendPasswordResetWithEmail(email) {
+  sendPasswordResetWithEmail(email: string): Promise<Object> {
     return promisify('sendPasswordResetWithEmail', FirestackAuth)(email);
   }
 
   /**
    * Delete the current user
    * @return {Promise}
    */
-  deleteUser() {
+  deleteUser(): Promise<Object> {
     return promisify('deleteUser', FirestackAuth)();
   }
 
   /**
    * get the token of current user
    * @return {Promise}
    */
-  getToken() {
+  getToken(): Promise<Object> {
     return promisify('getToken', FirestackAuth)();
   }
 
@@ -203,27 +209,27 @@ export default class Auth extends Base {
    * Sign the current user out
    * @return {Promise}
    */
-  signOut() {
+  signOut(): Promise<Object> {
     return promisify('signOut', FirestackAuth)();
   }
 
   /**
    * Get the currently signed in user
    * @return {Promise}
    */
-  getCurrentUser() {
+  getCurrentUser(): Promise<Object> {
     return promisify('getCurrentUser', FirestackAuth)();
   }
 
   /**
    * Get the currently signed in user
    * @return {Promise}
    */
-  get currentUser() {
+  get currentUser(): User|null {
     return this._user;
   }
 
-  get namespace() {
+  get namespace(): string {
     return 'firestack:auth';
   }
 }