@shopify/ui-extensions 2026.1.4 → 2026.1.5

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

@@ -22,8 +22,6 @@ export type StandardComponents =
   | 'Page'
   | 'POSBlock'
   | 'PosBlock' // Case is important in 2025-10
-  | 'QRCode'
-  | 'QrCode' // Case is important in 2025-10
   | 'Route'
   | 'Router'
   | 'ScrollBox'

package/src/surfaces/point-of-sale/components.d.ts

@@ -7213,7 +7213,7 @@ interface PosBlock {
 /**
  * The POS block component renders a QR code when the block is used within a receipt target.
  *
- * @publicDocs
+ * @private
  */
 interface QrCode {
   /** A unique identifier for the element. */

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

@@ -2,6 +2,8 @@ import {BaseTransactionComplete} from '../../types/base-transaction-complete';
 import {LineItem} from '../../types/cart';
 
 /**
+ *
+ * @private
  * Defines the data structure for completed exchange transactions.
  */
 export interface ExchangeTransactionData extends BaseTransactionComplete {

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

@@ -3,6 +3,8 @@ import {LineItem} from '../../types/cart';
 import {OrderLineItem} from '../../types/order';
 
 /**
+ *
+ * @private
  * Defines the data structure for receipt reprint requests.
  */
 export interface ReprintReceiptData extends BaseTransactionComplete {

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

@@ -2,6 +2,8 @@ import {BaseTransactionComplete} from '../../types/base-transaction-complete';
 import {LineItem} from '../../types/cart';
 
 /**
+ *
+ * @private
  * Defines the data structure for completed return transactions.
  */
 export interface ReturnTransactionData extends BaseTransactionComplete {

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

@@ -2,6 +2,8 @@ import {BaseTransactionComplete} from '../../types/base-transaction-complete';
 import {LineItem} from '../../types/cart';
 
 /**
+ *
+ * @private
  * Defines the data structure for completed sale transactions.
  */
 export interface SaleTransactionData extends BaseTransactionComplete {

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

@@ -6,26 +6,7 @@ import type {ReprintReceiptData} from './ReprintReceiptData';
 import {BaseApi} from './BaseApi';
 
 /**
- * The data object provided to receipt targets containing transaction details.
- */
-export interface TransactionCompleteData extends BaseData, BaseApi {
-  /**
-   * Provides access to persistent local storage methods for your POS UI extension. Use this to store, retrieve, and manage data that persists across sessions.
-   */
-  storage: BaseApi['storage'];
-  /**
-   * The transaction data, which can be one of the following types:
-   * - `SaleTransactionData`: Defines the data structure for completed sale transactions.
-   * - `ReturnTransactionData`: Defines the data structure for completed return transactions.
-   * - `ExchangeTransactionData`: Defines the data structure for completed exchange transactions.
-   */
-  transaction:
-    | SaleTransactionData
-    | ReturnTransactionData
-    | ExchangeTransactionData;
-}
-
-/**
+ * @private
  * The data object provided to receipt targets containing transaction details and reprint information.
  */
 export interface TransactionCompleteWithReprintData extends BaseData, BaseApi {

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

@@ -1,16 +1,7 @@
 export type {BaseData} from './data/BaseData';
 export type {BaseApi} from './data/BaseApi';
 export type {ReprintReceiptData} from './data/ReprintReceiptData';
-export type {
-  TransactionCompleteData,
-  TransactionCompleteWithReprintData,
-} from './data/TransactionCompleteData';
-export type {
-  CashTrackingSessionCompleteData,
-  CashTrackingSessionStartData,
-} from './data/CashTrackingSessionData';
-
-export type {CartUpdateEventData} from './data/CartUpdateEventData';
+export type {TransactionCompleteWithReprintData} from './data/TransactionCompleteData';
 
 export type {Device} from '../types/device';
 export type {Money} from '../types/money';

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

@@ -1,11 +1,3 @@
-import {BaseOutput} from './event/output';
-import {
-  CashTrackingSessionStartData,
-  CashTrackingSessionCompleteData,
-} from './event/data/CashTrackingSessionData';
-import {TransactionCompleteData} from './event/data/TransactionCompleteData';
-import {CartUpdateEventData} from './event/data/CartUpdateEventData';
-
 import type {RenderExtension} from '../../extension';
 
 import type {
@@ -28,21 +20,6 @@ import type {ReceiptComponents} from './components/targets/ReceiptComponents';
 import type {BasicComponents} from './components/targets/BasicComponents';
 import type {TransactionCompleteWithReprintData} from './event/data';
 
-export interface EventExtensionTargets {
-  'pos.transaction-complete.event.observe': (
-    data: TransactionCompleteData,
-  ) => Promise<BaseOutput>;
-  'pos.cash-tracking-session-start.event.observe': (
-    data: CashTrackingSessionStartData,
-  ) => Promise<BaseOutput>;
-  'pos.cash-tracking-session-complete.event.observe': (
-    data: CashTrackingSessionCompleteData,
-  ) => Promise<BaseOutput>;
-  'pos.cart-update.event.observe': (
-    data: CartUpdateEventData,
-  ) => Promise<BaseOutput>;
-}
-
 export interface RenderExtensionTargets {
   /**
    * Renders a single interactive tile component on the POS home screen's smart grid. The tile appears once during home screen initialization and remains persistent until navigation occurs. Use this target for high-frequency actions, status displays, or entry points to workflows that merchants need daily.
@@ -66,7 +43,10 @@ export interface RenderExtensionTargets {
    * Renders a single interactive button component as a menu item in the post-return action menu. Use this target for post-return operations like generating return receipts, processing restocking workflows, or collecting return feedback.
    *
    * Extensions at this target can access the order identifier through the Order API to perform return-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete post-return workflows.
-   */
+  
+ *
+ * @private
+ */
   'pos.return.post.action.menu-item.render': RenderExtension<
     StandardApi<'pos.return.post.action.menu-item.render'> &
       ActionApi &
@@ -77,7 +57,10 @@ export interface RenderExtensionTargets {
    * Renders a full-screen modal interface launched from post-return menu items. Use this target for complex post-return workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
    *
    * Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
-   */
+  
+ *
+ * @private
+ */
   'pos.return.post.action.render': RenderExtension<
     ActionTargetApi<'pos.return.post.action.render'> & OrderApi,
     BasicComponents
@@ -86,7 +69,10 @@ export interface RenderExtensionTargets {
    * Renders a custom information section within the post-return screen. Use this target for displaying supplementary return data like completion status, refund confirmations, or follow-up workflows alongside standard return details.
    *
    * Extensions at this target appear as persistent blocks within the post-return interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex post-return operations.
-   */
+  
+ *
+ * @private
+ */
   'pos.return.post.block.render': RenderExtension<
     StandardApi<'pos.return.post.block.render'> & OrderApi & ActionApi,
     BlockExtensionComponents
@@ -95,7 +81,10 @@ export interface RenderExtensionTargets {
    * Renders a single interactive button component as a menu item in the post-exchange action menu. Use this target for post-exchange operations like generating exchange receipts, processing restocking workflows, or collecting exchange feedback.
    *
    * Extensions at this target can access the order identifier through the Order API to perform exchange-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete post-exchange workflows.
-   */
+  
+ *
+ * @private
+ */
   'pos.exchange.post.action.menu-item.render': RenderExtension<
     StandardApi<'pos.exchange.post.action.menu-item.render'> &
       ActionApi &
@@ -106,7 +95,10 @@ export interface RenderExtensionTargets {
    * Renders a full-screen modal interface launched from post-exchange menu items. Use this target for complex post-exchange workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
    *
    * Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
-   */
+  
+ *
+ * @private
+ */
   'pos.exchange.post.action.render': RenderExtension<
     ActionTargetApi<'pos.exchange.post.action.render'> & OrderApi,
     BasicComponents
@@ -115,7 +107,10 @@ export interface RenderExtensionTargets {
    * Renders a custom information section within the post-exchange screen. Use this target for displaying supplementary exchange data like completion status, payment adjustments, or follow-up workflows alongside standard exchange details.
    *
    * Extensions at this target appear as persistent blocks within the post-exchange interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex post-exchange operations.
-   */
+  
+ *
+ * @private
+ */
   'pos.exchange.post.block.render': RenderExtension<
     StandardApi<'pos.exchange.post.block.render'> & OrderApi & ActionApi,
     BlockExtensionComponents
@@ -313,7 +308,10 @@ export interface RenderExtensionTargets {
    * Renders a custom section in the footer of printed receipts. Use this target for adding contact details, return policies, social media links, or customer engagement elements like survey links or marketing campaigns at the bottom of receipts.
    *
    * Extensions at this target appear in the receipt footer area and support limited components optimized for print formatting, including text content for information display.
-   */
+  
+ *
+ * @private
+ */
   'pos.receipt-footer.block.render': RenderExtension<
     {[key: string]: any} & StorageApi & TransactionCompleteWithReprintData,
     ReceiptComponents
@@ -322,7 +320,10 @@ export interface RenderExtensionTargets {
    * Renders a custom section in the header of printed receipts. Use this target for adding custom branding, logos, promotional messages, or store-specific information at the top of receipts.
    *
    * Extensions at this target appear in the receipt header area and support limited components optimized for print formatting, including text content for information display.
-   */
+  
+ *
+ * @private
+ */
   'pos.receipt-header.block.render': RenderExtension<
     {[key: string]: any} & StorageApi & TransactionCompleteWithReprintData,
     ReceiptComponents
@@ -360,10 +361,7 @@ export interface RenderExtensionTargets {
   >;
 }
 
-export interface ExtensionTargets
-  extends RenderExtensionTargets,
-    EventExtensionTargets {}
+export interface ExtensionTargets extends RenderExtensionTargets {}
 
 export type RenderExtensionTarget = keyof RenderExtensionTargets;
-export type EventExtensionTarget = keyof EventExtensionTargets;
 export type ExtensionTarget = keyof ExtensionTargets;

package/src/surfaces/point-of-sale/types/base-transaction-complete.ts

@@ -6,6 +6,8 @@ import type {TaxLine} from './tax-line';
 import type {TransactionType} from './transaction-type';
 
 /**
+ *
+ * @private
  * Base interface for completed transaction data shared across all transaction types.
  */
 export interface BaseTransactionComplete {

package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts

@@ -1,13 +0,0 @@
-import { BaseData } from './BaseData';
-import { Cart } from '../../api';
-import { BaseApi } from './BaseApi';
-/**
- * The data object provided to cart update extension targets. Contains the current cart state along with device, session, and connectivity information. This data is passed to extensions whenever the cart changes, enabling real-time cart monitoring and cart-based business logic.
- */
-export interface CartUpdateEventData extends BaseData, BaseApi {
-    /**
-     * The complete current `Cart` object containing all cart data including line items with products and quantities, pricing totals (subtotal, tax, grand total), associated customer information, applied discounts, custom properties, and editability state. This represents the cart's state at the moment the extension is triggered, reflecting all recent changes. The cart object is read-only in this context—modifications should be made through the Cart API methods.
-     */
-    cart: Cart;
-}
-//# sourceMappingURL=CartUpdateEventData.d.ts.map

package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CartUpdateEventData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AACpC,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,QAAQ,EAAE,OAAO;IAC5D;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;CACZ"}

package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts

@@ -1,43 +0,0 @@
-import { BaseData } from './BaseData';
-import { BaseApi } from './BaseApi';
-/**
- * The data object provided to cash tracking session start extension targets. Contains information about a newly opened cash tracking session along with device and session context.
- */
-export interface CashTrackingSessionStartData extends BaseData, BaseApi {
-    /**
-     * The cash tracking session start data containing the session identifier and the time when the session began. Cash tracking sessions represent the period during which a cash drawer is open and being used for transactions, typically corresponding to a staff member's shift.
-     */
-    cashTrackingSessionStart: {
-        /**
-         * The unique numeric identifier for this cash tracking session. This ID distinguishes this session from other cash tracking sessions and can be used for session-specific operations, reporting, or linking transactions to sessions. The ID is assigned when the session opens and remains constant until the session closes.
-         */
-        id: number;
-        /**
-         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and cash drawer operations began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the staff member's shift or cash handling period. Commonly used for calculating session duration, shift reporting, or determining which transactions belong to which session.
-         */
-        openingTime: string;
-    };
-}
-/**
- * The data object provided to cash tracking session complete extension targets. Contains information about a completed cash tracking session including when it opened and closed, along with device and session context.
- */
-export interface CashTrackingSessionCompleteData extends BaseData, BaseApi {
-    /**
-     * The cash tracking session complete data containing the session identifier, opening time, and closing time. This represents the full lifecycle of a cash drawer session from opening to closing.
-     */
-    cashTrackingSessionComplete: {
-        /**
-         * The unique numeric identifier for this cash tracking session. This ID matches the ID from when the session was opened and can be used to correlate session start and end events, retrieve session-specific data, or link all transactions that occurred during this session.
-         */
-        id: number;
-        /**
-         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the session and can be compared with `closingTime` to calculate the total session duration or shift length.
-         */
-        openingTime: string;
-        /**
-         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was closed and ended (for example, `"2024-05-15T17:30:00Z"`). This marks when the staff member completed their shift, closed out the cash drawer, and finalized the session. The time between `openingTime` and `closingTime` represents the active session duration. Commonly used for shift reporting, calculating hours worked, or determining the timeframe for session-specific transactions.
-         */
-        closingTime: string;
-    };
-}
-//# sourceMappingURL=CashTrackingSessionData.d.ts.map

package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CashTrackingSessionData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AACpC,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,QAAQ,EAAE,OAAO;IACrE;;OAEG;IACH,wBAAwB,EAAE;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,QAAQ,EAAE,OAAO;IACxE;;OAEG;IACH,2BAA2B,EAAE;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH"}

package/build/ts/surfaces/point-of-sale/targets/pos.cart-update.event.observe.d.ts

@@ -1,7 +0,0 @@
-import type { ExtensionTargets } from '../extension-targets';
-import '../globals';
-
-type Target = ExtensionTargets['pos.cart-update.event.observe'];
-export type Api = Target['api'];
-export type Output = Target['output'];
-

package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-complete.event.observe.d.ts

@@ -1,7 +0,0 @@
-import type { ExtensionTargets } from '../extension-targets';
-import '../globals';
-
-type Target = ExtensionTargets['pos.cash-tracking-session-complete.event.observe'];
-export type Api = Target['api'];
-export type Output = Target['output'];
-

package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-start.event.observe.d.ts

@@ -1,7 +0,0 @@
-import type { ExtensionTargets } from '../extension-targets';
-import '../globals';
-
-type Target = ExtensionTargets['pos.cash-tracking-session-start.event.observe'];
-export type Api = Target['api'];
-export type Output = Target['output'];
-

package/build/ts/surfaces/point-of-sale/targets/pos.transaction-complete.event.observe.d.ts

@@ -1,7 +0,0 @@
-import type { ExtensionTargets } from '../extension-targets';
-import '../globals';
-
-type Target = ExtensionTargets['pos.transaction-complete.event.observe'];
-export type Api = Target['api'];
-export type Output = Target['output'];
-

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

@@ -1,13 +0,0 @@
-import {BaseData} from './BaseData';
-import {Cart} from '../../api';
-import {BaseApi} from './BaseApi';
-
-/**
- * The data object provided to cart update extension targets. Contains the current cart state along with device, session, and connectivity information. This data is passed to extensions whenever the cart changes, enabling real-time cart monitoring and cart-based business logic.
- */
-export interface CartUpdateEventData extends BaseData, BaseApi {
-  /**
-   * The complete current `Cart` object containing all cart data including line items with products and quantities, pricing totals (subtotal, tax, grand total), associated customer information, applied discounts, custom properties, and editability state. This represents the cart's state at the moment the extension is triggered, reflecting all recent changes. The cart object is read-only in this context—modifications should be made through the Cart API methods.
-   */
-  cart: Cart;
-}

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

@@ -1,44 +0,0 @@
-import {BaseData} from './BaseData';
-import {BaseApi} from './BaseApi';
-
-/**
- * The data object provided to cash tracking session start extension targets. Contains information about a newly opened cash tracking session along with device and session context.
- */
-export interface CashTrackingSessionStartData extends BaseData, BaseApi {
-  /**
-   * The cash tracking session start data containing the session identifier and the time when the session began. Cash tracking sessions represent the period during which a cash drawer is open and being used for transactions, typically corresponding to a staff member's shift.
-   */
-  cashTrackingSessionStart: {
-    /**
-     * The unique numeric identifier for this cash tracking session. This ID distinguishes this session from other cash tracking sessions and can be used for session-specific operations, reporting, or linking transactions to sessions. The ID is assigned when the session opens and remains constant until the session closes.
-     */
-    id: number;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and cash drawer operations began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the staff member's shift or cash handling period. Commonly used for calculating session duration, shift reporting, or determining which transactions belong to which session.
-     */
-    openingTime: string;
-  };
-}
-
-/**
- * The data object provided to cash tracking session complete extension targets. Contains information about a completed cash tracking session including when it opened and closed, along with device and session context.
- */
-export interface CashTrackingSessionCompleteData extends BaseData, BaseApi {
-  /**
-   * The cash tracking session complete data containing the session identifier, opening time, and closing time. This represents the full lifecycle of a cash drawer session from opening to closing.
-   */
-  cashTrackingSessionComplete: {
-    /**
-     * The unique numeric identifier for this cash tracking session. This ID matches the ID from when the session was opened and can be used to correlate session start and end events, retrieve session-specific data, or link all transactions that occurred during this session.
-     */
-    id: number;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the session and can be compared with `closingTime` to calculate the total session duration or shift length.
-     */
-    openingTime: string;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was closed and ended (for example, `"2024-05-15T17:30:00Z"`). This marks when the staff member completed their shift, closed out the cash drawer, and finalized the session. The time between `openingTime` and `closingTime` represents the active session duration. Commonly used for shift reporting, calculating hours worked, or determining the timeframe for session-specific transactions.
-     */
-    closingTime: string;
-  };
-}