packages/google_sign_in/google_sign_in_web/lib/google_sign_in_web.dart - mirrors/packages - Git at Google

 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 import 'dart:async';
 import 'dart:js_interop';
 import 'dart:ui_web' as ui_web;

 import 'package:flutter/foundation.dart' show kDebugMode, visibleForTesting;
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart' show PlatformException;
 import 'package:flutter/widgets.dart';
 import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 import 'package:google_identity_services_web/loader.dart' as loader;
 import 'package:google_sign_in_platform_interface/google_sign_in_platform_interface.dart';
 import 'package:web/web.dart' as web;

 import 'src/button_configuration.dart' show GSIButtonConfiguration;
 import 'src/flexible_size_html_element_view.dart';
 import 'src/gis_client.dart';

 // Export the configuration types for the renderButton method.
 export 'src/button_configuration.dart'
     show
         GSIButtonConfiguration,
         GSIButtonLogoAlignment,
         GSIButtonShape,
         GSIButtonSize,
         GSIButtonText,
         GSIButtonTheme,
         GSIButtonType;

 /// The `name` of the meta-tag to define a ClientID in HTML.
 const String clientIdMetaName = 'google-signin-client_id';

 /// The selector used to find the meta-tag that defines a ClientID in HTML.
 const String clientIdMetaSelector = 'meta[name=$clientIdMetaName]';

 /// The attribute name that stores the Client ID in the meta-tag that defines a Client ID in HTML.
 const String clientIdAttributeName = 'content';

 /// Implementation of the google_sign_in plugin for Web.
 class GoogleSignInPlugin extends GoogleSignInPlatform {
   /// Constructs the plugin immediately and begins initializing it in the
   /// background.
   ///
   /// For tests, the plugin can skip its loading process with [debugOverrideLoader],
   /// and the implementation of the underlying GIS SDK client through [debugOverrideGisSdkClient].
   GoogleSignInPlugin({
     @visibleForTesting bool debugOverrideLoader = false,
     @visibleForTesting GisSdkClient? debugOverrideGisSdkClient,
     @visibleForTesting
     StreamController<GoogleSignInUserData?>? debugOverrideUserDataController,
   })  : _gisSdkClient = debugOverrideGisSdkClient,
         _userDataController = debugOverrideUserDataController ??
             StreamController<GoogleSignInUserData?>.broadcast() {
     autoDetectedClientId = web.document
         .querySelector(clientIdMetaSelector)
         ?.getAttribute(clientIdAttributeName);

     _registerButtonFactory();

     if (debugOverrideLoader) {
       _jsSdkLoadedFuture = Future<bool>.value(true);
     } else {
       _jsSdkLoadedFuture = loader.loadWebSdk();
     }
   }

   // A future that completes when the JS loader is done.
   late Future<void> _jsSdkLoadedFuture;
   // A future that completes when the `init` call is done.
   Completer<void>? _initCalled;

   // A StreamController to communicate status changes from the GisSdkClient.
   final StreamController<GoogleSignInUserData?> _userDataController;

   // The instance of [GisSdkClient] backing the plugin.
   GisSdkClient? _gisSdkClient;

   // A convenience getter to avoid using ! when accessing _gisSdkClient, and
   // providing a slightly better error message when it is Null.
   GisSdkClient get _gisClient {
     assert(
       _gisSdkClient != null,
       'GIS Client not initialized. '
       'GoogleSignInPlugin::init() or GoogleSignInPlugin::initWithParams() '
       'must be called before any other method in this plugin.',
     );
     return _gisSdkClient!;
   }

   // This method throws if init or initWithParams hasn't been called at some
   // point in the past. It is used by the [initialized] getter to ensure that
   // users can't await on a Future that will never resolve.
   void _assertIsInitCalled() {
     if (_initCalled == null) {
       throw StateError(
         'GoogleSignInPlugin::init() or GoogleSignInPlugin::initWithParams() '
         'must be called before any other method in this plugin.',
       );
     }
   }

   /// A future that resolves when the plugin is fully initialized.
   ///
   /// This ensures that the SDK has been loaded, and that the `initWithParams`
   /// method has finished running.
   @visibleForTesting
   Future<void> get initialized {
     _assertIsInitCalled();
     return Future.wait<void>(
         <Future<void>>[_jsSdkLoadedFuture, _initCalled!.future]);
   }

   /// Stores the client ID if it was set in a meta-tag of the page.
   @visibleForTesting
   late String? autoDetectedClientId;

   /// Factory method that initializes the plugin with [GoogleSignInPlatform].
   static void registerWith(Registrar registrar) {
     GoogleSignInPlatform.instance = GoogleSignInPlugin();
   }

   @override
   Future<void> init({
     List<String> scopes = const <String>[],
     SignInOption signInOption = SignInOption.standard,
     String? hostedDomain,
     String? clientId,
   }) {
     return initWithParams(SignInInitParameters(
       scopes: scopes,
       signInOption: signInOption,
       hostedDomain: hostedDomain,
       clientId: clientId,
     ));
   }

   @override
   Future<void> initWithParams(SignInInitParameters params) async {
     final String? appClientId = params.clientId ?? autoDetectedClientId;
     assert(
         appClientId != null,
         'ClientID not set. Either set it on a '
         '<meta name="google-signin-client_id" content="CLIENT_ID" /> tag,'
         ' or pass clientId when initializing GoogleSignIn');

     assert(params.serverClientId == null,
         'serverClientId is not supported on Web.');

     assert(
         !params.scopes.any((String scope) => scope.contains(' ')),
         "OAuth 2.0 Scopes for Google APIs can't contain spaces. "
         'Check https://developers.google.com/identity/protocols/googlescopes '
         'for a list of valid OAuth 2.0 scopes.');

     _initCalled = Completer<void>();

     await _jsSdkLoadedFuture;

     _gisSdkClient ??= GisSdkClient(
       clientId: appClientId!,
       hostedDomain: params.hostedDomain,
       initialScopes: List<String>.from(params.scopes),
       userDataController: _userDataController,
       loggingEnabled: kDebugMode,
     );

     _initCalled!.complete(); // Signal that `init` is fully done.
   }

   // Register a factory for the Button HtmlElementView.
   void _registerButtonFactory() {
     ui_web.platformViewRegistry.registerViewFactory(
       'gsi_login_button',
       (int viewId) {
         final web.Element element = web.document.createElement('div');
         element.setAttribute('style',
             'width: 100%; height: 100%; overflow: hidden; display: flex; flex-wrap: wrap; align-content: center; justify-content: center;');
         element.id = 'sign_in_button_$viewId';
         return element;
       },
     );
   }

   /// Render the GSI button web experience.
   Widget renderButton({GSIButtonConfiguration? configuration}) {
     final GSIButtonConfiguration config =
         configuration ?? GSIButtonConfiguration();
     return FutureBuilder<void>(
       key: Key(config.hashCode.toString()),
       future: initialized,
       builder: (BuildContext context, AsyncSnapshot<void> snapshot) {
         if (snapshot.hasData) {
           return FlexHtmlElementView(
               viewType: 'gsi_login_button',
               onElementCreated: (Object element) {
                 _gisClient.renderButton(element, config);
               });
         }
         return const Text('Getting ready');
       },
     );
   }

   @override
   Future<GoogleSignInUserData?> signInSilently() async {
     await initialized;

     // The new user is being injected from the `userDataEvents` Stream.
     return _gisClient.signInSilently();
   }

   @override
   Future<GoogleSignInUserData?> signIn() async {
     if (kDebugMode) {
       web.console.warn(
           "The `signIn` method is discouraged on the web because it can't reliably provide an `idToken`.\n"
                   'Use `signInSilently` and `renderButton` to authenticate your users instead.\n'
                   'Read more: https://pub.dev/packages/google_sign_in_web'
               .toJS);
     }
     await initialized;

     // This method mainly does oauth2 authorization, which happens to also do
     // authentication if needed. However, the authentication information is not
     // returned anymore.
     //
     // This method will synthesize authentication information from the People API
     // if needed (or use the last identity seen from signInSilently).
     try {
       return _gisClient.signIn();
     } catch (reason) {
       throw PlatformException(
         code: reason.toString(),
         message: 'Exception raised from signIn',
         details:
             'https://developers.google.com/identity/oauth2/web/guides/error',
       );
     }
   }

   @override
   Future<GoogleSignInTokenData> getTokens({
     required String email,
     bool? shouldRecoverAuth,
   }) async {
     await initialized;

     return _gisClient.getTokens();
   }

   @override
   Future<void> signOut() async {
     await initialized;

     await _gisClient.signOut();
   }

   @override
   Future<void> disconnect() async {
     await initialized;

     await _gisClient.disconnect();
   }

   @override
   Future<bool> isSignedIn() async {
     await initialized;

     return _gisClient.isSignedIn();
   }

   @override
   Future<void> clearAuthCache({required String token}) async {
     await initialized;

     await _gisClient.clearAuthCache();
   }

   @override
   Future<bool> requestScopes(List<String> scopes) async {
     await initialized;

     return _gisClient.requestScopes(scopes);
   }

   @override
   Future<bool> canAccessScopes(List<String> scopes,
       {String? accessToken}) async {
     await initialized;

     return _gisClient.canAccessScopes(scopes, accessToken);
   }

   @override
   Stream<GoogleSignInUserData?>? get userDataEvents =>
       _userDataController.stream;

   /// Requests server auth code from GIS Client per:
   /// https://developers.google.com/identity/oauth2/web/guides/use-code-model#initialize_a_code_client
   Future<String?> requestServerAuthCode() async {
     await initialized;
     return _gisClient.requestServerAuthCode();
   }
 }
	// Copyright 2013 The Flutter Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	import 'dart:async';
	import 'dart:js_interop';
	import 'dart:ui_web' as ui_web;

	import 'package:flutter/foundation.dart' show kDebugMode, visibleForTesting;
	import 'package:flutter/material.dart';
	import 'package:flutter/services.dart' show PlatformException;
	import 'package:flutter/widgets.dart';
	import 'package:flutter_web_plugins/flutter_web_plugins.dart';
	import 'package:google_identity_services_web/loader.dart' as loader;
	import 'package:google_sign_in_platform_interface/google_sign_in_platform_interface.dart';
	import 'package:web/web.dart' as web;

	import 'src/button_configuration.dart' show GSIButtonConfiguration;
	import 'src/flexible_size_html_element_view.dart';
	import 'src/gis_client.dart';

	// Export the configuration types for the renderButton method.
	export 'src/button_configuration.dart'
	show
	GSIButtonConfiguration,
	GSIButtonLogoAlignment,
	GSIButtonShape,
	GSIButtonSize,
	GSIButtonText,
	GSIButtonTheme,
	GSIButtonType;

	/// The `name` of the meta-tag to define a ClientID in HTML.
	const String clientIdMetaName = 'google-signin-client_id';

	/// The selector used to find the meta-tag that defines a ClientID in HTML.
	const String clientIdMetaSelector = 'meta[name=$clientIdMetaName]';

	/// The attribute name that stores the Client ID in the meta-tag that defines a Client ID in HTML.
	const String clientIdAttributeName = 'content';

	/// Implementation of the google_sign_in plugin for Web.
	class GoogleSignInPlugin extends GoogleSignInPlatform {
	/// Constructs the plugin immediately and begins initializing it in the
	/// background.
	///
	/// For tests, the plugin can skip its loading process with [debugOverrideLoader],
	/// and the implementation of the underlying GIS SDK client through [debugOverrideGisSdkClient].
	GoogleSignInPlugin({
	@visibleForTesting bool debugOverrideLoader = false,
	@visibleForTesting GisSdkClient? debugOverrideGisSdkClient,
	@visibleForTesting
	StreamController<GoogleSignInUserData?>? debugOverrideUserDataController,
	}) : _gisSdkClient = debugOverrideGisSdkClient,
	_userDataController = debugOverrideUserDataController ??
	StreamController<GoogleSignInUserData?>.broadcast() {
	autoDetectedClientId = web.document
	.querySelector(clientIdMetaSelector)
	?.getAttribute(clientIdAttributeName);

	_registerButtonFactory();

	if (debugOverrideLoader) {
	_jsSdkLoadedFuture = Future<bool>.value(true);
	} else {
	_jsSdkLoadedFuture = loader.loadWebSdk();
	}
	}

	// A future that completes when the JS loader is done.
	late Future<void> _jsSdkLoadedFuture;
	// A future that completes when the `init` call is done.
	Completer<void>? _initCalled;

	// A StreamController to communicate status changes from the GisSdkClient.
	final StreamController<GoogleSignInUserData?> _userDataController;

	// The instance of [GisSdkClient] backing the plugin.
	GisSdkClient? _gisSdkClient;

	// A convenience getter to avoid using ! when accessing _gisSdkClient, and
	// providing a slightly better error message when it is Null.
	GisSdkClient get _gisClient {
	assert(
	_gisSdkClient != null,
	'GIS Client not initialized. '
	'GoogleSignInPlugin::init() or GoogleSignInPlugin::initWithParams() '
	'must be called before any other method in this plugin.',
	);
	return _gisSdkClient!;
	}

	// This method throws if init or initWithParams hasn't been called at some
	// point in the past. It is used by the [initialized] getter to ensure that
	// users can't await on a Future that will never resolve.
	void _assertIsInitCalled() {
	if (_initCalled == null) {
	throw StateError(
	'GoogleSignInPlugin::init() or GoogleSignInPlugin::initWithParams() '
	'must be called before any other method in this plugin.',
	);
	}
	}

	/// A future that resolves when the plugin is fully initialized.
	///
	/// This ensures that the SDK has been loaded, and that the `initWithParams`
	/// method has finished running.
	@visibleForTesting
	Future<void> get initialized {
	_assertIsInitCalled();
	return Future.wait<void>(
	<Future<void>>[_jsSdkLoadedFuture, _initCalled!.future]);
	}

	/// Stores the client ID if it was set in a meta-tag of the page.
	@visibleForTesting
	late String? autoDetectedClientId;

	/// Factory method that initializes the plugin with [GoogleSignInPlatform].
	static void registerWith(Registrar registrar) {
	GoogleSignInPlatform.instance = GoogleSignInPlugin();
	}

	@override
	Future<void> init({
	List<String> scopes = const <String>[],
	SignInOption signInOption = SignInOption.standard,
	String? hostedDomain,
	String? clientId,
	}) {
	return initWithParams(SignInInitParameters(
	scopes: scopes,
	signInOption: signInOption,
	hostedDomain: hostedDomain,
	clientId: clientId,
	));
	}

	@override
	Future<void> initWithParams(SignInInitParameters params) async {
	final String? appClientId = params.clientId ?? autoDetectedClientId;
	assert(
	appClientId != null,
	'ClientID not set. Either set it on a '
	'<meta name="google-signin-client_id" content="CLIENT_ID" /> tag,'
	' or pass clientId when initializing GoogleSignIn');

	assert(params.serverClientId == null,
	'serverClientId is not supported on Web.');

	assert(
	!params.scopes.any((String scope) => scope.contains(' ')),
	"OAuth 2.0 Scopes for Google APIs can't contain spaces. "
	'Check https://developers.google.com/identity/protocols/googlescopes '
	'for a list of valid OAuth 2.0 scopes.');

	_initCalled = Completer<void>();

	await _jsSdkLoadedFuture;

	_gisSdkClient ??= GisSdkClient(
	clientId: appClientId!,
	hostedDomain: params.hostedDomain,
	initialScopes: List<String>.from(params.scopes),
	userDataController: _userDataController,
	loggingEnabled: kDebugMode,
	);

	_initCalled!.complete(); // Signal that `init` is fully done.
	}

	// Register a factory for the Button HtmlElementView.
	void _registerButtonFactory() {
	ui_web.platformViewRegistry.registerViewFactory(
	'gsi_login_button',
	(int viewId) {
	final web.Element element = web.document.createElement('div');
	element.setAttribute('style',
	'width: 100%; height: 100%; overflow: hidden; display: flex; flex-wrap: wrap; align-content: center; justify-content: center;');
	element.id = 'sign_in_button_$viewId';
	return element;
	},
	);
	}

	/// Render the GSI button web experience.
	Widget renderButton({GSIButtonConfiguration? configuration}) {
	final GSIButtonConfiguration config =
	configuration ?? GSIButtonConfiguration();
	return FutureBuilder<void>(
	key: Key(config.hashCode.toString()),
	future: initialized,
	builder: (BuildContext context, AsyncSnapshot<void> snapshot) {
	if (snapshot.hasData) {
	return FlexHtmlElementView(
	viewType: 'gsi_login_button',
	onElementCreated: (Object element) {
	_gisClient.renderButton(element, config);
	});
	}
	return const Text('Getting ready');
	},
	);
	}

	@override
	Future<GoogleSignInUserData?> signInSilently() async {
	await initialized;

	// The new user is being injected from the `userDataEvents` Stream.
	return _gisClient.signInSilently();
	}

	@override
	Future<GoogleSignInUserData?> signIn() async {
	if (kDebugMode) {
	web.console.warn(
	"The `signIn` method is discouraged on the web because it can't reliably provide an `idToken`.\n"
	'Use `signInSilently` and `renderButton` to authenticate your users instead.\n'
	'Read more: https://pub.dev/packages/google_sign_in_web'
	.toJS);
	}
	await initialized;

	// This method mainly does oauth2 authorization, which happens to also do
	// authentication if needed. However, the authentication information is not
	// returned anymore.
	//
	// This method will synthesize authentication information from the People API
	// if needed (or use the last identity seen from signInSilently).
	try {
	return _gisClient.signIn();
	} catch (reason) {
	throw PlatformException(
	code: reason.toString(),
	message: 'Exception raised from signIn',
	details:
	'https://developers.google.com/identity/oauth2/web/guides/error',
	);
	}
	}

	@override
	Future<GoogleSignInTokenData> getTokens({
	required String email,
	bool? shouldRecoverAuth,
	}) async {
	await initialized;

	return _gisClient.getTokens();
	}

	@override
	Future<void> signOut() async {
	await initialized;

	await _gisClient.signOut();
	}

	@override
	Future<void> disconnect() async {
	await initialized;

	await _gisClient.disconnect();
	}

	@override
	Future<bool> isSignedIn() async {
	await initialized;

	return _gisClient.isSignedIn();
	}

	@override
	Future<void> clearAuthCache({required String token}) async {
	await initialized;

	await _gisClient.clearAuthCache();
	}

	@override
	Future<bool> requestScopes(List<String> scopes) async {
	await initialized;

	return _gisClient.requestScopes(scopes);
	}

	@override
	Future<bool> canAccessScopes(List<String> scopes,
	{String? accessToken}) async {
	await initialized;

	return _gisClient.canAccessScopes(scopes, accessToken);
	}

	@override
	Stream<GoogleSignInUserData?>? get userDataEvents =>
	_userDataController.stream;

	/// Requests server auth code from GIS Client per:
	/// https://developers.google.com/identity/oauth2/web/guides/use-code-model#initialize_a_code_client
	Future<String?> requestServerAuthCode() async {
	await initialized;
	return _gisClient.requestServerAuthCode();
	}
	}