Skip to content
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.

Sign up for GitHub

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

Move Address definitions/interfaces from the Payment Request API. #39

Merged
merged 2 commits into from
Aug 10, 2021
+102 −9
Merged

Move Address definitions/interfaces from the Payment Request API. #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9efed14
Move Address definitions/interfaces from the Payment Request API.
rayankans May 11, 2021
68846c2
Add note about the ContactAddress and link to relevant issue
rayankans Aug 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,19 @@ selectRecipientsButton.addEventListener('click', async () => {
```WebIDL
enum ContactProperty { "address", "email", "icon", "name", "tel" };
interface ContactAddress : PaymentAddress {};
interface ContactAddress {
[Default] object toJSON();
readonly attribute DOMString city;
readonly attribute DOMString country;
readonly attribute DOMString dependentLocality;
readonly attribute DOMString organization;
readonly attribute DOMString phone;
readonly attribute DOMString postalCode;
readonly attribute DOMString recipient;
readonly attribute DOMString region;
readonly attribute DOMString sortingCode;
readonly attribute FrozenArray<DOMString> addressLine;
};
dictionary ContactInfo {
sequence<ContactAddress> address;
Expand Down
97 changes: 89 additions & 8 deletions spec/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@ spec:html; type:dfn; for:/; text:origin
spec:html; type:dfn; for:/; text:valid e-mail address
</pre>

<pre class="anchors">
spec: payment-request; urlPrefix: https://www.w3.org/TR/payment-request/
type: dfn; text: physical addresses; url: physical-addresses
type: interface; text: PaymentAddress; url: dom-paymentaddress
</pre>

# Introduction # {#intro}

Contact pickers are frequently seen in various desktop and native mobile applications for a variety
Expand Down Expand Up @@ -162,6 +156,35 @@ The <dfn>contact picker task source</dfn> is a [=task source=].
[=contact picker task source=] to run |steps|.
</div>

## Physical address ## {#infrastructure-physical-address}

A <dfn>physical address</dfn> consists of:
<div dfn-for="physical address">

* <dfn>country</dfn>, a {{DOMString}} representing the country of the address as an
[[ISO3166-1]] alpha-2 code stored in its canonical uppercase form or the empty string. For
example, "JP".
* <dfn>address line</dfn>, a [=list=] of {{DOMString}}s, containing the most specific part of the
address. It can include, for example, a street name, a house number, apartment number, a rural
delivery route, descriptive instructions, or a post office box number.
* <dfn>region</dfn>, a {{DOMString}} representing the top level administrative subdivision of the
country. For example, this can be a state, a province, an oblast, or a prefecture.
* <dfn>city</dfn>, a {{DOMString}} representing the city/town portion of the address.
* <dfn>dependent locality</dfn>, a {{DOMString}} representing the dependent locality or sublocality
within a city. For example, neighborhoods, boroughs, districts, or UK dependent localities.
* <dfn>postal code</dfn>, a {{DOMString}} representing the postal code or ZIP code, also known as
PIN code in India.
* <dfn>sorting code</dfn>, a {{DOMString}} representing the sorting code system, such as the CEDEX
system used in France.
* <dfn>organization</dfn>, a {{DOMString}} representing the organization, firm, company, or
institution at the address.
* <dfn>recipient</dfn>, a {{DOMString}} representing the name of the recipient or contact person at
the address.
* <dfn>phone number</dfn>, a {{DOMString}} representing the phone number of the recipient or contact
person at the address, optionally structured to adhere to [[E.164]].

</div>

## User contact ## {#infrastructure-user-contact}

A <dfn>user contact</dfn> consists of:
Expand All @@ -180,6 +203,8 @@ A <dfn>user contact</dfn> consists of:

NOTE: An icon {{Blob}}'s {{Blob/type}} is an [=image mime type=].

</div>

A [=user contact=] contains data relating to a single user.

Note: The lists can be of different sizes, and entries with the same index don't need to correspond
Expand Down Expand Up @@ -243,12 +268,68 @@ field can be accessed by the user agent.
: "tel"
:: Associated with [=user contact=]'s [=user contact/numbers=].

## {{ContactsManager}} ## {#contacts-manager}
## {{ContactAddress}} ## {#contact-address}

<script type="idl">
[Exposed=Window]
interface ContactAddress : PaymentAddress {};
interface ContactAddress {
[Default] object toJSON();
readonly attribute DOMString city;
readonly attribute DOMString country;
readonly attribute DOMString dependentLocality;
readonly attribute DOMString organization;
readonly attribute DOMString phone;
readonly attribute DOMString postalCode;
readonly attribute DOMString recipient;
readonly attribute DOMString region;
readonly attribute DOMString sortingCode;
readonly attribute FrozenArray<DOMString> addressLine;
};
</script>

The {{ContactAddress}} interface represents a [=physical address=].

<div dfn-for="ContactAddress">
A {{ContactAddress}} instance has:

* An <dfn>address</dfn> (a [=physical address=]).

The <dfn attribute>city</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/city=].

The <dfn attribute>country</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/country=].

The <dfn attribute>dependentLocality</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/dependent locality=].

The <dfn attribute>organization</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/organization=].

The <dfn attribute>phone</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/phone number=].

The <dfn attribute>postalCode</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/postal code=].

The <dfn attribute>recipient</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/recipient=].

The <dfn attribute>region</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/region=].

The <dfn attribute>sortingCode</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/sorting code=].

The <dfn attribute>addressLine</dfn> attribute's getter must return the [=context object=]'s
[=ContactAddress/address=]' [=physical address/address line=].
</div>

Issue: Is this the right spec for the interface to live in? ([issue](https://github.com/WICG/contact-api/issues/43))
rayankans marked this conversation as resolved.
Show resolved Hide resolved

## {{ContactsManager}} ## {#contacts-manager}

<script type="idl">
dictionary ContactInfo {
sequence<ContactAddress> address;
sequence<DOMString> email;
Expand Down