Merge pull request #2714 from Shopify/zhuo/customer/3p-dev-field-market/country

[Customer][EXT] add country to customer account Standard API.

Author: ottocho

.changeset/fluffy-dolls-rule.md

@@ -0,0 +1,5 @@
+---
+'@shopify/ui-extensions-react': minor
+---
+
+Provide useLocalizationCountry hook to customer-account extension targets

.changeset/funny-dragons-heal.md

@@ -0,0 +1,5 @@
+---
+'@shopify/ui-extensions': minor
+---
+
+Add country to customer account Standard API.

packages/ui-extensions-react/src/surfaces/customer-account/hooks/country.ts

@@ -1,18 +1,19 @@
 import {
   Country,
-  RenderOrderStatusExtensionTarget,
+  RenderExtensionTarget,
 } from '@shopify/ui-extensions/customer-account';
 
 import {useApi} from './api';
 import {useSubscription} from './subscription';
 import {ExtensionHasNoFieldError} from '../errors';
 
 /**
- * Returns the country of the checkout, and automatically re-renders
- * your component if the country changes.
+ * Returns the country associated with either the current order on the order status page
+ * or the selected country in the customer account interface,
+ * and automatically re-renders your component if the country changes.
  */
 export function useLocalizationCountry<
-  Target extends RenderOrderStatusExtensionTarget = RenderOrderStatusExtensionTarget,
+  Target extends RenderExtensionTarget = RenderExtensionTarget,
 >(): Country | undefined {
   const api = useApi<Target>();
   const extensionTarget = api.extension.target;

packages/ui-extensions/docs/surfaces/customer-account/reference/apis/localization.doc.ts

@@ -20,6 +20,12 @@ const data: ReferenceEntityTemplateSchema = {
         "Returns the buyer's language, as supported by the extension. If the buyer's actual language is not supported by the extension, it will return the fallback locale used for translations.",
       type: 'UseLanguageGeneratedType',
     },
+    {
+      title: 'useLocalizationCountry',
+      description:
+        "Returns the country of the buyer's current session, and automatically re-renders your component if the country changes.",
+      type: 'UseLocalizationCountryGeneratedType',
+    },
     {
       title: 'useExtensionLanguage',
       description:

packages/ui-extensions/src/shared.ts

@@ -860,6 +860,14 @@ export type CountryCode =
   | 'ZW'
   | 'ZZ';
 
+export interface Country {
+  /**
+   * The ISO-3166-1 code for this country.
+   * @see https://www.iso.org/iso-3166-country-codes.html
+   */
+  isoCode: CountryCode;
+}
+
 // For instructions on how to update this list see: https://github.com/Shopify/checkout-web/pull/39534
 /**
  * A union of keys for the localized fields that are required by certain countries.

packages/ui-extensions/src/surfaces/checkout.ts

@@ -42,7 +42,6 @@ export type {
   I18n,
   I18nTranslate,
   Currency,
-  Country,
   Market,
   Language,
   Localization,

packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts

@@ -3,7 +3,6 @@ import type {
   AppMetafieldEntry,
   Capability,
   CheckoutToken,
-  Country,
   Currency,
   Editor,
   ExtensionSettings,
@@ -19,6 +18,7 @@ import type {
 import type {Attribute, MailingAddress} from '../shared';
 import type {
   ApiVersion,
+  Country,
   GraphQLError,
   StorefrontApiVersion,
   Timezone,

packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts

@@ -12,6 +12,7 @@ import type {
   ApiVersion,
   Capability,
   CurrencyCode,
+  Country,
   CountryCode,
   Timezone,
   GraphQLError,
@@ -334,14 +335,6 @@ export interface Currency {
   isoCode: CurrencyCode;
 }
 
-export interface Country {
-  /**
-   * The ISO-3166-1 code for this country.
-   * @see https://www.iso.org/iso-3166-country-codes.html
-   */
-  isoCode: CountryCode;
-}
-
 export interface Market {
   /**
    * A globally-unique identifier for a market.

packages/ui-extensions/src/surfaces/customer-account/api.ts

@@ -24,7 +24,6 @@ export type {
   CartCustomDiscountAllocation,
   AppliedGiftCard,
   Currency,
-  Country,
   Market,
   DeliveryGroup,
   DeliveryGroupType,
@@ -47,6 +46,7 @@ export type {
 export type {
   Attribute,
   CurrencyCode,
+  Country,
   CountryCode,
   Timezone,
   GraphQLError,

packages/ui-extensions/src/surfaces/customer-account/api/order-status/order-status.ts

@@ -2,7 +2,7 @@ import type {StatefulRemoteSubscribable} from '@remote-ui/async-subscription';
 
 import type {
   CurrencyCode,
-  CountryCode,
+  Country,
   Timezone,
   SellingPlan,
   Attribute,
@@ -122,14 +122,6 @@ export interface Currency {
   isoCode: CurrencyCode;
 }
 
-export interface Country {
-  /**
-   * The ISO-3166-1 code for this country.
-   * @see https://www.iso.org/iso-3166-country-codes.html
-   */
-  isoCode: CountryCode;
-}
-
 export interface Market {
   /**
    * A globally-unique identifier for a market.