Refactor FUIAuth to split out email auth.

Author: Yue-Wang-Google

FirebaseAuthUI/FUIAuth.h

@@ -45,6 +45,20 @@ typedef void (^FUIAuthResultCallback)(FIRUser *_Nullable user, NSError *_Nullabl
 
 @optional
 
+/** @fn authUI:didSignInWithAuthDataResult:error:
+ @brief Message sent after the sign in process has completed to report the signed in user or
+ error encountered.
+ @param authUI The @c FUIAuth instance sending the message.
+ @param authDataResult The data result if the sign in attempt was successful.
+ @param url pass the deep link associated with an email link sign-in completion. It is useful
+ for the developer to access the state before the sign-in attempt was triggered.
+ @param error The error that occurred during sign in, if any.
+ */
+- (void)authUI:(FUIAuth *)authUI
+ didSignInWithAuthDataResult:(nullable FIRAuthDataResult *)authDataResult
+ URL:(nullable NSURL *)url
+ error:(nullable NSError *)error;
+
 /** @fn authUI:didSignInWithAuthDataResult:error:
  @brief Message sent after the sign in process has completed to report the signed in user or
  error encountered.
@@ -171,16 +185,6 @@ __attribute__((deprecated("Instead use authUI:didSignInWithAuthDataResult:error:
  */
 @property(nonatomic, copy) NSArray<id<FUIAuthProvider>> *providers;
 
-/** @property signInWithEmailHidden
- @brief Whether to hide the "Sign in with email" option, defaults to NO.
- */
-@property(nonatomic, assign, getter=isSignInWithEmailHidden) BOOL signInWithEmailHidden;
-
-/** @property allowNewEmailAccounts
- @brief Whether to allow new user sign, defaults to YES.
- */
-@property(nonatomic, assign) BOOL allowNewEmailAccounts;
-
 /** @property shouldHideCancelButton
  @brief Whether to hide the canel button, defaults to NO.
  */

FirebaseAuthUI/FUIAuth.m

@@ -396,7 +396,7 @@ - (void)decrementActivity {
 - (void)cancelAuthorization {
  [self dismissNavigationControllerAnimated:YES completion:^{
  NSError *error = [FUIAuthErrorUtils userCancelledSignInError];
- [self.authUI invokeResultCallbackWithAuthDataResult:nil error:error];
+ [self.authUI invokeResultCallbackWithAuthDataResult:nil URL:nil error:error];
  }];
 }
 

FirebaseAuthUI/FUIAuthBaseViewController.m

@@ -25,17 +25,6 @@
 #import "FUIEmailEntryViewController.h"
 #import "FUIPrivacyAndTermsOfServiceView.h"
 
-
-/** @var kErrorUserInfoEmailKey
- @brief The key for the email address in the userinfo dictionary of a sign in error.
- */
-static NSString *const kErrorUserInfoEmailKey = @"FIRAuthErrorUserInfoEmailKey";
-
-/** @var kEmailButtonAccessibilityID
- @brief The Accessibility Identifier for the @c email sign in button.
- */
-static NSString *const kEmailButtonAccessibilityID = @"EmailButtonAccessibilityID";
-
 /** @var kSignInButtonWidth
  @brief The width of the sign in buttons.
  */
@@ -98,10 +87,7 @@ - (void)viewDidLoad {
  action:nil];
 
  NSInteger numberOfButtons = self.authUI.providers.count;
- BOOL showEmailButton = !self.authUI.signInWithEmailHidden;
- if (showEmailButton) {
- ++numberOfButtons;
- }
+
  CGFloat buttonContainerViewHeight =
  kSignInButtonHeight * numberOfButtons + kSignInButtonVerticalMargin * (numberOfButtons);
  CGRect buttonContainerViewFrame = CGRectMake(0, 0, kSignInButtonWidth, buttonContainerViewHeight);
@@ -121,22 +107,6 @@ - (void)viewDidLoad {
  buttonFrame.origin.y += (kSignInButtonHeight + kSignInButtonVerticalMargin);
  }
 
- if (showEmailButton) {
- UIColor *emailButtonBackgroundColor =
- [UIColor colorWithRed:208.f/255.f green:2.f/255.f blue:27.f/255.f alpha:1.0];
- UIButton *emailButton =
- [[FUIAuthSignInButton alloc] initWithFrame:buttonFrame
- image:[FUIAuthUtils imageNamed:@"ic_email"
- fromBundle:FUIAuthBundleName]
- text:FUILocalizedString(kStr_SignInWithEmail)
- backgroundColor:emailButtonBackgroundColor
- textColor:[UIColor whiteColor]];
- [emailButton addTarget:self
- action:@selector(signInWithEmail)
- forControlEvents:UIControlEventTouchUpInside];
- emailButton.accessibilityIdentifier = kEmailButtonAccessibilityID;
- [_buttonContainerView addSubview:emailButton];
- }
  _privacyPolicyAndTOSView.authUI = self.authUI;
  [_privacyPolicyAndTOSView useFullMessage];
 }
@@ -154,16 +124,6 @@ - (void)viewDidLayoutSubviews {
 
 #pragma mark - Actions
 
-- (void)signInWithEmail {
- UIViewController *controller;
- if ([self.authUI.delegate respondsToSelector:@selector(emailEntryViewControllerForAuthUI:)]) {
- controller = [self.authUI.delegate emailEntryViewControllerForAuthUI:self.authUI];
- } else {
- controller = [[FUIEmailEntryViewController alloc] initWithAuthUI:self.authUI];
- }
- [self pushViewController:controller];
-}
-
 - (void)didTapSignInButton:(FUIAuthSignInButton *)button {
  [self.authUI signInWithProviderUI:button.providerUI
  presentingViewController:self

FirebaseAuthUI/FUIAuthPickerViewController.m

@@ -16,16 +16,49 @@
 
 #import "FUIAuth.h"
 
+@class FUIAuthBaseViewController;
+
+
+/** @typedef FUIEmailHintSignInCallback
+ @brief The type of block invoked when an emailHint sign-in event completes.
+
+ @param authResult Optionally; Result of sign-in request containing both the user and
+ the additional user info associated with the user.
+ @param error Optionally; the error which occurred - or nil if the request was successful.
+ @param credential Optionally; The credential used to sign-in.
+ */
+typedef void (^FUIEmailHintSignInCallback)(FIRAuthDataResult *_Nullable authResult,
+ NSError *_Nullable error,
+ FIRAuthCredential *_Nullable credential);
+
 NS_ASSUME_NONNULL_BEGIN
 
+
+
+@protocol FUIEmailAuthProvider <NSObject>
+
+- (void)handleAccountLinkingForEmail:(NSString *)email
+ newCredential:(FIRAuthCredential *)newCredential
+ presentingViewController:(UIViewController *)presentingViewController
+ signInResult:(_Nullable FIRAuthResultCallback)result;
+
+- (void)signInWithEmailHint:(NSString *)emailHint
+ presentingViewController:(FUIAuthBaseViewController *)presentingViewController
+ originalError:(NSError *)originalError
+ completion:(FUIEmailHintSignInCallback)completion;
+
+@end
+
 @interface FUIAuth ()
 
 /** @fn invokeResultCallbackWithAuthDataResult:error:
  @brief Invokes the auth UI result callback.
  @param authDataResult The sign in data result, if any.
+ @param url The url, if any.
  @param error The error which occurred, if any.
  */
 - (void)invokeResultCallbackWithAuthDataResult:(nullable FIRAuthDataResult *)authDataResult
+ URL:(nullable NSURL *)url
  error:(nullable NSError *)error;
 
 /** @fn invokeOperationCallback:error:
@@ -45,7 +78,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /** @fn signInWithProviderUI:presentingViewController:defaultValue:
  @brief Signs in with specified provider.
- @see FUIAuthDelegate.authUI:didSignInWithAuthDataResult:error: for method callback.
+ @see FUIAuthDelegate.authUI:didSignInWithAuthDataResult:URL:error: for method callback.
  @param providerUI The authentication provider used for signing in.
  @param presentingViewController The view controller used to present the UI.
  @param defaultValue The provider default initialization value (e.g. email or phone number)
@@ -55,6 +88,8 @@ NS_ASSUME_NONNULL_BEGIN
  presentingViewController:(UIViewController *)presentingViewController
  defaultValue:(nullable NSString *)defaultValue;
 
+@property(nonatomic, weak) id<FUIEmailAuthProvider> emailAuthProvider;
+
 @end
 
 NS_ASSUME_NONNULL_END

FirebaseAuthUI/FUIAuth_Internal.h

@@ -31,8 +31,3 @@ FOUNDATION_EXPORT const unsigned char FirebaseAuthUIVersionString[];
 #import "FUIAuthErrorUtils.h"
 #import "FUIAuthPickerViewController.h"
 #import "FUIAuthProvider.h"
-#import "FUIEmailEntryViewController.h"
-#import "FUIPasswordRecoveryViewController.h"
-#import "FUIPasswordSignInViewController.h"
-#import "FUIPasswordSignUpViewController.h"
-#import "FUIPasswordVerificationViewController.h"

FirebaseAuthUI/FirebaseAuthUI.h

@@ -87,6 +87,7 @@ This instance can then be configured with the providers you wish to support:
 import FirebaseUI
 
 let providers: [FUIAuthProvider] = [
+ FUIEmailAuth(),
  FUIGoogleAuth(),
  FUIFacebookAuth(),
  FUITwitterAuth(),
@@ -102,6 +103,7 @@ self.authUI?.providers = providers
 // ...
 
 NSArray<id<FUIAuthProvider>> *providers = @[
+ [[FUIEmailAuth alloc] init],
  [[FUIGoogleAuth alloc] init],
  [[FUIFacebookAuth alloc] init],
  [[FUITwitterAuth alloc] init],

FirebaseAuthUI/README.md

@@ -0,0 +1,89 @@
+//
+// Copyright (c) 2018 Email Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import "FUIAuthProvider.h"
+
+@class FUIAuth;
+@class FIRActionCodeSettings;
+@class FUIEmailEntryViewController;
+@class FUIPasswordSignInViewController;
+@class FUIPasswordSignUpViewController;
+@class FUIPasswordRecoveryViewController;
+@class FUIPasswordVerificationViewController;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** @class FUIEmailAuth
+ @brief AuthUI components for Email Sign In.
+ */
+@interface FUIEmailAuth : NSObject <FUIAuthProvider>
+
+- (instancetype)initAuthAuthUI:(FUIAuth *)authUI
+ signInMethod:(NSString *)signInMethod
+ forceSameDevice:(BOOL)forceSameDevice
+ allowNewEmailAccounts:(BOOL)allowNewEmailAccounts
+ actionCodeSetting:(FIRActionCodeSettings *)actionCodeSettings;
+
+
+/** @property signInMethod.
+ @brief Defines the sign in method for FIREmailAuthProvider.
+ This can be one of the following string constants:
+ - FIREmailLinkAuthSignInMethod
+ - FIREmailPasswordAuthSignInMethod (default).
+ */
+@property(nonatomic, copy, readonly) NSString *signInMethod;
+
+/** @property forceSameDevice.
+ @brief Whether to force same device flow. If not, opening the link on a different device will
+ display an error message. Note that this should be true when used with anonymous user
+ upgrade flows. The default is false.
+ */
+@property(nonatomic, assign, readonly) BOOL forceSameDevice;
+
+/** @property actionCodeSettings.
+ @brief Defines the FIRActionCodeSettings configuration to use when sending the link. This gives
+ the developer the ability to specify how the link can be handled, custom dynamic link,
+ additional state in the deep link, etc.
+ */
+@property(nonatomic, strong, readonly) FIRActionCodeSettings *actionCodeSettings;
+
+/** @property allowNewEmailAccounts
+ @brief Whether to allow new user sign, defaults to YES.
+ */
+@property(nonatomic, assign, readonly) BOOL allowNewEmailAccounts;
+
+/** @fn signInWithPresentingViewController:
+ @brief Signs in with email auth provider.
+ @see FUIAuthDelegate.authUI:didSignInWithAuthDataResult:URL:error: for method callback.
+ @param presentingViewController The view controller used to present the UI.
+ */
+- (void)signInWithPresentingViewController:(UIViewController *)presentingViewController
+__attribute__((deprecated("This is deprecated API and will be removed in a future release."
+ "Please use signInWithPresentingViewController:email:")));
+
+/** @fn signInWithPresentingViewController:email:
+ @brief Signs in with email auth provider.
+ @see FUIAuthDelegate.authUI:didSignInWithAuthDataResult:URL:error: for method callback.
+ @param presentingViewController The view controller used to present the UI.
+ @param email The default email address.
+ */
+- (void)signInWithPresentingViewController:(UIViewController *)presentingViewController
+ email:(nullable NSString *)email;
+
+
+@end
+
+NS_ASSUME_NONNULL_END