Release3.4 (#485)

* release3.4

Author: wti806

README.md

@@ -63,17 +63,17 @@ Localized versions of the widget are available through the CDN. To use a localiz
 localized JS library instead of the default library:
 
 ```html
-<script src="https://www.gstatic.com/firebasejs/ui/3.3.0/firebase-ui-auth__{LANGUAGE_CODE}.js"></script>
-<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/3.3.0/firebase-ui-auth.css" />
+<script src="https://www.gstatic.com/firebasejs/ui/3.4.0/firebase-ui-auth__{LANGUAGE_CODE}.js"></script>
+<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/3.4.0/firebase-ui-auth.css" />
 ```
 
 where `{LANGUAGE_CODE}` is replaced by the code of the language you want. For example, the French
 version of the library is available at
-`https://www.gstatic.com/firebasejs/ui/3.3.0/firebase-ui-auth__fr.js`. The list of available
+`https://www.gstatic.com/firebasejs/ui/3.4.0/firebase-ui-auth__fr.js`. The list of available
 languages and their respective language codes can be found at [LANGUAGES.md](LANGUAGES.md).
 
 Right-to-left languages also require the right-to-left version of the stylesheet, available at
-`https://www.gstatic.com/firebasejs/ui/3.3.0/firebase-ui-auth-rtl.css`, instead of the default
+`https://www.gstatic.com/firebasejs/ui/3.4.0/firebase-ui-auth-rtl.css`, instead of the default
 stylesheet. The supported right-to-left languages are Arabic (ar), Farsi (fa), and Hebrew (iw).
 
 ### Option 2: npm Module
@@ -192,10 +192,14 @@ for a more in-depth example, showcasing a Single Page Application mode.
           firebase.auth.PhoneAuthProvider.PROVIDER_ID,
           firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID
         ],
-        // Terms of service url.
+        // tosUrl and privacyPolicyUrl accept either url string or a callback
+        // function.
+        // Terms of service url/callback.
         tosUrl: '<your-tos-url>',
-        // Privacy policy url.
-        privacyPolicyUrl: '<your-privacy-policy-url>'
+        // Privacy policy url/callback.
+        privacyPolicyUrl: function() {
+          window.location.assign('<your-privacy-policy-url>');
+        }
       };
 
       // Initialize the FirebaseUI Widget using Firebase.
@@ -399,12 +403,18 @@ FirebaseUI supports the following configuration parameters.
 <tr>
 <td>tosUrl</td>
 <td>Yes</td>
-<td>The URL of the Terms of Service page.</td>
+<td>
+  The URL of the Terms of Service page or a callback function to be invoked
+  when Terms of Service link is clicked.
+</td>
 </tr>
 <tr>
 <td>privacyPolicyUrl</td>
 <td>Yes</td>
-<td>The URL of the privacy policy page.</td>
+<td>
+  The URL of the Privacy Policy page or a callback function to be invoked
+  when Privacy Policy link is clicked.
+</td>
 </tr>
 </tbody>
 </table>
@@ -802,10 +812,14 @@ FirebaseUI is displayed.
           },
           firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID
         ],
-        // Terms of service url.
+        // tosUrl and privacyPolicyUrl accept either url string or a callback
+        // function.
+        // Terms of service url/callback.
         tosUrl: '<your-tos-url>',
-        // Privacy policy url.
-        privacyPolicyUrl: '<your-privacy-policy-url>'
+        // Privacy policy url/callback.
+        privacyPolicyUrl: function() {
+          window.location.assign('<your-privacy-policy-url>');
+        }
       };
 
       var ui = new firebaseui.auth.AuthUI(firebase.auth());

changelog.txt

@@ -0,0 +1 @@
+feature - Allows passing callbacks for Term of Service and Privacy Policy.

externs/firebaseui-externs.js

@@ -250,16 +250,16 @@ firebaseui.auth.Config.prototype.signInSuccessUrl;
 firebaseui.auth.Config.prototype.siteName;
 
 /**
- * The terms of service URL.
+ * The terms of service URL/callback.
  *
- * @type {string|undefined}
+ * @type {string|function()|undefined}
  */
 firebaseui.auth.Config.prototype.tosUrl;
 
 /**
- * The privacy policy URL.
+ * The privacy policy URL/callback.
  *
- * @type {string|undefined}
+ * @type {string|function()|undefined}
  */
 firebaseui.auth.Config.prototype.privacyPolicyUrl;
 

javascript/testing/util.js

@@ -37,6 +37,8 @@ var FakeUtil = function() {
   this.openerGoToUrl_ = null;
   this.closedWindow_ = null;
   this.popupUrl_ = null;
+  this.openUrl_ = null;
+  this.windowName_ = null;
 };
 goog.inherits(FakeUtil, Disposable);
 
@@ -63,6 +65,10 @@ FakeUtil.prototype.install = function() {
   r.set(util, 'popup', function(url) {
     self.popupUrl_ = url;
   });
+  r.set(util, 'open', function(url, windowName) {
+    self.openUrl_ = url;
+    self.windowName_ = windowName;
+  });
   return this;
 };
 
@@ -120,6 +126,19 @@ FakeUtil.prototype.assertOpenerGoTo = function(url) {
 };
 
 
+/**
+ * Asserts the given URL is loaded in the given window.
+ * @param {string} url The URL to be loaded.
+ * @param {string} windowName The window name to be loaded into.
+ */
+FakeUtil.prototype.assertOpen = function(url, windowName) {
+  assertEquals(url, this.openUrl_);
+  assertEquals(windowName, this.windowName_);
+  this.openUrl_ = null;
+  this.windowName_ = null;
+};
+
+
 /**
  * Asserts a window is closed.
  * @param {!Window} window The closed window.

javascript/ui/element/tospptesthelper.js

@@ -21,6 +21,7 @@ goog.provide('firebaseui.auth.ui.element.TosPpTestHelper');
 goog.setTestOnly('firebaseui.auth.ui.element.TosPpTestHelper');
 
 goog.require('firebaseui.auth.ui.element');
+goog.require('goog.testing.events');
 
 
 goog.scope(function() {
@@ -37,60 +38,116 @@ goog.inherits(element.TosPpTestHelper, element.ElementTestHelper);
 
 /** @override */
 element.TosPpTestHelper.prototype.resetState = function() {
+  this.tosLinkClicked_ = false;
+  this.privacyPolicyLinkClicked_ = false;
 };
 
 
-/** Asserts the full message of ToS and Privacy Policy is displayed. */
+/** Handler for ToS link click event. */
+element.TosPpTestHelper.prototype.onTosLinkClick = function() {
+  this.tosLinkClicked_ = true;
+};
+
+
+/** Handler for Privacy Policy link click event. */
+element.TosPpTestHelper.prototype.onPpLinkClick = function() {
+  this.privacyPolicyLinkClicked_ = true;
+};
+
+
+/**
+ * Asserts the full message of ToS and Privacy Policy is displayed.
+ * @param {?function()|undefined} tosCallback The ToS callback.
+ * @param {?function()|undefined} privacyPolicyCallback The Privacy Policy
+ *     callback.
+ */
 element.TosPpTestHelper.prototype.assertFullMessage = function(
-    tosUrl, privacyPolicyUrl) {
+    tosCallback, privacyPolicyCallback) {
   var element = this.component.getTosPpElement();
-  if (!tosUrl && !privacyPolicyUrl) {
+  if (!tosCallback && !privacyPolicyCallback) {
     assertNull(element);
   } else {
     assertTrue(element.classList.contains('firebaseui-tospp-full-message'));
-    assertEquals(tosUrl, this.component.getTosLinkElement().href);
-    assertEquals(privacyPolicyUrl, this.component.getPpLinkElement().href);
+    this.assertTosLinkClicked_();
+    this.assertPpLinkClicked_();
   }
 };
 
 
-/** Asserts the footer of ToS and Privacy Policy links is displayed. */
+/**
+ * Asserts the footer of ToS and Privacy Policy links is displayed.
+ * @param {?function()|undefined} tosCallback The ToS callback.
+ * @param {?function()|undefined} privacyPolicyCallback The Privacy Policy
+ *     callback.
+ */
 element.TosPpTestHelper.prototype.assertFooter = function(
-    tosUrl, privacyPolicyUrl) {
+    tosCallback, privacyPolicyCallback) {
   var element = this.component.getTosPpListElement();
-  if (!tosUrl && !privacyPolicyUrl) {
+  if (!tosCallback && !privacyPolicyCallback) {
     assertNull(element);
   } else {
     assertTrue(element.classList.contains('firebaseui-tos-list'));
-    assertEquals(tosUrl, this.component.getTosLinkElement().href);
-    assertEquals(privacyPolicyUrl, this.component.getPpLinkElement().href);
+    this.assertTosLinkClicked_();
+    this.assertPpLinkClicked_();
   }
 };
 
 
-/** Asserts the full message of ToS and Privacy Policy and a notice to the user
-  * about SMS rates for phone authentication are displayed. */
+/**
+ * Asserts the full message of ToS and Privacy Policy and a notice to the user
+ * about SMS rates for phone authentication are displayed.
+ * @param {?function()|undefined} tosCallback The ToS callback.
+ * @param {?function()|undefined} privacyPolicyCallback The Privacy Policy
+ *     callback.
+ */
 element.TosPpTestHelper.prototype.assertPhoneFullMessage = function(
-    tosUrl, privacyPolicyUrl) {
+    tosCallback, privacyPolicyCallback) {
   var element = this.component.getTosPpElement();
   assertTrue(element.classList.contains('firebaseui-phone-tos'));
-  if (!tosUrl && !privacyPolicyUrl) {
+  if (!tosCallback && !privacyPolicyCallback) {
     assertNull(this.component.getTosLinkElement());
     assertNull(this.component.getPpLinkElement());
   } else {
-    assertEquals(tosUrl, this.component.getTosLinkElement().href);
-    assertEquals(privacyPolicyUrl, this.component.getPpLinkElement().href);
+    this.assertTosLinkClicked_();
+    this.assertPpLinkClicked_();
   }
 };
 
 
-/** Asserts a notice to the user about SMS rates for phone authentication
-  * and the link of ToS and Privacy Policy are displayed. */
+/**
+ * Asserts a notice to the user about SMS rates for phone authentication
+ * and the link of ToS and Privacy Policy are displayed.
+ * @param {?function()|undefined} tosCallback The ToS callback.
+ * @param {?function()|undefined} privacyPolicyCallback The Privacy Policy
+ *     callback.
+ */
 element.TosPpTestHelper.prototype.assertPhoneFooter = function(
-    tosUrl, privacyPolicyUrl) {
+    tosCallback, privacyPolicyCallback) {
   var element = this.component.getTosPpElement();
   assertTrue(element.classList.contains('firebaseui-phone-sms-notice'));
-  this.assertFooter(tosUrl, privacyPolicyUrl);
+  this.assertFooter(tosCallback, privacyPolicyCallback);
+};
+
+
+/**
+ * Asserts the onClick callback is triggered when ToS link element is clicked.
+ * @private
+ */
+element.TosPpTestHelper.prototype.assertTosLinkClicked_ = function() {
+  assertFalse(this.tosLinkClicked_);
+  goog.testing.events.fireClickSequence(this.component.getTosLinkElement());
+  assertTrue(this.tosLinkClicked_);
+};
+
+
+/**
+ * Asserts the onClick callback is triggered when Pp link element is clicked.
+ * @private
+ */
+element.TosPpTestHelper.prototype.assertPpLinkClicked_ = function() {
+  assertFalse(this.privacyPolicyLinkClicked_);
+  goog.testing.events.fireClickSequence(this.component.getPpLinkElement());
+  assertTrue(this.privacyPolicyLinkClicked_);
 };
 
 
@@ -103,11 +160,13 @@ element.TosPpTestHelper.prototype.testGetTosPpElement_ = function() {
 /** @private */
 element.TosPpTestHelper.prototype.testGetTosLinkElement_ = function() {
   assertNotNull(this.component.getTosLinkElement());
+  this.assertTosLinkClicked_();
 };
 
 
 /** @private */
 element.TosPpTestHelper.prototype.testGetPpLinkElement_ = function() {
   assertNotNull(this.component.getPpLinkElement());
+  this.assertPpLinkClicked_();
 };
 });

javascript/ui/page/base.js

@@ -25,6 +25,7 @@ goog.require('firebaseui.auth.ui.element');
 goog.require('firebaseui.auth.ui.element.dialog');
 goog.require('firebaseui.auth.ui.element.infoBar');
 goog.require('firebaseui.auth.ui.element.progressDialog');
+goog.require('firebaseui.auth.ui.element.tospp');
 goog.require('firebaseui.auth.ui.mdl');
 goog.require('goog.dom');
 goog.require('goog.dom.classlist');
@@ -159,6 +160,24 @@ firebaseui.auth.ui.page.Base.prototype.enterDocument = function() {
           {
             'pageId': this.getPageId()
           }));
+  // If tos/pp element is available, sets the onClick handler when onClick
+  // callbacks are provided.
+  if (this.getTosLinkElement() && this.injectedData_.tosCallback) {
+    var tosCallback =
+        /** @type {function()} */ (this.injectedData_.tosCallback);
+    firebaseui.auth.ui.element.listenForActionEvent(
+        this, this.getTosLinkElement(), function(e) {
+          tosCallback();
+        });
+  }
+  if (this.getPpLinkElement() && this.injectedData_.privacyPolicyCallback) {
+    var privacyPolicyCallback =
+        /** @type {function()} */ (this.injectedData_.privacyPolicyCallback);
+    firebaseui.auth.ui.element.listenForActionEvent(
+        this, this.getPpLinkElement(), function(e) {
+          privacyPolicyCallback();
+        });
+  }
 };
 
 
@@ -375,5 +394,15 @@ goog.mixin(
       dismissDialog:
           firebaseui.auth.ui.element.dialog.dismissDialog,
       getDialogElement:
-          firebaseui.auth.ui.element.dialog.getDialogElement
+          firebaseui.auth.ui.element.dialog.getDialogElement,
+
+      // For ToS and Privacy Policy.
+      getTosPpElement:
+          firebaseui.auth.ui.element.tospp.getTosPpElement,
+      getTosLinkElement:
+          firebaseui.auth.ui.element.tospp.getTosLinkElement,
+      getPpLinkElement:
+          firebaseui.auth.ui.element.tospp.getPpLinkElement,
+      getTosPpListElement:
+          firebaseui.auth.ui.element.tospp.getTosPpListElement
     });