react-native-firebase/lib/modules/auth/index.js

349 lines
11 KiB
JavaScript
Raw Normal View History

2017-02-14 11:41:27 +00:00
// @flow
import User from './user';
import ModuleBase from './../../utils/ModuleBase';
import INTERNALS from './../../internals';
2017-08-25 11:16:23 +00:00
import ConfirmationResult from './ConfirmationResult';
// providers
import EmailAuthProvider from './providers/EmailAuthProvider';
2017-09-24 12:57:59 +00:00
import PhoneAuthProvider from './providers/PhoneAuthProvider';
import GoogleAuthProvider from './providers/GoogleAuthProvider';
import GithubAuthProvider from './providers/GithubAuthProvider';
import TwitterAuthProvider from './providers/TwitterAuthProvider';
import FacebookAuthProvider from './providers/FacebookAuthProvider';
2017-09-24 12:57:59 +00:00
import PhoneAuthListener from './PhoneAuthListener';
2017-02-14 11:41:27 +00:00
export default class Auth extends ModuleBase {
static _NAMESPACE = 'auth';
static _NATIVE_MODULE = 'RNFirebaseAuth';
_user: User | null;
2017-09-25 20:29:40 +00:00
_native: Object;
_getAppEventName: Function;
2017-02-14 11:41:27 +00:00
_authResult: AuthResultType | null;
authenticated: boolean;
constructor(firebaseApp: Object, options: Object = {}) {
super(firebaseApp, options, true);
2017-02-14 11:41:27 +00:00
this._user = null;
this._authResult = null;
this.authenticated = false;
this.addListener(
// sub to internal native event - this fans out to
2017-09-21 15:48:54 +00:00
// public event name: onAuthStateChanged
this._getAppEventName('auth_state_changed'),
this._onAuthStateChanged.bind(this),
);
this.addListener(
// sub to internal native event - this fans out to
// public events based on event.type
this._getAppEventName('phone_auth_state_changed'),
this._onPhoneAuthStateChanged.bind(this),
);
2017-09-21 15:48:54 +00:00
this.addListener(
// sub to internal native event - this fans out to
// public event name: onIdTokenChanged
this._getAppEventName('auth_id_token_changed'),
this._onIdTokenChanged.bind(this),
);
this._native.addAuthStateListener();
2017-09-21 15:48:54 +00:00
this._native.addIdTokenListener();
2017-02-14 11:41:27 +00:00
}
/**
* Route a phone state change event to the correct listeners
* @param event
* @private
*/
_onPhoneAuthStateChanged(event: Object) {
const eventKey = `phone:auth:${event.requestKey}:${event.type}`;
this.emit(eventKey, event.state);
}
2017-02-14 11:41:27 +00:00
/**
* Internal auth changed listener
* @param auth
* @param emit
2017-02-14 11:41:27 +00:00
* @private
*/
2017-03-17 23:40:12 +00:00
_onAuthStateChanged(auth: AuthResultType, emit: boolean = true) {
2017-02-14 11:41:27 +00:00
this._authResult = auth;
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 if (this._user) this._user._updateValues(auth);
2017-09-21 15:48:54 +00:00
if (emit) this.emit(this._getAppEventName('onAuthStateChanged'), this._user);
return auth ? this._user : null;
}
/**
* Remove auth change listener
* @param listener
*/
_offAuthStateChanged(listener: Function) {
this.log.info('Removing onAuthStateChanged listener');
2017-09-21 15:48:54 +00:00
this.removeListener(this._getAppEventName('onAuthStateChanged'), listener);
}
/**
* Internal auth changed listener
* @param auth
* @param emit
* @private
*/
_onIdTokenChanged(auth: AuthResultType, emit: boolean = true) {
this._authResult = auth;
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 if (this._user) this._user._updateValues(auth);
if (emit) this.emit(this._getAppEventName('onIdTokenChanged'), this._user);
return auth ? this._user : null;
}
/**
* Remove id token change listener
* @param listener
*/
_offIdTokenChanged(listener: Function) {
this.log.info('Removing onIdTokenChanged listener');
this.removeListener(this._getAppEventName('onIdTokenChanged'), listener);
}
/**
* Intercept all user actions and send their results to
* auth state change before resolving
* @param promise
* @returns {Promise.<*>}
* @private
*/
_interceptUserValue(promise) {
return promise.then((result) => {
if (!result) return this._onAuthStateChanged(null, false);
if (result.user) return this._onAuthStateChanged(result, false);
2017-03-17 23:40:12 +00:00
if (result.uid) return this._onAuthStateChanged({ authenticated: true, user: result }, false);
return result;
});
2017-02-14 11:41:27 +00:00
}
/*
* WEB API
*/
/**
* Listen for auth changes.
* @param listener
*/
onAuthStateChanged(listener: Function) {
this.log.info('Creating onAuthStateChanged listener');
2017-09-21 15:48:54 +00:00
this.on(this._getAppEventName('onAuthStateChanged'), listener);
2017-06-13 01:09:12 +00:00
if (this._authResult) listener(this._user || null);
2017-02-14 11:41:27 +00:00
return this._offAuthStateChanged.bind(this, listener);
}
2017-09-21 15:48:54 +00:00
/**
* Listen for id token changes.
* @param listener
*/
onIdTokenChanged(listener: Function) {
this.log.info('Creating onIdTokenChanged listener');
this.on(this._getAppEventName('onIdTokenChanged'), listener);
if (this._authResult) listener(this._user || null);
return this._offIdTokenChanged.bind(this, listener);
}
2017-02-14 11:41:27 +00:00
/**
* Sign the current user out
* @return {Promise}
2017-02-14 11:41:27 +00:00
*/
signOut(): Promise<null> {
return this._interceptUserValue(this._native.signOut());
2017-02-14 11:41:27 +00:00
}
/**
* Sign a user in anonymously
* @return {Promise} A promise resolved upon completion
*/
signInAnonymously(): Promise<Object> {
return this._interceptUserValue(this._native.signInAnonymously());
}
2017-02-14 11:41:27 +00:00
/**
* Create a user with the email/password functionality
* @param {string} email The user's email
* @param {string} password The user's password
* @return {Promise} A promise indicating the completion
*/
createUserWithEmailAndPassword(email: string, password: string): Promise<Object> {
return this._interceptUserValue(this._native.createUserWithEmailAndPassword(email, password));
2017-02-14 11:41:27 +00:00
}
/**
* Sign a user in with email/password
* @param {string} email The user's email
* @param {string} password The user's password
* @return {Promise} A promise that is resolved upon completion
*/
signInWithEmailAndPassword(email: string, password: string): Promise<Object> {
return this._interceptUserValue(this._native.signInWithEmailAndPassword(email, password));
2017-02-14 11:41:27 +00:00
}
/**
* Sign the user in with a custom auth token
* @param {string} customToken A self-signed custom auth token.
* @return {Promise} A promise resolved upon completion
*/
signInWithCustomToken(customToken: string): Promise<Object> {
return this._interceptUserValue(this._native.signInWithCustomToken(customToken));
2017-02-14 11:41:27 +00:00
}
/**
* Sign the user in with a third-party authentication provider
* @return {Promise} A promise resolved upon completion
*/
signInWithCredential(credential: CredentialType): Promise<Object> {
return this._interceptUserValue(
this._native.signInWithCredential(
credential.providerId, credential.token, credential.secret,
),
);
2017-02-14 11:41:27 +00:00
}
2017-08-25 11:16:23 +00:00
/**
* Asynchronously signs in using a phone number.
*
*/
signInWithPhoneNumber(phoneNumber: string): Promise<Object> {
return this._native.signInWithPhoneNumber(phoneNumber).then((result) => {
return new ConfirmationResult(this, result.verificationId);
});
}
2017-09-24 12:57:59 +00:00
/**
* Returns a PhoneAuthListener to listen to phone verification events,
* on the final completion event a PhoneAuthCredential can be generated for
* authentication purposes.
*
* @param phoneNumber
* @param autoVerifyTimeout Android Only
* @returns {PhoneAuthListener}
*/
verifyPhoneNumber(phoneNumber: string, autoVerifyTimeout?: number): PhoneAuthListener {
return new PhoneAuthListener(this, phoneNumber, autoVerifyTimeout);
}
2017-02-14 11:41:27 +00:00
/**
* Send reset password instructions via email
* @param {string} email The email to send password reset instructions
*/
sendPasswordResetEmail(email: string): Promise<Object> {
return this._native.sendPasswordResetEmail(email);
2017-02-14 11:41:27 +00:00
}
/**
* Completes the password reset process, given a confirmation code and new password.
*
* @link https://firebase.google.com/docs/reference/js/firebase.auth.Auth#confirmPasswordReset
* @param code
* @param newPassword
* @return {Promise.<Null>}
*/
2017-09-25 20:29:40 +00:00
confirmPasswordReset(code: string, newPassword: string): Promise<null> {
return this._native.confirmPasswordReset(code, newPassword);
}
/**
* Applies a verification code sent to the user by email or other out-of-band mechanism.
*
* @link https://firebase.google.com/docs/reference/js/firebase.auth.Auth#applyActionCode
* @param code
* @return {Promise.<Null>}
*/
2017-09-25 20:29:40 +00:00
applyActionCode(code: string): Promise<any> {
return this._native.applyActionCode(code);
}
/**
* Checks a verification code sent to the user by email or other out-of-band mechanism.
*
* @link https://firebase.google.com/docs/reference/js/firebase.auth.Auth#checkActionCode
* @param code
2017-09-25 20:29:40 +00:00
* @return {Promise.<any>|Promise<ActionCodeInfo>}
*/
2017-09-25 20:29:40 +00:00
checkActionCode(code: string): Promise<any> {
return this._native.checkActionCode(code);
}
2017-02-14 11:41:27 +00:00
/**
* Get the currently signed in user
* @return {Promise}
*/
getCurrentUser(): Promise<Object> {
return this._interceptUserValue(this._native.getCurrentUser());
2017-02-14 11:41:27 +00:00
}
/**
* Returns a list of authentication providers that can be used to sign in a given user (identified by its main email address).
* @return {Promise}
*/
fetchProvidersForEmail(email: string): Promise<Array<String>> {
return this._native.fetchProvidersForEmail(email);
}
2017-02-14 11:41:27 +00:00
/**
* Get the currently signed in user
* @return {Promise}
*/
get currentUser(): User | null {
2017-02-14 11:41:27 +00:00
return this._user;
}
get namespace(): string {
return 'firebase:auth';
}
/**
* KNOWN UNSUPPORTED METHODS
*/
getRedirectResult() {
throw new Error(INTERNALS.STRINGS.ERROR_UNSUPPORTED_MODULE_METHOD(Auth, 'getRedirectResult'));
}
setPersistence() {
throw new Error(INTERNALS.STRINGS.ERROR_UNSUPPORTED_MODULE_METHOD(Auth, 'setPersistence'));
}
signInAndRetrieveDataWithCredential() {
throw new Error(INTERNALS.STRINGS.ERROR_UNSUPPORTED_MODULE_METHOD(Auth, 'signInAndRetrieveDataWithCredential'));
}
signInWithPopup() {
throw new Error(INTERNALS.STRINGS.ERROR_UNSUPPORTED_MODULE_METHOD(Auth, 'signInWithPopup'));
}
signInWithRedirect() {
throw new Error(INTERNALS.STRINGS.ERROR_UNSUPPORTED_MODULE_METHOD(Auth, 'signInWithRedirect'));
}
2017-02-14 11:41:27 +00:00
}
2017-03-27 18:11:26 +00:00
export const statics = {
EmailAuthProvider,
PhoneAuthProvider,
GoogleAuthProvider,
2017-03-27 18:11:26 +00:00
GithubAuthProvider,
TwitterAuthProvider,
FacebookAuthProvider,
2017-09-24 12:57:59 +00:00
PhoneAuthState: {
CODE_SENT: 'sent',
AUTO_VERIFY_TIMEOUT: 'timeout',
2017-09-24 12:57:59 +00:00
AUTO_VERIFIED: 'verified',
ERROR: 'error',
},
2017-03-27 18:11:26 +00:00
};