Auth - no typedefs in public APIs (#6283)

paulb777 · web-flow · commit f4ee16044775 · 2020-08-18T14:42:33.000-07:00
diff --git a/FirebaseAuth/CHANGELOG.md b/FirebaseAuth/CHANGELOG.md
@@ -1,6 +1,7 @@
 # v6.9.0
 - [added] Added support for multi-tenancy (#6142).
 - [added] Added basic watchOS support. (#4621)
+- [channged] Improved Xcode completion of public API completion handlers in Swift. (#6283)
 
 # v6.8.0
 - [fixed] Fix bug where multiple keychain entries would result in user persistence failure. (#5906)
diff --git a/FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuth.h b/FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuth.h
@@ -385,14 +385,16 @@ NS_SWIFT_NAME(Auth)
     @param completion Optionally; a block invoked after the user of the calling Auth instance has
         been updated or an error was encountered.
  */
-- (void)updateCurrentUser:(FIRUser *)user completion:(nullable FIRUserUpdateCallback)completion;
+- (void)updateCurrentUser:(FIRUser *)user
+               completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 /** @fn fetchProvidersForEmail:completion:
     @brief Please use fetchSignInMethodsForEmail:completion: for Objective-C or
         fetchSignInMethods(forEmail:completion:) for Swift instead.
  */
 - (void)fetchProvidersForEmail:(NSString *)email
-                    completion:(nullable FIRProviderQueryCallback)completion
+                    completion:(nullable void (^)(NSArray<NSString *> *_Nullable providers,
+                                                  NSError *_Nullable error))completion
     DEPRECATED_MSG_ATTRIBUTE("Please use fetchSignInMethodsForEmail:completion: for Objective-C or "
                              "fetchSignInMethods(forEmail:completion:) for Swift instead.");
 
@@ -412,7 +414,8 @@ NS_SWIFT_NAME(Auth)
  */
 
 - (void)fetchSignInMethodsForEmail:(NSString *)email
-                        completion:(nullable FIRSignInMethodQueryCallback)completion;
+                        completion:(nullable void (^)(NSArray<NSString *> *_Nullable,
+                                                      NSError *_Nullable))completion;
 
 /** @fn signInWithEmail:password:completion:
     @brief Signs in using an email address and password.
@@ -437,7 +440,8 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)signInWithEmail:(NSString *)email
                password:(NSString *)password
-             completion:(nullable FIRAuthDataResultCallback)completion;
+             completion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                           NSError *_Nullable error))completion;
 
 /** @fn signInWithEmail:link:completion:
     @brief Signs in using an email address and email sign-in link.
@@ -461,7 +465,9 @@ NS_SWIFT_NAME(Auth)
 
 - (void)signInWithEmail:(NSString *)email
                    link:(NSString *)link
-             completion:(nullable FIRAuthDataResultCallback)completion API_UNAVAILABLE(watchos);
+             completion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                           NSError *_Nullable error))completion
+    API_UNAVAILABLE(watchos);
 
 /** @fn signInWithProvider:UIDelegate:completion:
     @brief Signs in using the provided auth provider instance.
@@ -509,14 +515,18 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)signInWithProvider:(id<FIRFederatedAuthProvider>)provider
                 UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
-                completion:(nullable FIRAuthDataResultCallback)completion API_UNAVAILABLE(watchos);
+                completion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                              NSError *_Nullable error))completion
+    API_UNAVAILABLE(watchos);
 
 /** @fn signInAndRetrieveDataWithCredential:completion:
     @brief Please use signInWithCredential:completion: for Objective-C or "
         "signIn(with:completion:) for Swift instead.
  */
 - (void)signInAndRetrieveDataWithCredential:(FIRAuthCredential *)credential
-                                 completion:(nullable FIRAuthDataResultCallback)completion
+                                 completion:
+                                     (nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                                        NSError *_Nullable error))completion
     DEPRECATED_MSG_ATTRIBUTE("Please use signInWithCredential:completion: for Objective-C or "
                              "signIn(with:completion:) for Swift instead.");
 
@@ -559,7 +569,8 @@ NS_SWIFT_NAME(Auth)
     @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods
 */
 - (void)signInWithCredential:(FIRAuthCredential *)credential
-                  completion:(nullable FIRAuthDataResultCallback)completion;
+                  completion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                                NSError *_Nullable error))completion;
 
 /** @fn signInAnonymouslyWithCompletion:
     @brief Asynchronously creates and becomes an anonymous user.
@@ -576,7 +587,8 @@ NS_SWIFT_NAME(Auth)
 
     @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
  */
-- (void)signInAnonymouslyWithCompletion:(nullable FIRAuthDataResultCallback)completion;
+- (void)signInAnonymouslyWithCompletion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                                           NSError *_Nullable error))completion;
 
 /** @fn signInWithCustomToken:completion:
     @brief Asynchronously signs in to Firebase with the given Auth token.
@@ -595,7 +607,8 @@ NS_SWIFT_NAME(Auth)
     @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
  */
 - (void)signInWithCustomToken:(NSString *)token
-                   completion:(nullable FIRAuthDataResultCallback)completion;
+                   completion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                                 NSError *_Nullable error))completion;
 
 /** @fn createUserWithEmail:password:completion:
     @brief Creates and, on success, signs in a user with the given email address and password.
@@ -621,7 +634,8 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)createUserWithEmail:(NSString *)email
                    password:(NSString *)password
-                 completion:(nullable FIRAuthDataResultCallback)completion;
+                 completion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
+                                               NSError *_Nullable error))completion;
 
 /** @fn confirmPasswordResetWithCode:newPassword:completion:
     @brief Resets the password given a code sent to the user outside of the app and a new password
@@ -644,7 +658,7 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)confirmPasswordResetWithCode:(NSString *)code
                          newPassword:(NSString *)newPassword
-                          completion:(FIRConfirmPasswordResetCallback)completion;
+                          completion:(void (^)(NSError *_Nullable error))completion;
 
 /** @fn checkActionCode:completion:
     @brief Checks the validity of an out of band code.
@@ -663,7 +677,8 @@ NS_SWIFT_NAME(Auth)
         asynchronously on the main thread in the future.
  */
 - (void)verifyPasswordResetCode:(NSString *)code
-                     completion:(FIRVerifyPasswordResetCodeCallback)completion;
+                     completion:
+                         (void (^)(NSString *_Nullable email, NSError *_Nullable error))completion;
 
 /** @fn applyActionCode:completion:
     @brief Applies out of band code.
@@ -675,7 +690,7 @@ NS_SWIFT_NAME(Auth)
     @remarks This method will not work for out of band codes which require an additional parameter,
         such as password reset code.
  */
-- (void)applyActionCode:(NSString *)code completion:(FIRApplyActionCodeCallback)completion;
+- (void)applyActionCode:(NSString *)code completion:(void (^)(NSError *_Nullable error))completion;
 
 /** @fn sendPasswordResetWithEmail:completion:
     @brief Initiates a password reset for the given email address.
@@ -696,7 +711,7 @@ NS_SWIFT_NAME(Auth)
 
  */
 - (void)sendPasswordResetWithEmail:(NSString *)email
-                        completion:(nullable FIRSendPasswordResetCallback)completion;
+                        completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 /** @fn sendPasswordResetWithEmail:actionCodeSetting:completion:
     @brief Initiates a password reset for the given email address and @FIRActionCodeSettings object.
@@ -728,7 +743,7 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)sendPasswordResetWithEmail:(NSString *)email
                 actionCodeSettings:(FIRActionCodeSettings *)actionCodeSettings
-                        completion:(nullable FIRSendPasswordResetCallback)completion;
+                        completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 /** @fn sendSignInLinkToEmail:actionCodeSettings:completion:
     @brief Sends a sign in with email link to provided email address.
@@ -741,7 +756,7 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)sendSignInLinkToEmail:(NSString *)email
            actionCodeSettings:(FIRActionCodeSettings *)actionCodeSettings
-                   completion:(nullable FIRSendSignInLinkToEmailCallback)completion
+                   completion:(nullable void (^)(NSError *_Nullable error))completion
     API_UNAVAILABLE(watchos);
 
 /** @fn signOut:
@@ -757,8 +772,6 @@ NS_SWIFT_NAME(Auth)
             keychain. The `NSLocalizedFailureReasonErrorKey` field in the `NSError.userInfo`
             dictionary will contain more information about the error encountered.
 
-
-
  */
 - (BOOL)signOut:(NSError *_Nullable *_Nullable)error;
 
@@ -788,8 +801,9 @@ NS_SWIFT_NAME(Auth)
 
     @return A handle useful for manually unregistering the block as a listener.
  */
+
 - (FIRAuthStateDidChangeListenerHandle)addAuthStateDidChangeListener:
-    (FIRAuthStateDidChangeListenerBlock)listener;
+    (void (^)(FIRAuth *auth, FIRUser *_Nullable user))listener;
 
 /** @fn removeAuthStateDidChangeListener:
     @brief Unregisters a block as an "auth state did change" listener.
@@ -818,7 +832,7 @@ NS_SWIFT_NAME(Auth)
     @return A handle useful for manually unregistering the block as a listener.
  */
 - (FIRIDTokenDidChangeListenerHandle)addIDTokenDidChangeListener:
-    (FIRIDTokenDidChangeListenerBlock)listener;
+    (void (^)(FIRAuth *auth, FIRUser *_Nullable user))listener;
 
 /** @fn removeIDTokenDidChangeListener:
     @brief Unregisters a block as an "ID token did change" listener.
diff --git a/FirebaseAuth/Sources/Public/FirebaseAuth/FIRFederatedAuthProvider.h b/FirebaseAuth/Sources/Public/FirebaseAuth/FIRFederatedAuthProvider.h
@@ -47,7 +47,8 @@ typedef void (^FIRAuthCredentialCallback)(FIRAuthCredential *_Nullable credentia
         the mobile web flow is completed.
  */
 - (void)getCredentialWithUIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
-                         completion:(nullable FIRAuthCredentialCallback)completion;
+                         completion:(nullable void (^)(FIRAuthCredential *_Nullable credential,
+                                                       NSError *_Nullable error))completion;
 #endif  // TARGET_OS_IOS
 
 @end
diff --git a/FirebaseAuth/Sources/Public/FirebaseAuth/FIRGameCenterAuthProvider.h b/FirebaseAuth/Sources/Public/FirebaseAuth/FIRGameCenterAuthProvider.h
@@ -51,7 +51,8 @@ NS_SWIFT_NAME(GameCenterAuthProvider)
 /** @fn getCredentialWithCompletion:
     @brief Creates a @c FIRAuthCredential for a Game Center sign in.
  */
-+ (void)getCredentialWithCompletion:(FIRGameCenterCredentialCallback)completion
++ (void)getCredentialWithCompletion:
+    (void (^)(FIRAuthCredential *_Nullable credential, NSError *_Nullable error))completion
     NS_SWIFT_NAME(getCredential(completion:));
 
 /** @fn init
diff --git a/FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactor.h b/FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactor.h
@@ -54,7 +54,8 @@ NS_SWIFT_NAME(MultiFactor)
     @param completion A block with the session identifier for a second factor enrollment operation.
         This is used to identify the current user trying to enroll a second factor.
 */
-- (void)getSessionWithCompletion:(nullable FIRMultiFactorSessionCallback)completion;
+- (void)getSessionWithCompletion:(nullable void (^)(FIRMultiFactorSession *_Nullable credential,
+                                                    NSError *_Nullable error))completion;
 
 /** @fn enrollWithAssertion:displayName:completion:
     @brief Enrolls a second factor as identified by the `FIRMultiFactorAssertion` parameter for the
@@ -64,23 +65,23 @@ NS_SWIFT_NAME(MultiFactor)
 */
 - (void)enrollWithAssertion:(FIRMultiFactorAssertion *)assertion
                 displayName:(nullable NSString *)displayName
-                 completion:(nullable FIRAuthVoidErrorCallback)completion;
+                 completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 /** @fn unenrollWithInfo:completion:
     @brief Unenroll the given multi factor.
     @param completion The block invoked when the request to send the verification email is complete,
         or fails.
 */
 - (void)unenrollWithInfo:(FIRMultiFactorInfo *)factorInfo
-              completion:(nullable FIRAuthVoidErrorCallback)completion;
+              completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 /** @fn unenrollWithFactorUID:completion:
     @brief Unenroll the given multi factor.
     @param completion The block invoked when the request to send the verification email is complete,
         or fails.
 */
 - (void)unenrollWithFactorUID:(NSString *)factorUID
-                   completion:(nullable FIRAuthVoidErrorCallback)completion;
+                   completion:(nullable void (^)(NSError *_Nullable error))completion;
 
 @end
 
diff --git a/FirebaseAuth/Sources/Public/FirebaseAuth/FIRPhoneAuthProvider.h b/FirebaseAuth/Sources/Public/FirebaseAuth/FIRPhoneAuthProvider.h
@@ -113,7 +113,9 @@ NS_SWIFT_NAME(PhoneAuthProvider)
 - (void)verifyPhoneNumberWithMultiFactorInfo:(FIRPhoneMultiFactorInfo *)phoneMultiFactorInfo
                                   UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
                           multiFactorSession:(nullable FIRMultiFactorSession *)session
-                                  completion:(nullable FIRVerificationResultCallback)completion;
+                                  completion:
+                                      (nullable void (^)(NSString *_Nullable verificationID,
+                                                         NSError *_Nullable error))completion;
 
 /** @fn credentialWithVerificationID:verificationCode:
     @brief Creates an `FIRAuthCredential` for the phone number provider identified by the
diff --git a/FirebaseAuth/Sources/Public/FirebaseAuth/FIRUser.h b/FirebaseAuth/Sources/Public/FirebaseAuth/FIRUser.h
