addressfield.json - v1.1.0

This release includes all of the JSON configuration schema changes and improvements from v1.0.0. In addition to those changes, significant data quality improvements have been made, more accurately representing the way different countries represent their address forms.

Thanks to the Commerce Guys for their meticulous research upon which these improvements are based.

Highlights below.

Additional administrative division lists

• Argentina [#52]
• Chile [#51]
• Egypt [#50]
• Hong Kong [#48]
• Indonesia [#47]
• Ireland [#46]
• Jamaica [#45]
• Malaysia [#42]
• Mexico [#43]
• Peru [#41]
• Russia [#40]
• South Korea [#44]
• Spain [#49]
• Taiwan [#38]
• Turkey [#39]
• Tuvalu [#57]
• United Arab Emirates [#53]
• United States (armed forces) [#37]
• Venezuela [#36]

Improvements to field orders and labeling

• Afghanistan [#34]
• American Samoa [#105]
• Armenia [#106]
• Australia [#104]
• Bahamas [#102]
• Belarus [#101]
• Brazil [#103]
• Cape Verde [#98]
• Cayman Islands [#83]
• China [#99]
• Christmas Island [#97]
• Cocos (Keeling) Islands [#100]
• Egypt [#96]
• El Salvador [#59]
• French Polynesia [#69]
• Gibraltar [#94]
• Guam [#93]
• Honduras [#92]
• India [#89]
• Indonesia [#91]
• Iran [#87]
• Iraq [#88]
• Ireland [#90]
• Kazakhstan [#82]
• Kiribati [#86]
• Malaysia [#77]
• Marshall Islands [#81]
• Mexico [#78]
• Micronesia [#95]
• Mongolia [#80]
• Mozambique [#76]
• Nauru [#72]
• Nicaragua [#73]
• Norfolk Island [#75]
• Northern Mariana Islands [#79]
• Palau [#65]
• Panama [#71]
• Papua New Guinea [#68]
• Peru [#70]
• Philippines [#67]
• Puerto Rico [#66]
• Russia [#64]
• Saint Kitts and Nevis [#85]
• San Marino [#62]
• Seychelles [#63]
• Somalia [#61]
• South Korea [#84]
• Suriname [#60]
• Thailand [#58]
• Tuvalu [#57]
• Ukraine [#55]
• United Arab Emirates [#53]
• US Minor Outlying Islands [#56]
• Uzbekistan [#54]

New postal code validations

• Aland Islands [#108]
• Austria [#107]
• Belgium [#109]
• Denmark [#112]
• Finland [#113]
• French Guiana [#114]
• Guernsey [#115]
• Greeland [#116]
• Guadeloupe [#117]
• Greece [#118]
• Isle of Man [#119]
• Jersey [#120]
• Liechtenstein [#121]
• Luxembourg [#122]
• Martinique [#124]
• Mayotte [#135]
• New Caledonia [#125]
• Norway [#126]
• Poland [#127]
• Portugal [#129]
• Reunion [#130]
• Saint Barthelemy [#110]
• Saint Helena [#132]
• Saint Martin [#123]
• Saint Pierre and Miquelon [#128]
• Svalbard and Jan Mayen [#133]
• Sweden [#131]
• Switzerland [#111]
• Wallis and Futuna [#134]

Notes

If you are using addressfield.json v1.0.0, you should have no problem dropping in v1.1.0 in-place. If you are on a version older than 1.0.0, you will need to update your implementations.

Also see also the addressfield.json v1.0.0 release notes.

addressfield.json - v1.0.0

v1.0.0

This release is a complete overhaul of the old addressfield.json configuration schema. With the new schema comes support for several new concepts:

• Countries, fields, and options are now explicitly ordered.
• Fields can include format definitions (as regular expressions) and relatedly, example values.

For detailed examples, see below, or read the latest README.

As the major version bump suggests, v1.0.x and v0.1.x are incompatible; update your implementations accordingly. Support for v0.1.x will be phased out.

Explicit ordering via JSON arrays

This is a significant change to the configuration schema, but with it comes support for:

Explicitly ordered countries

Since this configuration defines postal address input on a country-by-country basis, it makes sense to render the country field first--as a select list--and display dependent fields based on the selected country.

In v0.1.x releases, it was up to the implementor to ensure proper order of the country list. With this release, the order of countries is now made explicit.

{
  "label": "Country",
  "options": [
    {},
    {}
  ]
}

Explicitly ordered fields

Address field order varies on a country-by-country basis (it's not always city, state, zip). This release makes these orders explicit by wrapping fields and their definitions in an array.

{
  "label": "United States",
  "iso": "US",
  "fields": [
    {},
    {}
  ]
}

Explicitly ordered select list options

Dynamic collation is hard, especially when factoring in different languages / locales. Beyond that, some countries list their administrative regions in ways completely independent of language (e.g. Japanese prefectures being listed north-to-south). This release makes these orders explicit by wrapping select list options in an array.

{
  "administrativearea": {
    "label": "State",
    "options": [
      {"AL":"Alabama"},
      {"AK":"Alaska"}
    ]
  }
}

Optional field-level format definitions

Fields can now (optionally) include format definitions. The primary use-case is for adding validation for fields like postal codes. In addition to format definitions, fields can also specify an example value (useful for placeholder text or for enriching validation messages).

{
  "postalcode": {
    "label": "ZIP code",
    "format":"\\d{5}(?:[-\\s]\\d{4})?$",
    "eg": "98103"
  }
}

For complete details on all of the above, check the latest README.

addressfield.json - v0.1.3

Issues fixed in this release:

• The "locality name" field for Bhutan is now properly nested under the locality fieldset [#6]

addressfield.json - v0.1.2

Issues fixed in this release:

• The "Postal code" field for Alan Islands is now properly nested under the locality fieldset [#4]
• Added automated JSON linting and minification to ensure high quality releases going forward [#5]

addressfield.json - v.0.1.1

Issues fixed in this release:

• Fixed typo in New Zealand administrative region "Auckland." [#1]

addressfield.json - v.0.1.0

v0.1.0

Initial commit.