@shopify/ui-extensions 2026.4.0-rc.2 → 2026.4.0

package/build/cjs/surfaces/point-of-sale/types/storage.js

@@ -2,6 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+/**
+ * @publicDocs
+ */
 class StorageError extends Error {
   constructor(code, message) {
     super(message);
@@ -11,6 +14,7 @@ class StorageError extends Error {
 }
 /**
  * Defines the storage interface for persisting extension data across sessions.
+ * @publicDocs
  */
 
 exports.StorageError = StorageError;

package/build/esm/surfaces/checkout/preact/api.mjs

@@ -13,6 +13,7 @@ import { CheckoutUIExtensionError } from './errors.mjs';
  * > 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/esm/surfaces/checkout/preact/app-metafields.mjs

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/attributes.mjs

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/billing-address.mjs

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

package/build/esm/surfaces/checkout/preact/buyer-identity.mjs

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.mjs';
  * 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/esm/surfaces/checkout/preact/buyer-journey.mjs

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/capabilities.mjs

@@ -3,6 +3,7 @@ import { useApi } from './api.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/cart-line-target.mjs

@@ -8,6 +8,7 @@ import { useSubscription } from './subscription.mjs';
  * - `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/esm/surfaces/checkout/preact/cart-lines.mjs

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/checkout-settings.mjs

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

package/build/esm/surfaces/checkout/preact/checkout-token.mjs

@@ -6,6 +6,7 @@ import { useSubscription } from './subscription.mjs';
  *
  * 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/esm/surfaces/checkout/preact/cost.mjs

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/country.mjs

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

package/build/esm/surfaces/checkout/preact/currency.mjs

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

package/build/esm/surfaces/checkout/preact/customer-privacy.mjs

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/delivery-group-list-target.mjs

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

package/build/esm/surfaces/checkout/preact/delivery-group-target.mjs

@@ -10,6 +10,7 @@ import { useSubscription } from './subscription.mjs';
  * > 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/esm/surfaces/checkout/preact/delivery-group.mjs

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/delivery-groups.mjs

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/delivery-selection-groups.mjs

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

package/build/esm/surfaces/checkout/preact/discounts.mjs

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/extension-editor.mjs

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

package/build/esm/surfaces/checkout/preact/extension-language.mjs

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

package/build/esm/surfaces/checkout/preact/extension.mjs

@@ -2,6 +2,7 @@ import { useApi } from './api.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/gift-cards.mjs

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/instructions.mjs

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

package/build/esm/surfaces/checkout/preact/language.mjs

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

package/build/esm/surfaces/checkout/preact/localized-fields.mjs

@@ -5,6 +5,7 @@ import { useSubscription } from './subscription.mjs';
 /**
  * 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/esm/surfaces/checkout/preact/market.mjs

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

package/build/esm/surfaces/checkout/preact/metafields.mjs

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

package/build/esm/surfaces/checkout/preact/note.mjs

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/payment-method.mjs

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/payment-options.mjs

@@ -3,6 +3,7 @@ import { useSubscription } from './subscription.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/pickup-location-option-target.mjs

@@ -7,6 +7,7 @@ import { useSubscription } from './subscription.mjs';
  * 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/esm/surfaces/checkout/preact/redeemable.mjs

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

package/build/esm/surfaces/checkout/preact/session-token.mjs

@@ -2,6 +2,7 @@ import { useApi } from './api.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/settings.mjs

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

package/build/esm/surfaces/checkout/preact/shipping-address.mjs

@@ -4,6 +4,7 @@ import { useSubscription } from './subscription.mjs';
 
 /**
  * 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/esm/surfaces/checkout/preact/shipping-option-target.mjs

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

package/build/esm/surfaces/checkout/preact/shop.mjs

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

package/build/esm/surfaces/checkout/preact/storage.mjs

@@ -7,6 +7,7 @@ import { useApi } from './api.mjs';
  *
  * 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/esm/surfaces/checkout/preact/subscription.mjs

@@ -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/esm/surfaces/checkout/preact/target.mjs

@@ -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();

package/build/esm/surfaces/checkout/preact/timezone.mjs

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

package/build/esm/surfaces/checkout/preact/translate.mjs

@@ -2,6 +2,7 @@ import { useApi } from './api.mjs';
 
 /**
  * Returns the `I18nTranslate` interface used to translate strings.
+ * @publicDocs
  */
 function useTranslate() {
   const api = useApi();