- Support Continue as guest and add new sign in provider firebaseui.auth.AnonymousAuthProvider. (#458)

- Add the ability to configure country selection for phone Auth.
- Add return type for `start()` and `setConfig()` in typescript declaration.

PiperOrigin-RevId: 205712709
Change-Id: Ie3d1a50be4fbd95b8ba02d1c6f500f553ff4ba60

Author: wti806

README.md

@@ -134,6 +134,7 @@ remembering emails
 7. Integration with
 [one-tap sign-up](https://developers.google.com/identity/one-tap/web/overview)
 8. Ability to upgrade anonymous users through sign-in/sign-up.
+9. Sign-in as a guest
 
 ### Configuring sign-in providers
 
@@ -147,6 +148,7 @@ provider you want to use in their own developer app settings. Please read the
 - [Facebook](https://firebase.google.com/docs/auth/web/facebook-login#before_you_begin)
 - [Twitter](https://firebase.google.com/docs/auth/web/twitter-login#before_you_begin)
 - [Github](https://firebase.google.com/docs/auth/web/github-auth#before_you_begin)
+- [Anonymous](https://firebase.google.com/docs/auth/web/anonymous-auth#before_you_begin)
 
 ### Starting the sign-in flow
 
@@ -187,10 +189,13 @@ for a more in-depth example, showcasing a Single Page Application mode.
           firebase.auth.TwitterAuthProvider.PROVIDER_ID,
           firebase.auth.GithubAuthProvider.PROVIDER_ID,
           firebase.auth.EmailAuthProvider.PROVIDER_ID,
-          firebase.auth.PhoneAuthProvider.PROVIDER_ID
+          firebase.auth.PhoneAuthProvider.PROVIDER_ID,
+          firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID
         ],
         // Terms of service url.
-        tosUrl: '<your-tos-url>'
+        tosUrl: '<your-tos-url>',
+        // Privacy policy url.
+        privacyPolicyUrl: '<your-privacy-policy-url>'
       };
 
       // Initialize the FirebaseUI Widget using Firebase.
@@ -396,6 +401,11 @@ FirebaseUI supports the following configuration parameters.
 <td>Yes</td>
 <td>The URL of the Terms of Service page.</td>
 </tr>
+<tr>
+<td>privacyPolicyUrl</td>
+<td>Yes</td>
+<td>The URL of the privacy policy page.</td>
+</tr>
 </tbody>
 </table>
 
@@ -495,6 +505,7 @@ To see FirebaseUI in action with one-tap sign-up, check out the FirebaseUI
 |Github            |`firebase.auth.GithubAuthProvider.PROVIDER_ID`  |
 |Email and password|`firebase.auth.EmailAuthProvider.PROVIDER_ID`   |
 |Phone number      |`firebase.auth.PhoneAuthProvider.PROVIDER_ID`   |
+|Anonymous         |`firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID`|
 
 ### Configure OAuth providers
 
@@ -595,6 +606,25 @@ ui.start('#firebaseui-auth-container', {
 });
 ```
 
+### Configure Anonymous Provider
+
+The `AnonymousAuthProvider` can be enabled to let users continue as a guest. If
+a user is already signed in anonymously, clicking this sign-in option will keep
+the same current anonymous user. In addition, when auto-upgrade for anonymous
+users is enabled in addition to this option and a user is already signed in
+anonymously, clicking this sign-in option will also keep the same current
+anonymous user.
+
+```javascript
+ui.start('#firebaseui-auth-container', {
+  signInOptions: [
+    {
+      provider: firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID
+    }
+  ]
+});
+```
+
 ### Sign In Flows
 
 Two sign in flows are available:
@@ -756,10 +786,13 @@ FirebaseUI is displayed.
               size: 'invisible',
               badge: 'bottomleft'
             }
-          }
+          },
+          firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID
         ],
         // Terms of service url.
-        tosUrl: '<your-tos-url>'
+        tosUrl: '<your-tos-url>',
+        // Privacy policy url.
+        privacyPolicyUrl: '<your-privacy-policy-url>'
       };
 
       var ui = new firebaseui.auth.AuthUI(firebase.auth());
@@ -1081,6 +1114,7 @@ Firebase core SDK.
 |Twitter           |`firebase.auth.TwitterAuthProvider.PROVIDER_ID` |
 |Github            |`firebase.auth.GithubAuthProvider.PROVIDER_ID`  |
 |Email and password|`firebase.auth.EmailAuthProvider.PROVIDER_ID`   |
+|Anonymous         |`firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID`|
 
 ### Setup and Usage
 

demo/public/app.js

@@ -68,7 +68,8 @@ function getUiConfig() {
         recaptchaParameters: {
           size: getRecaptchaMode()
         }
-      }
+      },
+      firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID
     ],
     // Terms of service url.
     'tosUrl': 'https://www.google.com',

demo/public/widget.html

@@ -50,7 +50,8 @@
             recaptchaParameters: {
               size: getRecaptchaMode()
             }
-          }
+          },
+          firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID
         ],
         // Terms of service url.
         'tosUrl': 'https://www.google.com',

externs/firebaseui-externs.js

@@ -22,7 +22,7 @@
  * The FirebaseUI namespace.
  * @namespace
  */
-firebaseui = {};
+var firebaseui = {};
 
 /**
  * The FirebaseUI auth namespace.
@@ -31,6 +31,20 @@ firebaseui = {};
 firebaseui.auth = {};
 
 
+/**
+ * The FirebaseUI Anonymous Auth Provider namespace.
+ * @constructor
+ */
+firebaseui.auth.AnonymousAuthProvider = {};
+
+
+/**
+ * The FirebaseUI Anonymous Auth Provider ID.
+ * @const {string}
+ */
+firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID = 'anonymous';
+
+
 /**
  * @param {!firebase.auth.Auth} auth The Firebase Auth instance.
  * @param {string=} appId The optional app id.
@@ -401,3 +415,25 @@ firebaseui.auth.SignInOption.prototype.defaultNationalNumber;
  * @type {string|undefined}
  */
 firebaseui.auth.SignInOption.prototype.loginHint;
+
+/**
+ * Sets the whitelisted countries. Accept either ISO (alpha-2) or E164 formatted
+ * country codes. Invalid country code will be ignored. If `defaultCountry` is
+ * provided, it must be whitelisted. `whitelistedCountries` and
+ * `blacklistedCountries` cannot be specified at the same time.
+ * Example: ['US', '+44']
+ *
+ * @type {!Array<string>|undefined}
+ */
+firebaseui.auth.SignInOption.prototype.whitelistedCountries;
+
+/**
+ * Sets the blacklisted countries. Accept either ISO (alpha-2) or E164 formatted
+ * country codes. Invalid country code will be ignored. If `defaultCountry` is
+ * provided, it must not be blacklisted. `whitelistedCountries` and
+ * `blacklistedCountries` cannot be specified at the same time.
+ * Example: ['US', '+44']
+ *
+ * @type {!Array<string>|undefined}
+ */
+firebaseui.auth.SignInOption.prototype.blacklistedCountries;

image/anonymous.png

@@ -93,6 +93,16 @@ firebaseui.auth.data.country.LookupTree.prototype.search = function(code) {
 };
 
 
+/**
+ * Gets the list of counties used to build up the tree.
+ * @return {!Array<!firebaseui.auth.data.country.Country>} The list of
+ *     countries to construct the prefix tree for.
+ */
+firebaseui.auth.data.country.LookupTree.prototype.getCountries = function() {
+  return this.countries_;
+};
+
+
 /**
  * Fetches data about a country given its e164_key field.
  * @param {string} key The e164_key of the country.
@@ -128,6 +138,44 @@ firebaseui.auth.data.country.getCountriesByIso2 = function(code) {
 };
 
 
+/**
+ * Fetches data about a country given its E164 country calling code (e164_cc)
+ * field. May return multiple entries for countries with multiple
+ * country codes, or an empty array if the country code was not found.
+ * @param {string} code The e164_cc of the country.
+ * @return {!Array<!firebaseui.auth.data.country.Country>}
+ */
+firebaseui.auth.data.country.getCountriesByE164Code = function(code) {
+  var countries = [];
+  for (var i = 0; i < firebaseui.auth.data.country.COUNTRY_LIST.length; i++) {
+    if (firebaseui.auth.data.country.COUNTRY_LIST[i].e164_cc == code) {
+      countries.push(firebaseui.auth.data.country.COUNTRY_LIST[i]);
+    }
+  }
+  return countries;
+};
+
+
+/**
+ * Fetches data about a country given its E164 country calling code (e164_cc)
+ * prefixed with '+' or ISO 3166-1 alpha-2 country code (iso2_cc). May
+ * return multiple entries for countries with multiple country codes, or an
+ * empty array if the country code was not found.
+ * @param {string} code The e164_cc or iso2_cc of the country.
+ * @return {!Array<!firebaseui.auth.data.country.Country>}
+ */
+firebaseui.auth.data.country.getCountriesByE164OrIsoCode = function(code) {
+  var countries = [];
+  if (code.length > 0 && code.charAt(0) == '+') {
+    countries = firebaseui.auth.data.country.getCountriesByE164Code(
+        code.substring(1));
+  } else {
+    countries =
+        firebaseui.auth.data.country.getCountriesByIso2(code);
+  }
+  return countries;
+};
+
 
 /**
  * Sorts the list of countries by name for the given locale.

javascript/data/country.js

@@ -107,6 +107,8 @@ function testCountryLookupByPhoneNumber() {
   // Initialize lookup tree.
   var lookupTree = new firebaseui.auth.data.country.LookupTree(
       firebaseui.auth.data.country.COUNTRY_LIST);
+  assertEquals(
+      firebaseui.auth.data.country.COUNTRY_LIST, lookupTree.getCountries());
   // Empty string.
   assertSameElements([], lookupTree.search(''));
   // Invalid country code that starts with 0.
@@ -154,7 +156,7 @@ function testGetCountriesByIso2() {
  * Tests that getCountriesByIso2 works correctly if multiple entries have the
  * same ISO2 code.
  */
-function testGetCountriesByIso2_multiple() {
+function testGetCountriesByIso2_multipleMatches() {
   var countries = firebaseui.auth.data.country.getCountriesByIso2('xk');
   var actualCodes = goog.array.map(countries, function(country) {
     return country.e164_cc;
@@ -167,3 +169,75 @@ function testGetCountriesByIso2_notFound() {
   var countries = firebaseui.auth.data.country.getCountriesByIso2('zz');
   assertEquals(0, countries.length);
 }
+
+
+function testGetCountriesByE164Code() {
+  var countries = firebaseui.auth.data.country.getCountriesByE164Code('86');
+  assertEquals(1, countries.length);
+  assertEquals('China', countries[0].name);
+  assertEquals('CN', countries[0].iso2_cc);
+}
+
+
+/**
+ * Tests that getCountriesByE164Code works correctly if multiple entries have
+ * the same e164_cc code.
+ */
+function testGetCountriesByE164Code_multipleMatches() {
+  var countries = firebaseui.auth.data.country.getCountriesByE164Code('44');
+  var actualKeys = goog.array.map(countries, function(country) {
+    return country.e164_key;
+  });
+  assertSameElements(['44-GG-0', '44-IM-0', '44-JE-0', '44-GB-0'], actualKeys);
+}
+
+
+function testGetCountriesByE164Code_notFound() {
+  var countries = firebaseui.auth.data.country.getCountriesByIso2('999');
+  assertEquals(0, countries.length);
+}
+
+
+function testGetCountriesByE164OrIsoCode_e164() {
+  var countries =
+      firebaseui.auth.data.country.getCountriesByE164OrIsoCode('+86');
+  assertEquals(1, countries.length);
+  assertEquals('China', countries[0].name);
+  assertEquals('CN', countries[0].iso2_cc);
+}
+
+
+function testGetCountriesByE164eOrIsoCode_iso() {
+  var countries =
+      firebaseui.auth.data.country.getCountriesByE164OrIsoCode('CN');
+  assertEquals(1, countries.length);
+  assertEquals('China', countries[0].name);
+  assertEquals('86', countries[0].e164_cc);
+}
+
+
+function testGetCountriesByE164OrIsoCode_e164_multipleMatches() {
+  var countries =
+      firebaseui.auth.data.country.getCountriesByE164OrIsoCode('+44');
+  var actualKeys = goog.array.map(countries, function(country) {
+    return country.e164_key;
+  });
+  assertSameElements(['44-GG-0', '44-IM-0', '44-JE-0', '44-GB-0'], actualKeys);
+}
+
+
+function testGetCountriesByE164OrIsoCode_iso_multipleMatches() {
+  var countries =
+      firebaseui.auth.data.country.getCountriesByE164OrIsoCode('xk');
+  var actualKeys = goog.array.map(countries, function(country) {
+    return country.e164_key;
+  });
+  assertSameElements(['377-XK-0', '381-XK-0', '386-XK-0'], actualKeys);
+}
+
+
+function testGetCountriesByE164CodeOrIsoCode_notFound() {
+  var countries =
+      firebaseui.auth.data.country.getCountriesByE164OrIsoCode('+999');
+  assertEquals(0, countries.length);
+}

javascript/data/country_test.js

@@ -205,6 +205,7 @@ FakeAuthClient.AuthAsyncMethod = {
       'signInAndRetrieveDataWithEmailAndPassword',
   SIGN_IN_ANONYMOUSLY_AND_RETRIEVE_DATA:
       'signInAnonymouslyAndRetrieveData',
+  SIGN_IN_ANONYMOUSLY: 'signInAnonymously',
   SIGN_IN_WITH_CREDENTIAL: 'signInWithCredential',
   SIGN_IN_WITH_CUSTOM_TOKEN: 'signInWithCustomToken',
   SIGN_IN_WITH_EMAIL_AND_PASSWORD: 'signInWithEmailAndPassword',