@shopify/ui-extensions 2025.10.14 → 2025.10.15

package/src/surfaces/checkout/extension-targets.ts

@@ -33,6 +33,7 @@ import type {
  * The input arguments and the output type are different
  * for each extension target.
  */
+/** @publicDocs */
 export interface RenderExtensionTargets {
   /**
    * A static extension target that is rendered immediately before any actions within each step.
@@ -673,6 +674,7 @@ export interface RenderExtensionTargets {
   >;
 }
 
+/** @publicDocs */
 export interface RunnableExtensionTargets {
   /**
    * An extension target that provides address autocomplete suggestions. These suggestions are shown to buyers as they
@@ -709,10 +711,12 @@ export interface RunnableExtensionTargets {
  * This is a special interface that is referenced by name "ExtensionTargets", in the `buildTargetDts.ts` script in ui-extensions.
  * It is used to to generate the `shopify.d.ts` file, to provide type safety when coding UI extensions.
  */
+/** @publicDocs */
 export interface ExtensionTargets
   extends RenderExtensionTargets,
     RunnableExtensionTargets {}
 
+/** @publicDocs */
 export type ExtensionTarget = keyof ExtensionTargets;
 
 export type AvailableExtensionDefinitions<Api> =
@@ -723,6 +727,7 @@ export type AvailableExtensionDefinitions<Api> =
  * For a given extension target, returns the value that is expected to be
  * returned by that extension target’s callback type.
  */
+/** @publicDocs */
 export type ReturnTypeForExtension<Target extends keyof ExtensionTargets> =
   ExtensionTargets[Target]['output'];
 
@@ -730,6 +735,7 @@ export type ReturnTypeForExtension<Target extends keyof ExtensionTargets> =
  * For a given extension target, returns the type of the API that the
  * extension will receive at runtime.
  */
+/** @publicDocs */
 export type ApiForExtension<Target extends ExtensionTarget> =
   ExtractedApiFromExtensionDefinition<ExtensionTargets[Target]>;
 
@@ -742,11 +748,13 @@ type ExtractedApiFromExtensionDefinition<T> =
  * and an additional `api` argument, and using those arguments to render
  * UI.
  */
+/** @publicDocs */
 export type RenderExtensionTarget = keyof RenderExtensionTargets;
 
 /**
  * A mapping of each “render extension” name to its callback type.
  */
+/** @publicDocs */
 export type RenderExtensions = {
   [Target in RenderExtensionTarget]: RenderExtensionTargets[Target];
 };
@@ -774,6 +782,7 @@ type ExtractedApiFromRenderExtension<T> = T extends RenderExtension<
  *
  * @deprecated  Use `ApiForExtension` instead.
  */
+/** @publicDocs */
 export type ApiForRenderExtension<Target extends keyof RenderExtensions> =
   ExtractedApiFromRenderExtension<RenderExtensions[Target]>;
 
@@ -781,12 +790,15 @@ export type ApiForRenderExtension<Target extends keyof RenderExtensions> =
  * For a given rendering extension target, returns the UI components that the
  * extension target supports.
  */
+/** @publicDocs */
 export type AllowedComponentsForRenderExtension<
   Target extends keyof RenderExtensions,
 > = ExtractedAllowedComponentsFromRenderExtension<RenderExtensions[Target]>;
 
+/** @publicDocs */
 export type RunnableExtensionTarget = keyof RunnableExtensionTargets;
 
+/** @publicDocs */
 export type RunnableExtensions = {
   [Target in RunnableExtensionTarget]: RunnableExtensionTargets[Target];
 };

package/src/surfaces/checkout/globals.ts

@@ -1,5 +1,6 @@
 import type {ExtensionTargets} from './extension-targets';
 
+/** @publicDocs */
 export interface ShopifyGlobal {
   extend<ExtensionTarget extends keyof ExtensionTargets>(
     target: ExtensionTarget,

package/src/surfaces/checkout/preact/api.ts

@@ -18,6 +18,7 @@ import {CheckoutUIExtensionError} from './errors';
  * > Note:
  * > As of version 2025-10, you no longer need this hook. The full API object is accessible via
  * > the global `shopify` object.
+ * @publicDocs
  */
 export function useApi<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -45,6 +46,7 @@ export function useApi<
  * > Caution: This is deprecated, use `useApi` instead.
  *
  * @deprecated This is deprecated, use `useApi` instead.
+ * @publicDocs
  */
 export function useExtensionApi<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/app-metafields.ts

@@ -28,6 +28,7 @@ type AppMetafieldFilterKeys = keyof AppMetafieldFilters;
 /**
  * Returns the metafields configured with `shopify.extension.toml`.
  * @arg {AppMetafieldFilters} - filter the list of returned metafields
+ * @publicDocs
  */
 export function useAppMetafields<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/attributes.ts

@@ -11,6 +11,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the proposed `attributes` applied to the checkout.
+ * @publicDocs
  */
 export function useAttributes<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -22,6 +23,7 @@ export function useAttributes<
  * Returns the values for the specified `attributes` applied to the checkout.
  *
  * @param keys - An array of attribute keys.
+ * @publicDocs
  */
 export function useAttributeValues<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -40,6 +42,7 @@ export function useAttributeValues<
 
 /**
  * Returns a function to mutate the `attributes` property of the checkout.
+ * @publicDocs
  */
 export function useApplyAttributeChange<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/billing-address.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the proposed `billingAddress` applied to the checkout.
+ * @publicDocs
  */
 export function useBillingAddress<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/buyer-identity.ts

@@ -9,6 +9,7 @@ import {useSubscription} from './subscription';
  * 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
  */
 export function useCustomer<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -27,6 +28,7 @@ export 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
  */
 export function useEmail<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -45,6 +47,7 @@ export 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
  */
 export function usePhone<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -66,6 +69,7 @@ export 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
  */
 export function usePurchasingCompany<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/buyer-journey.ts

@@ -13,6 +13,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the `buyerJourney` details on buyer progression in checkout.
+ * @publicDocs
  */
 export function useBuyerJourney<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -26,6 +27,7 @@ export 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
  */
 export function useBuyerJourneyCompleted<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -48,6 +50,7 @@ export 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
  */
 export function useBuyerJourneyIntercept<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -70,6 +73,7 @@ export function useBuyerJourneyIntercept<
 
 /**
  * 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
  */
 export function useBuyerJourneySteps<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -85,6 +89,7 @@ export function useBuyerJourneySteps<
 
 /**
  * Returns the buyer journey step that the buyer is currently on.
+ * @publicDocs
  */
 export function useBuyerJourneyActiveStep<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/capabilities.ts

@@ -5,6 +5,7 @@ import {useApi} from './api';
 
 /**
  * Returns a list of an extension's granted capabilities.
+ * @publicDocs
  */
 export function useExtensionCapabilities(): Capability[] {
   return useSubscription(useApi().extension.capabilities);
@@ -12,6 +13,7 @@ export function useExtensionCapabilities(): Capability[] {
 
 /**
  * Returns whether or not a given capability of an extension is granted.
+ * @publicDocs
  */
 export function useExtensionCapability(capability: Capability): boolean {
   return useExtensionCapabilities().includes(capability);

package/src/surfaces/checkout/preact/cart-line-target.ts

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

package/src/surfaces/checkout/preact/cart-lines.ts

@@ -12,6 +12,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the current line items for the checkout, and automatically re-renders
  * your component if line items are added, removed, or updated.
+ * @publicDocs
  */
 export function useCartLines<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -23,6 +24,7 @@ export function useCartLines<
 
 /**
  * Returns a function to mutate the `lines` property of checkout.
+ * @publicDocs
  */
 export function useApplyCartLinesChange<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/checkout-settings.ts

@@ -6,6 +6,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the `checkoutSettings` applied to the checkout.
+ * @publicDocs
  */
 export function useCheckoutSettings<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/checkout-token.ts

@@ -9,6 +9,7 @@ import {useSubscription} from './subscription';
  *
  * 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
  */
 export function useCheckoutToken<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/cost.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 /**
  * A `Money` value representing the subtotal value of the items in the cart at the current
  * step of checkout.
+ * @publicDocs
  */
 export function useSubtotalAmount<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -18,6 +19,7 @@ export 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
  */
 export function useTotalShippingAmount<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -29,6 +31,7 @@ export 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
  */
 export function useTotalTaxAmount<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -40,6 +43,7 @@ export 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
  */
 export function useTotalAmount<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/country.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the country of the checkout, and automatically re-renders
  * your component if the country changes.
+ * @publicDocs
  */
 export function useLocalizationCountry<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/currency.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the currency of the checkout, and automatically re-renders
  * your component if the currency changes.
+ * @publicDocs
  */
 export function useCurrency<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/customer-privacy.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the current customer privacy settings and metadata and
  * re-renders your component if the customer privacy settings change.
+ * @publicDocs
  */
 export function useCustomerPrivacy<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/delivery-group-list-target.ts

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

package/src/surfaces/checkout/preact/delivery-group-target.ts

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

package/src/surfaces/checkout/preact/delivery-group.ts

@@ -14,6 +14,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the full expanded details of a delivery group and automatically re-renders
  * your component when that delivery group changes.
+ * @publicDocs
  */
 export function useDeliveryGroup<
   ID extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/delivery-groups.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the current delivery groups for the checkout, and automatically re-renders
  * your component when delivery address or delivery option selection changes.
+ * @publicDocs
  */
 export function useDeliveryGroups<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/delivery-selection-groups.ts

@@ -8,6 +8,7 @@ import {useSubscription} from './subscription';
  * extension targets:
  * - purchase.checkout.shipping-option-list.render-before
  * - purchase.checkout.shipping-option-list.render-after
+ * @publicDocs
  */
 export function useDeliverySelectionGroups():
   | DeliverySelectionGroup[]

package/src/surfaces/checkout/preact/discounts.ts

@@ -15,6 +15,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the current discount codes applied to the cart, and automatically re-renders
  * your component if discount codes are added or removed.
+ * @publicDocs
  */
 export function useDiscountCodes<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -27,6 +28,7 @@ export function useDiscountCodes<
 /**
  * Returns the current discount allocations applied to the cart, and automatically re-renders
  * your component if discount allocations changed.
+ * @publicDocs
  */
 export function useDiscountAllocations<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -41,6 +43,7 @@ export 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
  */
 export function useApplyDiscountCodeChange<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/extension-editor.ts

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

package/src/surfaces/checkout/preact/extension-language.ts

@@ -6,6 +6,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the buyer's language, as supported by the extension.
+ * @publicDocs
  */
 export function useExtensionLanguage<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/extension.ts

@@ -4,6 +4,7 @@ import {useApi} from './api';
 
 /**
  * Returns the metadata about the extension.
+ * @publicDocs
  */
 export function useExtension(): Extension {
   return useApi().extension as Extension;
@@ -13,6 +14,7 @@ export function useExtension(): Extension {
  * Returns the metadata about the extension.
  * > Caution: This is deprecated, use `useExtension()` instead.
  * @deprecated Use `useExtension()` instead.
+ * @publicDocs
  */
 export function useExtensionData(): Extension {
   return useExtension();

package/src/surfaces/checkout/preact/gift-cards.ts

@@ -12,6 +12,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the current gift cards applied to the cart, and automatically re-renders
  * your component if gift cards are added or removed.
+ * @publicDocs
  */
 export function useAppliedGiftCards<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -26,6 +27,7 @@ export 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
  */
 export function useApplyGiftCardChange<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/instructions.ts

@@ -6,6 +6,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the cart instructions used to create the checkout and possibly limit extension capabilities.
+ * @publicDocs
  */
 export function useInstructions<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/language.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the current language of the checkout, and automatically re-renders
  * your component if the language changes.
+ * @publicDocs
  */
 export function useLanguage<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/localized-fields.ts

@@ -9,6 +9,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the current localized fields and
  * re-renders your component if the values change.
+ * @publicDocs
  */
 export function useLocalizedFields<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -37,6 +38,9 @@ export function useLocalizedFields<
 /**
  * Returns the current localized field or undefined for the specified
  * localized field key and re-renders your component if the value changes.
+ *
+ * Returns `undefined` when no field is configured for the buyer's country.
+ * @publicDocs
  */
 export function useLocalizedField<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/market.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 /**
  * Returns the market of the checkout, and automatically re-renders
  * your component if it changes.
+ * @publicDocs
  */
 export function useLocalizationMarket<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/metafield.ts

@@ -11,6 +11,7 @@ interface MetafieldFilter {
 /**
  * Returns a single filtered `Metafield` or `undefined`.
  * @arg {MetafieldFilter} - filter the list of returned metafields to a single metafield
+ * @publicDocs
  */
 export function useMetafield(filters: MetafieldFilter): Metafield | undefined {
   const {namespace, key} = filters;

package/src/surfaces/checkout/preact/metafields.ts

@@ -20,6 +20,7 @@ interface MetafieldsFilters {
  * Returns the current array of `metafields` applied to the checkout.
  * You can optionally filter the list.
  * @arg {MetafieldsFilters} - filter the list of returned metafields
+ * @publicDocs
  */
 export function useMetafields<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -50,6 +51,7 @@ export function useMetafields<
 
 /**
  * Returns a function to mutate the `metafields` property of the checkout.
+ * @publicDocs
  */
 export function useApplyMetafieldsChange<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/note.ts

@@ -7,6 +7,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the proposed `note` applied to the checkout.
+ * @publicDocs
  */
 export function useNote<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -16,6 +17,7 @@ export function useNote<
 
 /**
  * Returns a function to mutate the `note` property of the checkout.
+ * @publicDocs
  */
 export function useApplyNoteChange<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/payment-method.ts

@@ -10,6 +10,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the proposed `paymentAttributes` applied to the checkout.
+ * @publicDocs
  */
 export function usePaymentMethodAttributes():
   | PaymentMethodAttribute[]
@@ -32,6 +33,7 @@ export function usePaymentMethodAttributes():
  * Returns the values for the specified `paymentAttributes` applied to the checkout.
  *
  * @param keys - An array of attribute keys.
+ * @publicDocs
  */
 export function usePaymentMethodAttributeValues(
   keys: string[],
@@ -50,6 +52,7 @@ export function usePaymentMethodAttributeValues(
 
 /**
  * Returns a function to set payment method attributes.
+ * @publicDocs
  */
 export function useApplyPaymentMethodAttributesChange(): (
   change: PaymentMethodAttributesChange,

package/src/surfaces/checkout/preact/payment-options.ts

@@ -9,6 +9,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns all available payment options.
+ * @publicDocs
  */
 export function useAvailablePaymentOptions<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -19,6 +20,7 @@ export function useAvailablePaymentOptions<
 
 /**
  * Returns payment options selected by the buyer.
+ * @publicDocs
  */
 export function useSelectedPaymentOptions<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/pickup-location-option-target.ts

@@ -10,6 +10,7 @@ import {useSubscription} from './subscription';
  * 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
  */
 export function usePickupLocationOptionTarget(): {
   pickupLocationOptionTarget: PickupLocationOption;

package/src/surfaces/checkout/preact/redeemable.ts

@@ -8,6 +8,7 @@ import {useApi} from './api';
 
 /**
  * Returns a function to apply a change to add a redeemable.
+ * @publicDocs
  */
 export function useApplyRedeemableChange(): (
   change: RedeemableChange,

package/src/surfaces/checkout/preact/session-token.ts

@@ -5,6 +5,7 @@ import {useApi} from './api';
 
 /**
  * Provides access to session tokens, which can be used to verify token claims on your app's server.
+ * @publicDocs
  */
 export function useSessionToken<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/settings.ts

@@ -5,6 +5,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the setting values defined by the merchant for the extension.
+ * @publicDocs
  */
 export function useSettings<
   Settings extends ExtensionSettings,

package/src/surfaces/checkout/preact/shipping-address.ts

@@ -11,6 +11,7 @@ import {useSubscription} from './subscription';
 
 /**
  * Returns the proposed `shippingAddress` applied to the checkout.
+ * @publicDocs
  */
 export function useShippingAddress<
   Target extends RenderExtensionTarget = RenderExtensionTarget,
@@ -28,6 +29,7 @@ export function useShippingAddress<
 
 /**
  * Returns a function to mutate the `shippingAddress` property of checkout.
+ * @publicDocs
  */
 export function useApplyShippingAddressChange<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

package/src/surfaces/checkout/preact/shipping-option-target.ts

@@ -12,6 +12,7 @@ import {useSubscription} from './subscription';
  * extension targets:
  * - `purchase.checkout.shipping-option-item.render-after`
  * - `purchase.checkout.shipping-option-item.details.render`
+ * @publicDocs
  */
 export function useShippingOptionTarget(): {
   shippingOptionTarget: ShippingOption;