feat:0.1.2 add apple and credential sign in

Author: funwithflutter

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.1.2
+
+- feat: add sign in with apple support
+- feat: add sign in with credential support for other identity providers
+- docs: documentation updates
+
 # 0.1.1
 
 - feat: add `isSubmitting()` extension to `BuildContext`. To determine if an authentication request is currently active

README.md

@@ -11,10 +11,10 @@ Pre-lit Firebase authentication. It provides a set of convenient utilities and w
 
 - **Multiple platform support**
   - Works on mobile and web. No changes needed
-  - Windows, macOS and Linux to be added soon
+  - Windows, macOS and Linux to be added in the future
 - **Multiple authentication providers**
-  - Enable third party providers (Google)
-  - More to be added soon
+  - Package supported: Google and Apple
+  - Please see Authentication Providers[Authentication Providers](#authentication-providers) for other sign-in providers
 - **Services and state managed for you**
   - Easily interact with Firebase from anywhere in your app
   - Monitor the auth state and react to changes
@@ -123,6 +123,15 @@ class MyApp extends StatelessWidget {
         emailAndPassword: true, // enabled by default
         google: true,
         anonymous: true,
+        apple: AppleAuthProvider(
+          // required for web-based authentication flows (Android)
+          webAuthenticationOptions: WebAuthenticationOptions(
+            clientId: 'com.aboutyou.dart_packages.sign_in_with_apple.example', // example clientId
+            redirectUri: Uri.parse(
+              'https://flutter-sign-in-with-apple-example.glitch.me/callbacks/sign_in_with_apple', // example redirectUri
+            ),
+          ),
+        ),
       ),
       child: MaterialApp(
         title: 'Material App',
@@ -230,6 +239,22 @@ context.getSignedInUser()
  }
  ```
 
+## Authentication Providers
+For the time being, Lit Firebase auth will only directly provide Google and Apple sign in.
+
+**NOTE:** Apple requires Apple sign in to be a sign-in option if any other third-party sign-in option is used.
+
+Other identity providers (Facebook, Github, etc.) will need to be implemented seperately. After successful third party sign in, you can sign in to Firebase by making use of the `signInWithCredential` method available on `BuildContext`.
+
+For example:
+
+```dart
+ Widget build(BuildContext context) {
+   AuthCredential credential = // get credential for identity provider (Facebook, Github, etc.)
+   context.signInWithCredential(credential);
+ }
+ ```
+
 ## Decoration and theming
 The UI can be as customizable as you need. But for simple usage it's fairly straight forward.
 

example/lib/main.dart

@@ -12,6 +12,15 @@ class MyApp extends StatelessWidget {
         emailAndPassword: true, // enabled by default
         google: true,
         anonymous: true,
+        // apple: AppleAuthProvider(
+        //   // required for web-based authentication flows
+        //   webAuthenticationOptions: WebAuthenticationOptions(
+        //     clientId: 'com.aboutyou.dart_packages.sign_in_with_apple.example',
+        //     redirectUri: Uri.parse(
+        //       'https://flutter-sign-in-with-apple-example.glitch.me/callbacks/sign_in_with_apple',
+        //     ),
+        //   ),
+        // ),
       ),
       child: MaterialApp(
         title: 'Material App',
@@ -33,9 +42,6 @@ class SplashScreen extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-// LitAuth.custom(
-//   child: CustomSignInWidget(),
-// );
     return Scaffold(
       body: Center(
         child: SingleChildScrollView(
@@ -130,6 +136,11 @@ class CustomSignInWidget extends StatelessWidget {
                 },
                 child: Text('Anony Sign In'),
               ),
+              SignInWithAppleButton(
+                onPressed: () {
+                  context.signInWithApple();
+                },
+              ),
             ],
           ),
         ),

example/pubspec.lock

@@ -211,7 +211,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.1.1"
+    version: "0.1.2"
   matcher:
     dependency: transitive
     description:
@@ -268,6 +268,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "2.1.3"
+  sign_in_with_apple:
+    dependency: transitive
+    description:
+      name: sign_in_with_apple
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.5.2"
   sky_engine:
     dependency: transitive
     description: flutter

lib/lit_firebase_auth.dart

@@ -1,3 +1,5 @@
+export 'package:sign_in_with_apple/sign_in_with_apple.dart';
+
 export 'src/domain/auth/auth_providers.dart';
 export 'src/domain/auth/i_auth_facade.dart';
 export 'src/infrastructure/firebase_auth_facade.dart';

lib/src/application/auth/sign_in_handler/sign_in_handler_state_notifier.dart

@@ -67,6 +67,27 @@ class SignInHandlerStateNotifier extends StateNotifier<SignInHandlerState>
     }
   }
 
+  Future<void> signInWithApple() async {
+    if (_authProviders.apple == null) {
+      throw AuthProviderNotEnabled('Apple');
+    }
+    state = state.copyWith(
+      isSubmitting: true,
+      authFailureOrSuccessOption: none(),
+    );
+
+    final auth = await _authFacade.signInWithApple(
+      webAuthenticationOptions: _authProviders.apple.webAuthenticationOptions,
+    );
+
+    if (mounted) {
+      state = state.copyWith(
+        isSubmitting: false,
+        authFailureOrSuccessOption: some(auth),
+      );
+    }
+  }
+
   Future<void> signInWithCredential(AuthCredential credential) async {
     state = state.copyWith(
       isSubmitting: true,

lib/src/domain/auth/auth_providers.dart

@@ -1,4 +1,5 @@
 import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:sign_in_with_apple/sign_in_with_apple.dart';
 
 part 'auth_providers.freezed.dart';
 
@@ -8,12 +9,26 @@ part 'auth_providers.freezed.dart';
 ///
 /// [emailAndPassword] defaults to enabled. The rest are disabled by default.
 ///
-/// You will receive an [AuthProviderNotEnabled] exception a you try to use
+/// You will receive an [AuthProviderNotEnabled] exception if you try to use
 /// an authentication provider that is not enabled here.
 abstract class AuthProviders with _$AuthProviders {
   const factory AuthProviders({
     @Default(true) bool emailAndPassword,
     @Default(false) bool anonymous,
     @Default(false) bool google,
+    AppleAuthProvider apple,
   }) = _AuthProviders;
 }
+
+abstract class AuthProvider {}
+
+class AppleAuthProvider extends AuthProvider {
+  /// Parameters required for web-based authentication flows
+  ///
+  /// As described in https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_js/incorporating_sign_in_with_apple_into_other_platforms
+  final WebAuthenticationOptions webAuthenticationOptions;
+
+  AppleAuthProvider({
+    this.webAuthenticationOptions,
+  });
+}

lib/src/domain/auth/auth_providers.freezed.dart

@@ -1,5 +1,6 @@
 import 'package:firebase_auth/firebase_auth.dart';
 import 'package:flutter/foundation.dart';
+import 'package:sign_in_with_apple/sign_in_with_apple.dart';
 
 import 'auth.dart';
 import 'user.dart';
@@ -19,6 +20,9 @@ abstract class AuthFacade {
     @required Password password,
   });
   Future<Auth> signInWithGoogle();
+  Future<Auth> signInWithApple({
+    @required WebAuthenticationOptions webAuthenticationOptions,
+  });
   Future<Auth> signInWithCredential(AuthCredential credential);
   Future<Auth> signInAnonymously();
   Future<void> signOut();

lib/src/domain/auth/i_auth_facade.dart

@@ -4,6 +4,7 @@ import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';
 import 'package:google_sign_in/google_sign_in.dart';
 import 'package:meta/meta.dart';
+import 'package:sign_in_with_apple/sign_in_with_apple.dart';
 
 import '../domain/auth/auth.dart';
 import '../domain/auth/auth_failure.dart';
@@ -240,6 +241,35 @@ class FirebaseAuthFacade implements AuthFacade {
     }
   }
 
+  @override
+  Future<Auth> signInWithApple({
+    WebAuthenticationOptions webAuthenticationOptions,
+  }) async {
+    try {
+      final appleUser = await SignInWithApple.getAppleIDCredential(
+        scopes: [
+          AppleIDAuthorizationScopes.email,
+          AppleIDAuthorizationScopes.fullName,
+        ],
+        webAuthenticationOptions: webAuthenticationOptions,
+      );
+      const oAuthProvider = OAuthProvider(providerId: 'apple.com');
+      final authCredential = oAuthProvider.getCredential(
+        idToken: appleUser.identityToken,
+        accessToken: appleUser.authorizationCode,
+      );
+      await _firebaseAuth.signInWithCredential(authCredential);
+      return const Auth.success();
+    } on SignInWithAppleAuthorizationException catch (e) {
+      if (e.code == AuthorizationErrorCode.canceled) {
+        return const Auth.failure(AuthFailure.cancelledByUser());
+      }
+      return const Auth.failure(AuthFailure.serverError());
+    } catch (e) {
+      return const Auth.failure(AuthFailure.serverError());
+    }
+  }
+
   @override
   Future<Auth> signInAnonymously() async {
     try {