@shopify/ui-extensions 2025.10.14 → 2025.10.15

package/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts

@@ -3,6 +3,7 @@ import type {
   AutocompleteAddress,
 } from './shared';
 
+/** @publicDocs */
 export interface AddressAutocompleteFormatSuggestionApi {
   /**
    * The autocomplete suggestion that the buyer selected during checkout.

package/src/surfaces/checkout/api/address-autocomplete/standard.ts

@@ -24,6 +24,7 @@ import type {
   Timezone,
 } from '../../../../shared';
 
+/** @publicDocs */
 export interface AddressAutocompleteStandardApi<
   Target extends
     | 'purchase.address-autocomplete.suggest'
@@ -88,7 +89,7 @@ export interface AddressAutocompleteStandardApi<
   /**
    * The details about the location, language, and currency of the customer. For utilities to easily
    * format and translate content based on these details, you can use the
-   * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)
+   * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)
    * object instead.
    */
   localization: Localization;
@@ -122,7 +123,7 @@ export interface AddressAutocompleteStandardApi<
    *
    * If the previous token expires, this value will reflect a new session token with a new signature and expiry.
    *
-   * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information.
+   * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).
    */
   sessionToken: SessionToken;
 

package/src/surfaces/checkout/api/address-autocomplete/suggest.ts

@@ -2,6 +2,7 @@ import type {CountryCode} from '../../../checkout';
 
 import type {AddressAutocompleteSuggestion} from './shared';
 
+/** @publicDocs */
 export interface AddressAutocompleteSuggestApi {
   /**
    * The signal that the extension should listen to for cancellation requests.
@@ -54,8 +55,8 @@ interface Target {
 export interface AddressAutocompleteSuggestOutput {
   /**
    * An array of address autocomplete suggestions to show to the buyer.
-   *
-   * > Note: Only the first five suggestions will be displayed to the buyer.
+   * Checkout displays up to five address suggestions. Return no more
+   * than five. Additional suggestions are ignored.
    */
   suggestions: AddressAutocompleteSuggestion[];
 }

package/src/surfaces/checkout/api/cart-line/cart-line-item.ts

@@ -1,9 +1,17 @@
 import type {SubscribableSignalLike} from '../../shared';
 import type {CartLine} from '../standard/standard';
 
+/** @publicDocs */
 export interface CartLineItemApi {
   /**
-   * The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike<PresentmentCartLine>`.
+   * The cart line that this extension is attached to. Use this to read the
+   * line item's merchandise, quantity, cost, and attributes.
+   *
+   * Available only on the corresponding item target. Shipping option item
+   * targets expose shipping option properties; pickup location item targets
+   * expose pickup location properties.
+   *
+   * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike<PresentmentCartLine>`.
    */
   target: SubscribableSignalLike<CartLine>;
 }