npm - @shopify/ui-extensions - Versions diffs - 2026.4.0-rc.3 → 2026.4.1 - Mend

@shopify/ui-extensions 2026.4.0-rc.3 → 2026.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1103) hide show

package/build/esm/surfaces/checkout/shared.mjs CHANGED Viewed

@@ -2,13 +2,9 @@
  * The list of supported components.
  * As of October 1st, 2025, this is a subset of the components that will be available in the 2025-10 stable release.
  */
-const SUPPORTED_COMPONENTS = ['Abbreviation', 'Announcement', 'Badge', 'Banner', 'Box', 'Button', 'Checkbox', 'Chip', 'Choice', 'ChoiceList', 'Clickable', 'ClickableChip', 'ClipboardItem', 'ConsentCheckbox', 'ConsentPhoneField', 'DateField', 'DatePicker', 'Details', 'Divider', 'DropZone', 'EmailField', 'Form', 'Grid', 'GridItem', 'Heading', 'Icon', 'Image', 'Link', 'ListItem', 'Map', 'MapMarker', 'Modal', 'MoneyField', 'NumberField', 'Option', 'OrderedList', 'Paragraph', 'PasswordField', 'PaymentIcon', 'PhoneField', 'Popover', 'PressButton', 'ProductThumbnail', 'Progress', 'QueryContainer', 'QRCode', 'ScrollBox', 'Section', 'Select', 'Sheet', 'SkeletonParagraph', 'Spinner', 'Stack', 'Summary', 'Switch', 'Text', 'TextArea', 'TextField', 'Time', 'Tooltip', 'UnorderedList', 'UrlField'];
+const SUPPORTED_COMPONENTS = ['Abbreviation', 'Announcement', 'Badge', 'Banner', 'Box', 'Button', 'Chat', 'Checkbox', 'Chip', 'Choice', 'ChoiceList', 'Clickable', 'ClickableChip', 'ClipboardItem', 'ConsentCheckbox', 'ConsentPhoneField', 'DateField', 'DatePicker', 'Details', 'Divider', 'DropZone', 'EmailField', 'Form', 'Grid', 'GridItem', 'Heading', 'Icon', 'Image', 'Link', 'ListItem', 'Map', 'MapMarker', 'Modal', 'MoneyField', 'NumberField', 'Option', 'OrderedList', 'Paragraph', 'PasswordField', 'PaymentIcon', 'PhoneField', 'Popover', 'PressButton', 'ProductThumbnail', 'Progress', 'QueryContainer', 'QRCode', 'ScrollBox', 'Section', 'Select', 'Sheet', 'SkeletonParagraph', 'Spinner', 'Stack', 'Summary', 'Switch', 'Text', 'TextArea', 'TextField', 'Time', 'Tooltip', 'UnorderedList', 'UrlField'];
-/**
- * Note: Chat is not supported in the 2025-10 release candidate, but it is tied to a target, and we don't want to remove the target documentation.
- * Once Chat is supported, you can remove this note.
- * @private
- */
+/** @publicDocs */
 /**
  * The list of supported components.
@@ -16,16 +12,7 @@ const SUPPORTED_COMPONENTS = ['Abbreviation', 'Announcement', 'Badge', 'Banner',
  */
 /**
- * Represents a read-only value managed on the main thread that an extension can subscribe to.
- *
- * Example: Checkout uses this to manage the state of an object and
- * communicate state changes to extensions running in a sandboxed web worker.
- *
- * This interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).
- *
- * Some fields are deprecated but still supported for backwards compatibility.
- * In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.
- *
+ * Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern. This interface extends `ReadonlySignalLike` with deprecated fields that are still supported for backwards compatibility.
  */
 export { SUPPORTED_COMPONENTS };

package/build/esm/surfaces/checkout/style/style.mjs CHANGED Viewed

@@ -25,6 +25,7 @@ const when = function when(conditions, value) {
 // This interface is only used to provide documentation for the Style helper.
 // It is not used in the implementation.
+/** @publicDocs */
 /**
  * Style is a helper for authoring conditional values for prop styles.

package/build/esm/surfaces/point-of-sale/types/storage.mjs CHANGED Viewed

@@ -1,3 +1,6 @@
+/**
+ * @publicDocs
+ */
 class StorageError extends Error {
   constructor(code, message) {
     super(message);
@@ -7,6 +10,7 @@ class StorageError extends Error {
 }
 /**
  * Defines the storage interface for persisting extension data across sessions.
+ * @publicDocs
  */
 export { StorageError };

package/build/esnext/surfaces/checkout/preact/api.esnext CHANGED Viewed

@@ -13,6 +13,7 @@ import { CheckoutUIExtensionError } from './errors.esnext';
  * > Note:
  * > As of version 2025-10, you no longer need this hook. The full API object is accessible via
  * > the global `shopify` object.
+ * @publicDocs
  */
 function useApi(_target) {
   const api = globalThis === null || globalThis === void 0 ? void 0 : globalThis.shopify;
@@ -35,6 +36,7 @@ function useApi(_target) {
  * > Caution: This is deprecated, use `useApi` instead.
  *
  * @deprecated This is deprecated, use `useApi` instead.
+ * @publicDocs
  */
 function useExtensionApi() {
   return useApi();

package/build/esnext/surfaces/checkout/preact/app-metafields.esnext CHANGED Viewed

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the metafields configured with `shopify.extension.toml`.
  * @arg {AppMetafieldFilters} - filter the list of returned metafields
+ * @publicDocs
  */
 function useAppMetafields(filters = {}) {
   const appMetafields = useSubscription(useApi().appMetafields);

package/build/esnext/surfaces/checkout/preact/attributes.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the proposed `attributes` applied to the checkout.
+ * @publicDocs
  */
 function useAttributes() {
   return useSubscription(useApi().attributes);
@@ -13,6 +14,7 @@ function useAttributes() {
  * Returns the values for the specified `attributes` applied to the checkout.
  *
  * @param keys - An array of attribute keys.
+ * @publicDocs
  */
 function useAttributeValues(keys) {
   const attributes = useAttributes();
@@ -27,6 +29,7 @@ function useAttributeValues(keys) {
 /**
  * Returns a function to mutate the `attributes` property of the checkout.
+ * @publicDocs
  */
 function useApplyAttributeChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/billing-address.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the proposed `billingAddress` applied to the checkout.
+ * @publicDocs
  */
 function useBillingAddress() {
   const billingAddress = useApi().billingAddress;

package/build/esnext/surfaces/checkout/preact/buyer-identity.esnext CHANGED Viewed

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.esnext';
  * Returns the current `Customer`.
  *
  * The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.
+ * @publicDocs
  */
 function useCustomer() {
   const buyerIdentity = useApi().buyerIdentity;
@@ -18,6 +19,7 @@ function useCustomer() {
 /**
  * Returns the email address of the buyer that is interacting with the cart.
  * The value is `undefined` if the app does not have access to customer data.
+ * @publicDocs
  */
 function useEmail() {
   const buyerIdentity = useApi().buyerIdentity;
@@ -30,6 +32,7 @@ function useEmail() {
 /**
  * Returns the phone number of the buyer that is interacting with the cart.
  * The value is `undefined` if the app does not have access to customer data.
+ * @publicDocs
  */
 function usePhone() {
   const buyerIdentity = useApi().buyerIdentity;
@@ -45,6 +48,7 @@ function usePhone() {
  * identify both the company and its corresponding location to which the business customer belongs.
  *
  * The value is `undefined` if a business customer isn't logged in. This function throws an error if the app doesn't have access to customer data.
+ * @publicDocs
  */
 function usePurchasingCompany() {
   const buyerIdentity = useApi().buyerIdentity;

package/build/esnext/surfaces/checkout/preact/buyer-journey.esnext CHANGED Viewed

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the `buyerJourney` details on buyer progression in checkout.
+ * @publicDocs
  */
 function useBuyerJourney() {
   const api = useApi();
@@ -15,6 +16,7 @@ function useBuyerJourney() {
  * Returns true if the buyer completed submitting their order.
  *
  * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.
+ * @publicDocs
  */
 function useBuyerJourneyCompleted() {
   const api = useApi();
@@ -35,6 +37,7 @@ function useBuyerJourneyCompleted() {
  *
  * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension
  * to block checkout progress.
+ * @publicDocs
  */
 function useBuyerJourneyIntercept(interceptor) {
   const api = useApi();
@@ -50,6 +53,7 @@ function useBuyerJourneyIntercept(interceptor) {
 /**
  * Returns all possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.
+ * @publicDocs
  */
 function useBuyerJourneySteps() {
   const api = useApi();
@@ -61,6 +65,7 @@ function useBuyerJourneySteps() {
 /**
  * Returns the buyer journey step that the buyer is currently on.
+ * @publicDocs
  */
 function useBuyerJourneyActiveStep() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/capabilities.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useApi } from './api.esnext';
 /**
  * Returns a list of an extension's granted capabilities.
+ * @publicDocs
  */
 function useExtensionCapabilities() {
   return useSubscription(useApi().extension.capabilities);
@@ -10,6 +11,7 @@ function useExtensionCapabilities() {
 /**
  * Returns whether or not a given capability of an extension is granted.
+ * @publicDocs
  */
 function useExtensionCapability(capability) {
   return useExtensionCapabilities().includes(capability);

package/build/esnext/surfaces/checkout/preact/cart-line-target.esnext CHANGED Viewed

@@ -8,6 +8,7 @@ import { useSubscription } from './subscription.esnext';
  * - `purchase.cart-line-item.line-components.render`
  * - `purchase.checkout.cart-line-item.render-after`
  * - `purchase.thank-you.cart-line-item.render-after`
+ * @publicDocs
  */
 function useCartLineTarget() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/cart-lines.esnext CHANGED Viewed

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the current line items for the checkout, and automatically re-renders
  * your component if line items are added, removed, or updated.
+ * @publicDocs
  */
 function useCartLines() {
   const {
@@ -15,6 +16,7 @@ function useCartLines() {
 /**
  * Returns a function to mutate the `lines` property of checkout.
+ * @publicDocs
  */
 function useApplyCartLinesChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/checkout-settings.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the `checkoutSettings` applied to the checkout.
+ * @publicDocs
  */
 function useCheckoutSettings() {
   return useSubscription(useApi().checkoutSettings);

package/build/esnext/surfaces/checkout/preact/checkout-token.esnext CHANGED Viewed

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.esnext';
  *
  * Matches the `token` field in the [WebPixel checkout payload](https://shopify.dev/docs/api/pixels/customer-events#checkout)
  * and the `checkout_token` field in the [Admin REST API Order resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).
+ * @publicDocs
  */
 function useCheckoutToken() {
   return useSubscription(useApi().checkoutToken);

package/build/esnext/surfaces/checkout/preact/cost.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * A `Money` value representing the subtotal value of the items in the cart at the current
  * step of checkout.
+ * @publicDocs
  */
 function useSubtotalAmount() {
   return useSubscription(useApi().cost.subtotalAmount);
@@ -13,6 +14,7 @@ function useSubtotalAmount() {
  * A `Money` value representing the total shipping a buyer can expect to pay at the current
  * step of checkout. This value includes shipping discounts. Returns undefined if shipping
  * has not been negotiated yet, such as on the information step.
+ * @publicDocs
  */
 function useTotalShippingAmount() {
   return useSubscription(useApi().cost.totalShippingAmount);
@@ -22,6 +24,7 @@ function useTotalShippingAmount() {
  * A `Money` value representing the total tax a buyer can expect to pay at the current
  * step of checkout or the total tax included in product and shipping prices. Returns
  * undefined if taxes are unavailable.
+ * @publicDocs
  */
 function useTotalTaxAmount() {
   return useSubscription(useApi().cost.totalTaxAmount);
@@ -31,6 +34,7 @@ function useTotalTaxAmount() {
  * Returns a `Money` value representing the minimum a buyer can expect to pay at the current
  * step of checkout. This value excludes amounts yet to be negotiated. For example,
  * the information step might not have delivery costs calculated.
+ * @publicDocs
  */
 function useTotalAmount() {
   return useSubscription(useApi().cost.totalAmount);

package/build/esnext/surfaces/checkout/preact/country.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the country of the checkout, and automatically re-renders
  * your component if the country changes.
+ * @publicDocs
  */
 function useLocalizationCountry() {
   const {

package/build/esnext/surfaces/checkout/preact/currency.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the currency of the checkout, and automatically re-renders
  * your component if the currency changes.
+ * @publicDocs
  */
 function useCurrency() {
   const {

package/build/esnext/surfaces/checkout/preact/customer-privacy.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the current customer privacy settings and metadata and
  * re-renders your component if the customer privacy settings change.
+ * @publicDocs
  */
 function useCustomerPrivacy() {
   return useSubscription(useApi().customerPrivacy);

package/build/esnext/surfaces/checkout/preact/delivery-group-list-target.esnext CHANGED Viewed

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.esnext';
  * extension targets:
  * - purchase.checkout.shipping-option-list.render-before
  * - purchase.checkout.shipping-option-list.render-after
+ * @publicDocs
  */
 function useDeliveryGroupListTarget() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/delivery-group-target.esnext CHANGED Viewed

@@ -10,6 +10,7 @@ import { useSubscription } from './subscription.esnext';
  * > Caution: Deprecated as of version `2024-07`, use `useDeliveryGroupListTarget()` instead.
  *
  * @deprecated Deprecated as of version `2024-07`, use `useDeliveryGroupListTarget()` instead.
+ * @publicDocs
  */
 function useDeliveryGroupTarget() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/delivery-group.esnext CHANGED Viewed

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the full expanded details of a delivery group and automatically re-renders
  * your component when that delivery group changes.
+ * @publicDocs
  */
 function useDeliveryGroup(deliveryGroup) {
   const {

package/build/esnext/surfaces/checkout/preact/delivery-groups.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the current delivery groups for the checkout, and automatically re-renders
  * your component when delivery address or delivery option selection changes.
+ * @publicDocs
  */
 function useDeliveryGroups() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/delivery-selection-groups.esnext CHANGED Viewed

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.esnext';
  * extension targets:
  * - purchase.checkout.shipping-option-list.render-before
  * - purchase.checkout.shipping-option-list.render-after
+ * @publicDocs
  */
 function useDeliverySelectionGroups() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/discounts.esnext CHANGED Viewed

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the current discount codes applied to the cart, and automatically re-renders
  * your component if discount codes are added or removed.
+ * @publicDocs
  */
 function useDiscountCodes() {
   const {
@@ -16,6 +17,7 @@ function useDiscountCodes() {
 /**
  * Returns the current discount allocations applied to the cart, and automatically re-renders
  * your component if discount allocations changed.
+ * @publicDocs
  */
 function useDiscountAllocations() {
   const {
@@ -29,6 +31,7 @@ function useDiscountAllocations() {
  *
  * > Caution:
  * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.
+ * @publicDocs
  */
 function useApplyDiscountCodeChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/extension-editor.esnext CHANGED Viewed

@@ -2,6 +2,7 @@ import { useApi } from './api.esnext';
 /**
  * Returns information about the editor where the extension is being rendered.
+ * @publicDocs
  */
 function useExtensionEditor() {
   return useApi().extension.editor;

package/build/esnext/surfaces/checkout/preact/extension-language.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the buyer's language, as supported by the extension.
+ * @publicDocs
  */
 function useExtensionLanguage() {
   const {

package/build/esnext/surfaces/checkout/preact/extension.esnext CHANGED Viewed

@@ -2,6 +2,7 @@ import { useApi } from './api.esnext';
 /**
  * Returns the metadata about the extension.
+ * @publicDocs
  */
 function useExtension() {
   return useApi().extension;
@@ -11,6 +12,7 @@ function useExtension() {
  * Returns the metadata about the extension.
  * > Caution: This is deprecated, use `useExtension()` instead.
  * @deprecated Use `useExtension()` instead.
+ * @publicDocs
  */
 function useExtensionData() {
   return useExtension();

package/build/esnext/surfaces/checkout/preact/gift-cards.esnext CHANGED Viewed

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the current gift cards applied to the cart, and automatically re-renders
  * your component if gift cards are added or removed.
+ * @publicDocs
  */
 function useAppliedGiftCards() {
   const {
@@ -18,6 +19,7 @@ function useAppliedGiftCards() {
  *
  * > Caution:
  * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.
+ * @publicDocs
  */
 function useApplyGiftCardChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/instructions.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the cart instructions used to create the checkout and possibly limit extension capabilities.
+ * @publicDocs
  */
 function useInstructions() {
   return useSubscription(useApi().instructions);

package/build/esnext/surfaces/checkout/preact/language.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the current language of the checkout, and automatically re-renders
  * your component if the language changes.
+ * @publicDocs
  */
 function useLanguage() {
   const {

package/build/esnext/surfaces/checkout/preact/localized-fields.esnext CHANGED Viewed

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the current localized fields and
  * re-renders your component if the values change.
+ * @publicDocs
  */
 function useLocalizedFields(keys) {
   const {
@@ -28,6 +29,7 @@ function useLocalizedFields(keys) {
 /**
  * Returns the current localized field or undefined for the specified
  * localized field key and re-renders your component if the value changes.
+ * @publicDocs
  */
 function useLocalizedField(key) {
   const fields = useLocalizedFields([key]);

package/build/esnext/surfaces/checkout/preact/market.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the market of the checkout, and automatically re-renders
  * your component if it changes.
+ * @publicDocs
  */
 function useLocalizationMarket() {
   const {

package/build/esnext/surfaces/checkout/preact/metafields.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useApi } from './api.esnext';
 /**
  * Returns a function to mutate the `metafields` property of the checkout.
+ * @publicDocs
  */
 function useApplyMetafieldsChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/note.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the proposed `note` applied to the checkout.
+ * @publicDocs
  */
 function useNote() {
   return useSubscription(useApi().note);
@@ -11,6 +12,7 @@ function useNote() {
 /**
  * Returns a function to mutate the `note` property of the checkout.
+ * @publicDocs
  */
 function useApplyNoteChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/payment-method.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the proposed `paymentAttributes` applied to the checkout.
+ * @publicDocs
  */
 function usePaymentMethodAttributes() {
   const {
@@ -19,6 +20,7 @@ function usePaymentMethodAttributes() {
  * Returns the values for the specified `paymentAttributes` applied to the checkout.
  *
  * @param keys - An array of attribute keys.
+ * @publicDocs
  */
 function usePaymentMethodAttributeValues(keys) {
   const attributes = usePaymentMethodAttributes();
@@ -33,6 +35,7 @@ function usePaymentMethodAttributeValues(keys) {
 /**
  * Returns a function to set payment method attributes.
+ * @publicDocs
  */
 function useApplyPaymentMethodAttributesChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/payment-options.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns all available payment options.
+ * @publicDocs
  */
 function useAvailablePaymentOptions() {
   const api = useApi();
@@ -11,6 +12,7 @@ function useAvailablePaymentOptions() {
 /**
  * Returns payment options selected by the buyer.
+ * @publicDocs
  */
 function useSelectedPaymentOptions() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/pickup-location-option-target.esnext CHANGED Viewed

@@ -7,6 +7,7 @@ import { useSubscription } from './subscription.esnext';
  * Returns the pickup location option the extension is attached to. This hook can only be used by extensions in the following
  * extension target:
  * - `purchase.checkout.pickup-location-option-item.render-after`
+ * @publicDocs
  */
 function usePickupLocationOptionTarget() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/redeemable.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useApi } from './api.esnext';
 /**
  * Returns a function to apply a change to add a redeemable.
+ * @publicDocs
  */
 function useApplyRedeemableChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/session-token.esnext CHANGED Viewed

@@ -2,6 +2,7 @@ import { useApi } from './api.esnext';
 /**
  * Provides access to session tokens, which can be used to verify token claims on your app's server.
+ * @publicDocs
  */
 function useSessionToken() {
   return useApi().sessionToken;

package/build/esnext/surfaces/checkout/preact/settings.esnext CHANGED Viewed

@@ -3,6 +3,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the setting values defined by the merchant for the extension.
+ * @publicDocs
  */
 function useSettings() {
   const settings = useSubscription(useApi().settings);

package/build/esnext/surfaces/checkout/preact/shipping-address.esnext CHANGED Viewed

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.esnext';
 /**
  * Returns the proposed `shippingAddress` applied to the checkout.
+ * @publicDocs
  */
 function useShippingAddress() {
   const shippingAddress = useApi().shippingAddress;
@@ -15,6 +16,7 @@ function useShippingAddress() {
 /**
  * Returns a function to mutate the `shippingAddress` property of checkout.
+ * @publicDocs
  */
 function useApplyShippingAddressChange() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/shipping-option-target.esnext CHANGED Viewed

@@ -8,6 +8,7 @@ import { useSubscription } from './subscription.esnext';
  * extension targets:
  * - `purchase.checkout.shipping-option-item.render-after`
  * - `purchase.checkout.shipping-option-item.details.render`
+ * @publicDocs
  */
 function useShippingOptionTarget() {
   const api = useApi();

package/build/esnext/surfaces/checkout/preact/shop.esnext CHANGED Viewed

@@ -2,6 +2,7 @@ import { useApi } from './api.esnext';
 /**
  * Returns the `Shop` where the checkout is taking place.
+ * @publicDocs
  */
 function useShop() {
   return useApi().shop;

package/build/esnext/surfaces/checkout/preact/storage.esnext CHANGED Viewed

@@ -7,6 +7,7 @@ import { useApi } from './api.esnext';
  *
  * Data is shared across all activated extension targets of this extension. In versions `<=2023-07`,
  * each activated extension target had its own storage.
+ * @publicDocs
  */
 function useStorage() {
   return useApi().storage;

package/build/esnext/surfaces/checkout/preact/subscription.esnext CHANGED Viewed

@@ -9,6 +9,7 @@ import { useState, useEffect } from 'preact/hooks';
  * > As of version 2025-10, you no longer need this hook. When you access `.value`
  * > (instead of `.current`) on subscribable properties, Preact will automatically
  * > re-render as `.value` changes.
+ * @publicDocs
  */
 function useSubscription(subscription) {
   const [, setValue] = useState(subscription.value);

package/build/esnext/surfaces/checkout/preact/target.esnext CHANGED Viewed

@@ -17,6 +17,7 @@ class ExtensionHasNoTargetError extends Error {
  * > Caution: Deprecated as of version `2023-10`, use `useCartLineTarget()` instead.
  *
  * @deprecated Deprecated as of version `2023-10`, use `useCartLineTarget()` instead.
+ * @publicDocs
  */
 function useTarget() {
   const api = useApi();