V3.6.1 (#582)

- updated externs and typescript for SAML/OIDC
- updated changelog and readme for v3.6.1

Author: wti806

README.md

@@ -70,17 +70,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.6.0/firebase-ui-auth__{LANGUAGE_CODE}.js"></script>
-<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/3.6.0/firebase-ui-auth.css" />
+<script src="https://www.gstatic.com/firebasejs/ui/3.6.1/firebase-ui-auth__{LANGUAGE_CODE}.js"></script>
+<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/3.6.1/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.6.0/firebase-ui-auth__fr.js`. The list of available
+`https://www.gstatic.com/firebasejs/ui/3.6.1/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.6.0/firebase-ui-auth-rtl.css`, instead of the default
+`https://www.gstatic.com/firebasejs/ui/3.6.1/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

changelog.txt

@@ -0,0 +1,2 @@
+fixed - Fixed the issue where the providerName for generic OAuth, OIDC and SAML providers does not default to providerId.
+fixed - Added externs and typescript type declaration for generic OAuth, OIDC and SAML providers sign-in options.

externs/firebaseui-externs.js

@@ -377,6 +377,143 @@ firebaseui.auth.FederatedSignInOption.prototype.scopes;
  */
 firebaseui.auth.FederatedSignInOption.prototype.customParameters;
 
+
+/**
+ * Defines the sign-in option needed to configure the FirebaseUI SAML
+ * sign-in widget.
+ *
+ * @interface
+ * @extends {firebaseui.auth.SignInOption}
+ */
+firebaseui.auth.SamlSignInOption = function() {};
+
+/**
+ * The provider name displayed to end users
+ * (sign-in button label/linking prompt).
+ * Default: provider ID
+ *
+ * @type {string|undefined}
+ */
+firebaseui.auth.SamlSignInOption.prototype.providerName;
+
+/**
+ * The color of the sign-in button.
+ *
+ * @type {string}
+ */
+firebaseui.auth.SamlSignInOption.prototype.buttonColor;
+
+/**
+ * The URL of the Identity Provider's icon. This will be displayed on the
+ * provider's sign-in button, etc.
+ *
+ * @type {string}
+ */
+firebaseui.auth.SamlSignInOption.prototype.iconUrl;
+
+
+/**
+ * Defines the sign-in option needed to configure the FirebaseUI generic OAuth
+ * sign-in widget.
+ *
+ * @interface
+ * @extends {firebaseui.auth.SignInOption}
+ */
+firebaseui.auth.OAuthSignInOption = function() {};
+
+/**
+ * The provider name displayed to end users
+ * (sign-in button label/linking prompt),
+ * eg. "Microsoft". Default: provider ID, eg. "microsoft.com"
+ *
+ * @type {string|undefined}
+ */
+firebaseui.auth.OAuthSignInOption.prototype.providerName;
+
+/**
+ * The color of the sign-in button.
+ *
+ * @type {string}
+ */
+firebaseui.auth.OAuthSignInOption.prototype.buttonColor;
+
+/**
+ * The URL of the Identity Provider's icon. This will be displayed on the
+ * provider's sign-in button, etc.
+ *
+ * @type {string}
+ */
+firebaseui.auth.OAuthSignInOption.prototype.iconUrl;
+
+/**
+ * The list of additional OAuth 2.0 scopes beyond basic profile that you want
+ * to request from the authentication provider.
+ *
+ * @type {!Array<string>|undefined}
+ */
+firebaseui.auth.OAuthSignInOption.prototype.scopes;
+
+/**
+ * The custom OAuth parameters for the selected OAuth provider.
+ *
+ * @type {!Object|undefined}
+ */
+firebaseui.auth.OAuthSignInOption.prototype.customParameters;
+
+/**
+ * The key of the custom parameter, with which the login hint can be passed to
+ * the provider. This is useful in case a user previously signs up with an IdP
+ * like Microsoft and then tries to sign in with email using the same Microsoft
+ * email. FirebaseUI can then ask the user to sign in with that email to the
+ * already registered account with Microsoft. For Microsoft and Yahoo, this
+ * field is `login_hint`.
+ *
+ * @type {string|undefined}
+ */
+firebaseui.auth.OAuthSignInOption.prototype.loginHintKey;
+
+
+/**
+ * Defines the sign-in option needed to configure the FirebaseUI OIDC
+ * sign-in widget.
+ *
+ * @interface
+ * @extends {firebaseui.auth.SignInOption}
+ */
+firebaseui.auth.OidcSignInOption = function() {};
+
+/**
+ * The provider name displayed to end users
+ * (sign-in button label/linking prompt).
+ * Default: provider ID
+ *
+ * @type {string|undefined}
+ */
+firebaseui.auth.OidcSignInOption.prototype.providerName;
+
+/**
+ * The color of the sign-in button.
+ *
+ * @type {string}
+ */
+firebaseui.auth.OidcSignInOption.prototype.buttonColor;
+
+/**
+ * The URL of the Identity Provider's icon. This will be displayed on the
+ * provider's sign-in button, etc.
+ *
+ * @type {string}
+ */
+firebaseui.auth.OidcSignInOption.prototype.iconUrl;
+
+/**
+ * The list of additional custom parameters that the OIDC provider supports.
+ *
+ * @type {!Object|undefined}
+ */
+firebaseui.auth.OidcSignInOption.prototype.customParameters;
+
+
 /**
  * Defines the sign-in option needed to configure the FirebaseUI email sign-in
  * widget.

types/index.d.ts

@@ -32,13 +32,40 @@ interface SignInOption {
   provider: string;
 }
 
+
+interface SamlSignInOption extends SignInOption {
+  providerName?: string;
+  buttonColor: string;
+  iconUrl: string;
+}
+
+
 interface FederatedSignInOption extends SignInOption {
   authMethod?: string;
   clientId?: string;
   scopes?: string[];
   customParameters?: object;
 }
 
+
+interface OAuthSignInOption extends SignInOption {
+  providerName?: string;
+  buttonColor: string;
+  iconUrl: string;
+  scopes?: string[];
+  customParameters?: object;
+  loginHintKey?: string;
+}
+
+
+interface OidcSignInOption extends SignInOption {
+  providerName?: string;
+  buttonColor: string;
+  iconUrl: string;
+  customParameters?: object;
+}
+
+
 interface ActionCodeSettings {
   url: string;
   handleCodeInApp?: boolean;
@@ -83,8 +110,9 @@ declare namespace firebaseui.auth {
     queryParameterForSignInSuccessUrl?: string;
     queryParameterForWidgetMode?: string;
     signInFlow?: string;
-    signInOptions?: Array<string
-      | FederatedSignInOption | EmailSignInOption | PhoneSignInOption>;
+    signInOptions?:
+        Array<string|FederatedSignInOption|EmailSignInOption|PhoneSignInOption|
+              SamlSignInOption|OAuthSignInOption|OidcSignInOption>;
     signInSuccessUrl?: string;
     siteName?: string;
     tosUrl?: (() => void) | string;