Skip to content

Commit e6ce288

Browse files
tttzachTallTed
tttzach
and
TallTed
authored
Specify the mode API (#660)
* Add mode for FedCM Fixes w3c-fedid/active-mode#2 * Update index.bs * Update index.bs * Lint index.bs * Update spec/index.bs Co-authored-by: Ted Thibodeau Jr <[email protected]> * Update index.bs * Update spec/index.bs Co-authored-by: Ted Thibodeau Jr <[email protected]> * Update index.bs * Update index.bs * Update index.bs * Update index.bs * Update index.bs * Update index.bs * Update index.bs * Update index.bs * Update index.bs * Update index.bs --------- Co-authored-by: Ted Thibodeau Jr <[email protected]>
1 parent 042beec commit e6ce288

File tree

1 file changed

+54
-23
lines changed

1 file changed

+54
-23
lines changed

‎spec/index.bs

+54-23
Original file line numberDiff line numberDiff line change
@@ -623,8 +623,11 @@ This specification introduces an extension to the {{CredentialRequestOptions}} o
623623
The {{IdentityCredentialRequestOptions}} contains a list of
624624
{{IdentityProviderConfig}}s that the [=RP=] supports and has
625625
pre-registered with (i.e. the [=IDP=] has given the [=RP=] a `clientId`).
626-
The {{IdentityCredentialRequestOptions}} also contains a {{IdentityCredentialRequestOptionsContext}}
627-
which the user agent can use to provide a more meaningful dialog to users.
626+
The {{IdentityCredentialRequestOptions}} also contains an
627+
{{IdentityCredentialRequestOptionsContext}}, which the user agent can use to
628+
provide a more meaningful dialog to users, and an
629+
{{IdentityCredentialRequestOptionsMode}}, which the user agent can use to
630+
specify different behaviors or dialog types.
628631

629632
<xmp class=idl>
630633
enum IdentityCredentialRequestOptionsContext {
@@ -634,9 +637,15 @@ enum IdentityCredentialRequestOptionsContext {
634637
"continue"
635638
};
636639

640+
enum IdentityCredentialRequestOptionsMode {
641+
"active",
642+
"passive"
643+
};
644+
637645
dictionary IdentityCredentialRequestOptions {
638646
required sequence<IdentityProviderRequestOptions> providers;
639647
IdentityCredentialRequestOptionsContext context = "signin";
648+
IdentityCredentialRequestOptionsMode mode = "passive";
640649
};
641650
</xmp>
642651

@@ -775,27 +784,34 @@ To <dfn>create an IdentityCredential</dfn> given an {{IdentityProviderRequestOpt
775784
or a pair (failure, bool), where the bool indicates whether to skip delaying
776785
the exception thrown.
777786
1. Assert: These steps are running [=in parallel=].
787+
1. Let |mode| be |options|'s {{IdentityCredentialRequestOptions/mode}}.
788+
1. If |mode| is [=active=]:
789+
1. Let |W| be |globalObject|'s [=associated Window=].
790+
1. If |W| does not have [=transient activation=], return (failure, true).
791+
1. Otherwise, if there is a pending request where |mode| is [=passive=]
792+
on |W|'s [=Window/navigable=]'s [=navigable/top-level traversable=]
793+
or on any of its descendants, reject the pending request with a
794+
"{{NetworkError}}" {{DOMException}}.
778795
1. Let |loginStatus| be the result of [=get the login status=] with
779796
the [=/origin=] of |provider|'s {{IdentityProviderConfig/configURL}}.
780797
1. If |loginStatus| is [=unknown=], a user agent MAY set it to [=logged-out=].
781-
1. If |loginStatus| is [=logged-out=], the user agent MUST do one of the following:
782-
783-
* Return (failure, false).
784-
* Prompt the user whether to continue. If the user continues, the user
785-
agent SHOULD set |loginStatus| to [=unknown=]. This MAY include an
786-
affordance to [=show an IDP login dialog=].
787-
788-
* If the user cancels this dialog, return (failure, true).
789-
* If the user triggers this affordance:
790-
1. Let |config| be the result of running [=fetch the config file=]
791-
with |provider| and |globalObject|.
792-
1. If |config| is failure, return (failure, true).
793-
1. [=Show an IDP login dialog=] with |config| and |provider|.
794-
1. If that algorithm returns failure, return (failure, true).
795-
796-
Issue: We should perhaps provide a way to let the [=RP=] request that
797-
the second option is provided, possibly gated on a user gesture.
798-
See [this issue](https://github.com/fedidcg/FedCM/issues/442) for discussion.
798+
1. If |loginStatus| is [=logged-out=]:
799+
1. If |mode| is [=active=]:
800+
1. Let |result| be the result of running
801+
[=fetch the config file and show an IDP login dialog=] with
802+
|provider| and |globalObject|.
803+
1. If |result| is failure, return (failure, true).
804+
1. Otherwise, the user agent MUST do one of the following:
805+
* Return (failure, false).
806+
* Prompt the user whether to continue. If the user continues, the user
807+
agent SHOULD set |loginStatus| to [=unknown=]. This MAY include an
808+
affordance to [=show an IDP login dialog=].
809+
* If the user cancels this dialog, return (failure, true).
810+
* If the user triggers this affordance:
811+
1. Let |result| be the result of running
812+
[=fetch the config file and show an IDP login dialog=]
813+
with |provider| and |globalObject|.
814+
1. If |result| is failure, return (failure, true).
799815
1. Let |requiresUserMediation| be |provider|'s {{IdentityProviderConfig/configURL}}'s [=/origin=]'s
800816
[=requires user mediation=].
801817
1. Let |mediation| be |options|'s {{CredentialRequestOptions/mediation}}.
@@ -885,7 +901,8 @@ the exception thrown.
885901
1. If [=compute the connection status=] of |account|, |provider| and |globalObject| returns
886902
[=compute the connection status/connected=], show a dialog to request user permission to sign
887903
in via |account|, and set the result in |permission|. The user agent MAY use |options|'s
888-
{{IdentityCredentialRequestOptions/context}} to customize the dialog.
904+
{{IdentityCredentialRequestOptions/context}} and |options|'s
905+
{{IdentityCredentialRequestOptions/mode}} to customize the dialog.
889906
1. Otherwise, let |permission| be the result of running [=request permission to sign-up=]
890907
algorithm with |account|, |config|, |provider|, and |globalObject|. Also set
891908
|disclosureTextShown| to true.
@@ -1297,8 +1314,9 @@ an {{IdentityProviderAPIConfig}} |config|, an {{IdentityProviderRequestOptions}}
12971314
is defined, and the |provider|'s {{IdentityProviderConfig/clientId}} is not in the list of
12981315
|account|["{{IdentityProviderAccount/approved_clients}}"], then the user agent MUST display
12991316
the |metadata|["{{IdentityProviderClientMetadata/terms_of_service_url}}"] link.
1300-
1. The user agent MAY use the {{IdentityCredentialRequestOptions/context}} to customize the
1301-
dialog shown.
1317+
1. The user agent MAY use the
1318+
{{IdentityCredentialRequestOptions/context}} and |options|'s
1319+
{{IdentityCredentialRequestOptions/mode}} to customize the dialog shown.
13021320
1. If the user does not grant permission, return false.
13031321
1. [=Create a connection between the RP and the IdP account=] with |provider|, |account|, and
13041322
|globalObject|.
@@ -1465,6 +1483,19 @@ success or failure.
14651483
1. Otherwise, return failure.
14661484
</div>
14671485

1486+
<div algorithm>
1487+
To <dfn>fetch the config file and show an IDP login dialog</dfn> given an
1488+
{{IdentityProviderConfig}} |provider|, and a |globalObject|, run the following
1489+
steps. This returns success or failure.
1490+
1. Assert: these steps are running [=in parallel=].
1491+
1. Let |config| be the result of running [=fetch the config file=]
1492+
with |provider| and |globalObject|.
1493+
1. If |config| is failure, return failure.
1494+
1. [=Show an IDP login dialog=] with |config| and |provider|.
1495+
1. If that algorithm succeeds, return success.
1496+
1. Otherwise, return failure.
1497+
</div>
1498+
14681499
<!-- ============================================================ -->
14691500
## The IdentityProvider Interface ## {#browser-api-identity-provider-interface}
14701501
<!-- ============================================================ -->

0 commit comments

Comments
 (0)