add only address autocomplete changes

Shopify · May 13, 2024 · c30a963 · c30a963
1 parent e18233b
commit c30a963
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.changeset/nasty-hotels-press.md b/.changeset/nasty-hotels-press.md
@@ -0,0 +1,5 @@
+---
+'@shopify/ui-extensions': patch
+---
+
+Added `appMetafields` field to `AddressAutocompleteStandardApi`
diff --git a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts
@@ -1,5 +1,6 @@
 import type {
   Analytics,
+  AppMetafieldEntry,
   Capability,
   CheckoutToken,
   Country,
@@ -28,6 +29,19 @@ export interface AddressAutocompleteStandardApi<
     | 'purchase.address-autocomplete.suggest'
     | 'purchase.address-autocomplete.format-suggestion',
 > {
+  /**
+   * The metafields requested in the
+   * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)
+   * file. These metafields are updated when there's a change in the merchandise items
+   * being purchased by the customer.
+   *
+   * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+   *
+   * > Tip:
+   * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*
+   */
+  appMetafields: AppMetafieldEntry[];
+
   /**
    * Methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.
    */