-
Notifications
You must be signed in to change notification settings - Fork 18
Define Coordinator and Client #306
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
marcoscaceres
wants to merge
14
commits into
main
Choose a base branch
from
corrdinator
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
a27dbe3
Define Coordinator and Client
marcoscaceres 774e687
Merge branch 'main' into corrdinator
marcoscaceres f1a4286
Set interaction state default
marcoscaceres edbea34
Merge branch 'main' into corrdinator
marcoscaceres 60c425d
Update index.html
marcoscaceres 964c2ce
Update index.html
marcoscaceres 9d8e72a
Update index.html
marcoscaceres 5377bc8
Update index.html
marcoscaceres be4b2b3
Update index.html
marcoscaceres 58ff6c4
Update index.html
marcoscaceres 9795095
Update index.html
marcoscaceres 3ab6775
Merge branch 'main' into corrdinator
marcoscaceres e33be93
Apply suggestions from code review
marcoscaceres 0c4a1d9
Merge branch 'main' into corrdinator
marcoscaceres File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -285,6 +285,107 @@ <h2> | |||||
identifier=]. See also section [[[#protocol-registry]]]. | ||||||
</dd> | ||||||
</dl> | ||||||
<h3> | ||||||
Credential Request Coordinator | ||||||
</h3> | ||||||
<p> | ||||||
The <dfn>credential request coordinator</dfn> is a user-agent-defined | ||||||
component responsible for mediating [=digital credential=] interactions | ||||||
within a given [=top-level traversable=]. | ||||||
</p> | ||||||
<p> | ||||||
Each [=top-level traversable=] has a single associated [=credential | ||||||
request coordinator=]. | ||||||
</p> | ||||||
<p> | ||||||
The [=credential request coordinator=]: | ||||||
</p> | ||||||
<ul> | ||||||
<li>Ensures that only one [=digital credential=] interaction is active at | ||||||
any time. This includes via both the: | ||||||
<ul> | ||||||
<li>{{DigitalCredential/[[DiscoverFromExternalSource]](origin, | ||||||
options, sameOriginWithAncestors)}} internal method. | ||||||
</li> | ||||||
<li>{{DigitalCredential/[[Create]](origin, options, | ||||||
sameOriginWithAncestors)}} internal method. | ||||||
</li> | ||||||
</ul> | ||||||
</li> | ||||||
<li>Handles state transitions across the following <dfn data-for= | ||||||
"credential request coordinator" data-local-lt="state">interaction | ||||||
states</dfn>: | ||||||
<ul> | ||||||
<li> | ||||||
<dfn data-dfn-for="credential request coordinator">Idle</dfn>: No | ||||||
credential interaction is currently in progress. | ||||||
</li> | ||||||
<li> | ||||||
<dfn data-dfn-for= | ||||||
"credential request coordinator">Ongoing</dfn>: A credential | ||||||
interaction is currently in progress and the user interface is | ||||||
being shown to the user. | ||||||
</li> | ||||||
<li> | ||||||
<dfn data-dfn-for="credential request coordinator">Aborting</dfn>: | ||||||
A credential interaction is being canceled. The coordinator is in | ||||||
the process of cleaning up the interaction. | ||||||
</li> | ||||||
</ul> | ||||||
</li> | ||||||
<li>Manages the lifecycle of the current interaction's promise, including | ||||||
its resolution or rejection. | ||||||
</li> | ||||||
<li>Integrates with an {{AbortSignal}} to allow user-initiated or | ||||||
programmatic cancellation. | ||||||
</li> | ||||||
</ul> | ||||||
<p> | ||||||
The [=credential request coordinator=] is initialized in the [=credential | ||||||
request coordinator/idle=] [=interaction state=]. | ||||||
</p> | ||||||
<h3> | ||||||
Digital Credential Client | ||||||
</h3> | ||||||
<p> | ||||||
A <dfn>digital credential client</dfn> is a user-agent-defined component | ||||||
responsible managing the credential presentation or issuance flow, which | ||||||
includes allowing a user to select from available [=holders=] and coordinating the request. | ||||||
marcoscaceres marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
</p> | ||||||
<p> | ||||||
Each [=credential request coordinator=] uses a single associated | ||||||
[=digital credential client=] to fulfill credential presentation and issuance | ||||||
operations. | ||||||
</p> | ||||||
<p> | ||||||
The [=digital credential client=]: | ||||||
</p> | ||||||
<ul> | ||||||
<li>Validates and transforms digital credential presentation or issuance | ||||||
inputs. | ||||||
</li> | ||||||
<li>Interprets each individual request in the input list as targeting a | ||||||
specific [=holder=], and prepares holder options accordingly. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
</li> | ||||||
Comment on lines
+365
to
+367
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What does this mean? |
||||||
<li>Presents the available [=holders=] to the user for selection. | ||||||
</li> | ||||||
<li>Returns the result — a selected credential or a cancellation — to the | ||||||
[=credential request coordinator=]. | ||||||
</li> | ||||||
</ul> | ||||||
<aside class="note"> | ||||||
<p> | ||||||
Although the [=digital credential client=] coordinates the credential | ||||||
interaction, it is the selected [=holder=] that typically acts as the | ||||||
[=credential chooser=]. | ||||||
</p> | ||||||
<p> | ||||||
In this model, the [=digital credential client=] presents the user with | ||||||
a list of available [=holders=], and the selected [=holder=] then | ||||||
marcoscaceres marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
displays its own user interface for selecting or issuing [=digital | ||||||
credentials=]. | ||||||
</p> | ||||||
marcoscaceres marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
</aside> | ||||||
<h2> | ||||||
Scope | ||||||
</h2> | ||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.