@shopify/ui-extensions 2025.7.1 → 2025.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/ui-extensions",
-  "version": "2025.7.1",
+  "version": "2025.7.2",
   "scripts": {
     "docs:admin": "bash ./docs/surfaces/admin/build-docs.sh",
     "docs:admin:dev": "nodemon --watch src/surfaces/admin -e ts,tsx,json --exec 'yarn docs:admin'",

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

@@ -1,7 +1,21 @@
-export interface Announcement {
-  announcement: {
-    close(): void;
-    addEventListener(type: 'close', cb: () => void): void;
-    removeEventListener(type: 'close', cb: () => void): void;
-  };
+/**
+ * The API for interacting with the announcement bar.
+ */
+export interface AnnouncementApi {
+  announcement: Announcement;
+}
+
+interface Announcement {
+  /**
+   * Close the Announcement bar.
+   */
+  close(): void;
+  /**
+   * Listen for events from the announcement bar.
+   */
+  addEventListener(type: 'close', cb: () => void): void;
+  /**
+   * Remove a listener for events from the announcement bar.
+   */
+  removeEventListener(type: 'close', cb: () => void): void;
 }

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

@@ -253,7 +253,7 @@ export interface DiscountCodeAddChange {
   type: 'addDiscountCode';
 
   /**
-   * The code for the discount (case-sensitive)
+   * The code for the discount (case-insensitive)
    */
   code: string;
 }
@@ -265,7 +265,7 @@ export interface DiscountCodeRemoveChange {
   type: 'removeDiscountCode';
 
   /**
-   * The code for the discount (case-sensitive)
+   * The code for the discount (case-insensitive)
    */
   code: string;
 }

package/src/surfaces/checkout/targets.ts

@@ -18,13 +18,13 @@ import type {RedeemableApi} from './api/redeemable/redeemable';
 import type {StandardApi} from './api/standard/standard';
 import type {ShippingOptionItemApi} from './api/shipping/shipping-option-item';
 import type {ShippingOptionListApi} from './api/shipping/shipping-option-list';
+import {AnnouncementApi} from './api/announcement/announcement';
 import type {RenderExtension, RunnableExtension} from './extension';
 import type {
   AnyComponent,
   AllowedComponents,
   AnyComponentExcept,
 } from './shared';
-import type {Announcement} from './api/announcement/announcement';
 
 /**
  * A UI extension will register for one or more extension targets using `shopify.extend()`.
@@ -654,7 +654,7 @@ export interface RenderExtensionTargets {
   'purchase.thank-you.announcement.render': RenderExtension<
     OrderConfirmationApi &
       StandardApi<'purchase.thank-you.announcement.render'> &
-      Announcement,
+      AnnouncementApi,
     AnyComponent
   >;
 }

package/src/surfaces/checkout.ts

@@ -143,7 +143,7 @@ export type {
   OrderStatusApi,
 } from './checkout/api/order-status/order-status';
 export type {OrderConfirmationApi} from './checkout/api/order-confirmation/order-confirmation';
-export type {Announcement} from './checkout/api/announcement/announcement';
+export type {AnnouncementApi} from './checkout/api/announcement/announcement';
 
 export type {CartLineItemApi} from './checkout/api/cart-line/cart-line-item';
 export type {PickupLocationListApi} from './checkout/api/pickup/pickup-location-list';

package/src/surfaces/customer-account/api/announcement/announcement.ts

@@ -1,7 +1,21 @@
-export interface Announcement {
-  announcement: {
-    close(): void;
-    addEventListener(type: 'close', cb: () => void): void;
-    removeEventListener(type: 'close', cb: () => void): void;
-  };
+/**
+ * The API for interacting with the announcement bar.
+ */
+export interface AnnouncementApi {
+  announcement: Announcement;
+}
+
+interface Announcement {
+  /**
+   * Close the Announcement bar.
+   */
+  close(): void;
+  /**
+   * Listen for events from the announcement bar.
+   */
+  addEventListener(type: 'close', cb: () => void): void;
+  /**
+   * Remove a listener for events from the announcement bar.
+   */
+  removeEventListener(type: 'close', cb: () => void): void;
 }

package/src/surfaces/customer-account/api/docs.ts

@@ -67,6 +67,9 @@ export interface Docs_Standard_LocalizationApi
 export interface Docs_Standard_SessionTokenApi
   extends Pick<StandardApi<any>, 'sessionToken'> {}
 
+export interface Docs_Standard_AnalyticsApi
+  extends Pick<StandardApi<any>, 'analytics'> {}
+
 export interface Docs_Standard_SettingsApi
   extends Pick<StandardApi, 'settings'> {}
 

package/src/surfaces/customer-account/api/standard-api/standard-api.ts

@@ -82,6 +82,8 @@ export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
 
   /**
    * Methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.
+   *
+   * > Note: Requires to [connect a third-party domain](https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account) to Shopify for your customer account pages.
    */
   analytics: Analytics;
 

package/src/surfaces/customer-account/api.ts

@@ -97,3 +97,5 @@ export type {
   OrderApi,
   ExtensionSettings,
 } from './api/standard-api/standard-api';
+
+export type {AnnouncementApi} from './api/announcement/announcement';

package/src/surfaces/customer-account/targets.ts

@@ -11,7 +11,7 @@ import {
   FulfillmentApi,
   ReturnApi,
 } from './api/standard-api/standard-api';
-import {Announcement} from './api/announcement/announcement';
+import {AnnouncementApi} from './api/announcement/announcement';
 
 type Components = typeof import('./components');
 
@@ -97,7 +97,7 @@ export interface OrderStatusExtensionTargets {
   'customer-account.order-status.announcement.render': RenderExtension<
     OrderStatusApi<'customer-account.order-status.announcement.render'> &
       StandardApi<'customer-account.order-status.announcement.render'> &
-      Announcement,
+      AnnouncementApi,
     AnyComponent
   >;
   'customer-account.order.page.render': RenderExtension<
@@ -129,7 +129,7 @@ export interface CustomerAccountExtensionTargets {
   >;
   'customer-account.order-index.announcement.render': RenderExtension<
     StandardApi<'customer-account.order-index.announcement.render'> &
-      Announcement,
+      AnnouncementApi,
     AllComponents
   >;
   'customer-account.profile.block.render': RenderExtension<
@@ -137,7 +137,8 @@ export interface CustomerAccountExtensionTargets {
     AllComponents
   >;
   'customer-account.profile.announcement.render': RenderExtension<
-    StandardApi<'customer-account.profile.announcement.render'> & Announcement,
+    StandardApi<'customer-account.profile.announcement.render'> &
+      AnnouncementApi,
     AllComponents
   >;
   'customer-account.profile.addresses.render-after': RenderExtension<

package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts

@@ -3,6 +3,7 @@ import {LineItem} from '../../types/cart';
 
 export interface ExchangeTransactionData extends BaseTransactionComplete {
   transactionType: 'Exchange';
+  returnId?: number;
   exchangeId?: number;
   lineItemsAdded: LineItem[];
   lineItemsRemoved: LineItem[];

package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts

@@ -3,6 +3,7 @@ import {LineItem} from '../../types/cart';
 
 export interface ReturnTransactionData extends BaseTransactionComplete {
   transactionType: 'Return';
+  refundId?: number;
   returnId?: number;
   exchangeId?: number;
   lineItems: LineItem[];

package/src/surfaces/point-of-sale/targets.ts

@@ -185,6 +185,10 @@ export interface ExtensionTargets {
     {[key: string]: any} & StorageApi & TransactionCompleteWithReprintData,
     ReceiptComponents
   >;
+  'pos.receipt-header.block.render': RenderExtension<
+    {[key: string]: any} & StorageApi & TransactionCompleteWithReprintData,
+    ReceiptComponents
+  >;
 }
 
 export type ExtensionTarget = keyof ExtensionTargets;

package/src/surfaces/point-of-sale/types/cart.ts

@@ -1,5 +1,6 @@
 import {CountryCode} from './country-code';
 import {TaxLine} from './tax-line';
+import {DiscountAllocation} from './discount-allocation';
 
 export interface Cart {
   /**
@@ -40,6 +41,7 @@ export interface LineItem {
   variantId?: number;
   productId?: number;
   discounts: Discount[];
+  discountAllocations?: DiscountAllocation[];
   taxable: boolean;
   taxLines: TaxLine[];
   sku?: string;
@@ -47,6 +49,33 @@ export interface LineItem {
   properties: {[key: string]: string};
   isGiftCard: boolean;
   attributedUserId?: number;
+  /**
+   * Bundle components for this line item. Only present for product bundles.
+   * Each component represents an individual item within the bundle with its own tax information.
+   */
+  components?: LineItemComponent[];
+}
+
+/**
+ * Represents a component of a product bundle line item.
+ * Bundle components contain the individual items that make up a bundle,
+ * each with their own pricing and tax information.
+ */
+export interface LineItemComponent {
+  /** The title/name of the component product */
+  title?: string;
+  /** The quantity of this component in the bundle */
+  quantity: number;
+  /** The price of this component */
+  price?: number;
+  /** Whether this component is taxable */
+  taxable: boolean;
+  /** Tax lines applied to this component */
+  taxLines: TaxLine[];
+  /** The variant ID of this component, if applicable */
+  variantId?: number;
+  /** The product ID of this component, if applicable */
+  productId?: number;
 }
 
 export interface Discount {

package/src/surfaces/point-of-sale/types/discount-allocation.ts

@@ -0,0 +1,5 @@
+import type {MoneyV2} from './money';
+
+export interface DiscountAllocation {
+  allocatedAmount: MoneyV2;
+}

package/src/surfaces/point-of-sale/types/money.ts

@@ -2,3 +2,8 @@ export interface Money {
   amount: number;
   currency: string;
 }
+
+export interface MoneyV2 {
+  amount: string;
+  currencyCode: string;
+}