@shopify/ui-extensions 2025.7.1 → 2025.7.3

package/build/ts/surfaces/point-of-sale/targets.d.ts

@@ -10,34 +10,172 @@ type ReceiptComponents = AnyComponentBuilder<Pick<Components, 'POSReceiptBlock'
 type BasicComponents = AnyComponentBuilder<Omit<Components, 'Tile'>>;
 type BlockComponents = AnyComponentBuilder<Pick<Components, 'Badge' | 'Button' | 'DatePicker' | 'Dialog' | 'Icon' | 'Image' | 'POSBlock' | 'POSBlockRow' | 'Stack' | 'Text' | 'TimePicker'>>;
 export interface ExtensionTargets {
+    /**
+     * 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.
+     *
+     * Extensions at this target can dynamically update properties like enabled state and badge values in response to cart changes or device conditions. Tiles typically invoke `api.action.presentModal()` to launch the companion modal for complete workflows.
+     */
     'pos.home.tile.render': RenderExtension<StandardApi<'pos.home.tile.render'> & ActionApi & CartApi, SmartGridComponents>;
+    /**
+     * Renders a full-screen modal interface launched from smart grid tiles. The modal appears when users tap a companion tile. Use this target for complete workflow experiences that require more space and functionality than the tile interface provides, such as multi-step processes, detailed information displays, or complex user interactions.
+     *
+     * Extensions at this target support full navigation hierarchies with multiple screens, scroll views, and interactive components to handle sophisticated workflows.
+     */
     'pos.home.modal.render': RenderExtension<ActionTargetApi<'pos.home.modal.render'> & CartApi, BasicComponents>;
+    /**
+     * 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 `api.action.presentModal()` to launch the companion modal for complete post-return workflows.
+     */
     'pos.return.post.action.menu-item.render': RenderExtension<StandardApi<'pos.return.post.action.menu-item.render'> & ActionApi & OrderApi, ActionComponents>;
+    /**
+     * 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.
+     */
     'pos.return.post.action.render': RenderExtension<ActionTargetApi<'pos.return.post.action.render'> & OrderApi, BasicComponents>;
+    /**
+     * 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 `api.action.presentModal()` for more complex post-return operations.
+     */
     'pos.return.post.block.render': RenderExtension<StandardApi<'pos.return.post.block.render'> & OrderApi & ActionApi, BlockComponents>;
+    /**
+     * 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 `api.action.presentModal()` to launch the companion modal for complete post-exchange workflows.
+     */
     'pos.exchange.post.action.menu-item.render': RenderExtension<StandardApi<'pos.exchange.post.action.menu-item.render'> & ActionApi & OrderApi, ActionComponents>;
+    /**
+     * 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.
+     */
     'pos.exchange.post.action.render': RenderExtension<ActionTargetApi<'pos.exchange.post.action.render'> & OrderApi, BasicComponents>;
+    /**
+     * 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 `api.action.presentModal()` for more complex post-exchange operations.
+     */
     'pos.exchange.post.block.render': RenderExtension<StandardApi<'pos.exchange.post.block.render'> & OrderApi & ActionApi, BlockComponents>;
+    /**
+     * Renders a single interactive button component as a menu item in the post-purchase action menu. Use this target for post-purchase operations like sending receipts, collecting customer feedback, or launching follow-up workflows after completing a sale.
+     *
+     * Extensions at this target can access the order identifier through the Order API to perform purchase-specific operations. Menu items typically invoke `api.action.presentModal()` to launch the companion modal for complete post-purchase workflows.
+     */
     'pos.purchase.post.action.menu-item.render': RenderExtension<StandardApi<'pos.purchase.post.action.menu-item.render'> & ActionApi & OrderApi, ActionComponents>;
+    /**
+     * Renders a full-screen modal interface launched from post-purchase menu items. Use this target for complex post-purchase 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.
+     */
     'pos.purchase.post.action.render': RenderExtension<ActionTargetApi<'pos.purchase.post.action.render'> & OrderApi, BasicComponents>;
+    /**
+     * Renders a custom information section within the post-purchase screen. Use this target for displaying supplementary purchase data like completion status, customer feedback prompts, or next-step workflows alongside standard purchase details.
+     *
+     * Extensions at this target appear as persistent blocks within the post-purchase interface and support interactive elements that can launch modal workflows using `api.action.presentModal()` for more complex post-purchase operations.
+     */
     'pos.purchase.post.block.render': RenderExtension<StandardApi<'pos.purchase.post.block.render'> & OrderApi & ActionApi, BlockComponents>;
+    /**
+     * Renders a single interactive button component as a menu item in the product details action menu. Use this target for product-specific operations like inventory adjustments, product analytics, or integration with external product management systems.
+     *
+     * Extensions at this target can access the product identifier through the Product API to perform product-specific operations. Menu items typically invoke `api.action.presentModal()` to launch the companion modal for complete product workflows.
+     */
     'pos.product-details.action.menu-item.render': RenderExtension<StandardApi<'pos.product-details.action.menu-item.render'> & ActionApi & CartApi & ProductApi, ActionComponents>;
+    /**
+     * Renders a full-screen modal interface launched from product details menu items. Use this target for complex product 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 product and cart data through the Product API and support workflows with multiple screens, navigation, and interactive components.
+     */
     'pos.product-details.action.render': RenderExtension<ActionTargetApi<'pos.product-details.action.render'> & CartApi & ProductApi, BasicComponents>;
+    /**
+     * Renders a custom information section within the product details screen. Use this target for displaying supplementary product data like detailed specifications, inventory status, or related product recommendations alongside standard product details.
+     *
+     * Extensions at this target appear as persistent blocks within the product details interface and support interactive elements that can launch modal workflows using `api.action.presentModal()` for more complex product operations.
+     */
     'pos.product-details.block.render': RenderExtension<StandardApi<'pos.product-details.block.render'> & CartApi & ProductApi & ActionApi, BlockComponents>;
+    /**
+     * Renders a single interactive button component as a menu item in the order details action menu. Use this target for order-specific operations like reprints, refunds, exchanges, or launching fulfillment workflows.
+     *
+     * Extensions at this target can access the order identifier through the Order API to perform order-specific operations. Menu items typically invoke `api.action.presentModal()` to launch the companion modal for complete order workflows.
+     */
     'pos.order-details.action.menu-item.render': RenderExtension<StandardApi<'pos.order-details.action.menu-item.render'> & ActionApi & CartApi & OrderApi, ActionComponents>;
+    /**
+     * Renders a full-screen modal interface launched from order details menu items. Use this target for complex order 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.
+     */
     'pos.order-details.action.render': RenderExtension<ActionTargetApi<'pos.order-details.action.render'> & CartApi & OrderApi, BasicComponents>;
+    /**
+     * Renders a custom information section within the order details screen. Use this target for displaying supplementary order data like fulfillment status, tracking numbers, or custom order analytics alongside standard order details.
+     *
+     * Extensions at this target appear as persistent blocks within the order details interface and support interactive elements that can launch modal workflows using `api.action.presentModal()` for more complex order operations.
+     */
     'pos.order-details.block.render': RenderExtension<StandardApi<'pos.order-details.block.render'> & CartApi & OrderApi & ActionApi, BlockComponents>;
+    /**
+     * Renders a single interactive button component as a menu item in the draft order details action menu. Use this target for draft order-specific operations like sending invoices, updating payment status, or launching custom workflow processes for pending orders.
+     *
+     * Extensions at this target can access draft order information including order ID, name, and associated customer through the Draft Order API. Menu items typically invoke `api.action.presentModal()` to launch the companion modal for complete draft order workflows.
+     */
     'pos.draft-order-details.action.menu-item.render': RenderExtension<StandardApi<'pos.draft-order-details.action.menu-item.render'> & ActionApi & CartApi & DraftOrderApi, ActionComponents>;
+    /**
+     * Renders a full-screen modal interface launched from draft order details menu items. Use this target for complex draft order 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 draft order data through the Draft Order API and support workflows with multiple screens, navigation, and interactive components.
+     */
     'pos.draft-order-details.action.render': RenderExtension<ActionTargetApi<'pos.draft-order-details.action.render'> & DraftOrderApi & CartApi, BasicComponents>;
+    /**
+     * Renders a custom information section within the draft order details screen. Use this target for displaying supplementary order information like processing status, payment status, or workflow indicators alongside standard draft order details.
+     *
+     * Extensions at this target appear as persistent blocks within the draft order interface and support interactive elements that can launch modal workflows using `api.action.presentModal()` for more complex draft order operations.
+     */
     'pos.draft-order-details.block.render': RenderExtension<StandardApi<'pos.draft-order-details.block.render'> & ActionApi & CartApi & DraftOrderApi, BlockComponents>;
+    /**
+     * Renders a single interactive button component as a menu item in the customer details action menu. Use this target for customer-specific operations like applying customer discounts, processing loyalty redemptions, or launching profile update workflows.
+     *
+     * Extensions at this target can access the customer identifier through the Customer API to perform customer-specific operations. Menu items typically invoke `api.action.presentModal()` to launch the companion modal for complete customer workflows.
+     */
     'pos.customer-details.action.menu-item.render': RenderExtension<StandardApi<'pos.customer-details.action.menu-item.render'> & ActionApi & CartApi & CustomerApi, ActionComponents>;
+    /**
+     * Renders a full-screen modal interface launched from customer details menu items. Use this target for complex customer 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 customer data through the Customer API and support workflows with multiple screens, navigation, and interactive components.
+     */
     'pos.customer-details.action.render': RenderExtension<ActionTargetApi<'pos.customer-details.action.render'> & CartApi & CustomerApi, BasicComponents>;
+    /**
+     * Renders a custom information section within the customer details screen. Use this target for displaying supplementary customer data like loyalty status, points balance, or personalized information alongside standard customer details.
+     *
+     * Extensions at this target appear as persistent blocks within the customer details interface and support interactive elements that can launch modal workflows using `api.action.presentModal()` for more complex customer operations.
+     */
     'pos.customer-details.block.render': RenderExtension<StandardApi<'pos.customer-details.block.render'> & CartApi & CustomerApi & ActionApi, BlockComponents>;
+    /**
+     * Renders a single interactive button component as a menu item in the cart line item action menu. Use this target for item-specific operations like applying discounts, adding custom properties, or launching verification workflows for individual cart items.
+     *
+     * Extensions at this target can access detailed line item information including title, quantity, price, discounts, properties, and product metadata through the Cart Line Item API. Menu items typically invoke `api.action.presentModal()` to launch the companion modal for complete workflows.
+     */
     'pos.cart.line-item-details.action.menu-item.render': RenderExtension<StandardApi<'pos.cart.line-item-details.action.menu-item.render'> & ActionApi & CartApi & CartLineItemApi, ActionComponents>;
+    /**
+     * Renders a full-screen modal interface launched from cart line item menu items. Use this target for complex line item 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 detailed line item data through the Cart Line Item API and support workflows with multiple screens, navigation, and interactive components.
+     */
     'pos.cart.line-item-details.action.render': RenderExtension<ActionTargetApi<'pos.cart.line-item-details.action.render'> & ActionApi & CartApi & CartLineItemApi, BasicComponents>;
+    /**
+     * 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.
+     */
     'pos.receipt-footer.block.render': RenderExtension<{
         [key: string]: any;
     } & StorageApi & TransactionCompleteWithReprintData, ReceiptComponents>;
+    /**
+     * 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.
+     */
+    'pos.receipt-header.block.render': RenderExtension<{
+        [key: string]: any;
+    } & StorageApi & TransactionCompleteWithReprintData, ReceiptComponents>;
 }
 export type ExtensionTarget = keyof ExtensionTargets;
 export type ExtensionForExtensionTarget<T extends ExtensionTarget> = ExtensionTargets[T];

package/build/ts/surfaces/point-of-sale/targets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"targets.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/targets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,eAAe,EACf,OAAO,EACP,eAAe,EACf,WAAW,EACX,aAAa,EACb,UAAU,EACV,QAAQ,EACT,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAC,kCAAkC,EAAC,MAAM,sCAAsC,CAAC;AAC7F,OAAO,EAAC,UAAU,EAAC,MAAM,sCAAsC,CAAC;AAEhE,KAAK,mBAAmB,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACzE,KAAK,gBAAgB,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AACxE,KAAK,iBAAiB,GAAG,mBAAmB,CAC1C,IAAI,CAAC,UAAU,EAAE,iBAAiB,GAAG,MAAM,GAAG,QAAQ,CAAC,CACxD,CAAC;AACF,KAAK,eAAe,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACrE,KAAK,eAAe,GAAG,mBAAmB,CACxC,IAAI,CACF,UAAU,EACR,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,OAAO,GACP,UAAU,GACV,aAAa,GACb,OAAO,GACP,MAAM,GACN,YAAY,CACf,CACF,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,sBAAsB,EAAE,eAAe,CACrC,WAAW,CAAC,sBAAsB,CAAC,GAAG,SAAS,GAAG,OAAO,EACzD,mBAAmB,CACpB,CAAC;IACF,uBAAuB,EAAE,eAAe,CACtC,eAAe,CAAC,uBAAuB,CAAC,GAAG,OAAO,EAClD,eAAe,CAChB,CAAC;IACF,yCAAyC,EAAE,eAAe,CACxD,WAAW,CAAC,yCAAyC,CAAC,GACpD,SAAS,GACT,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF,+BAA+B,EAAE,eAAe,CAC9C,eAAe,CAAC,+BAA+B,CAAC,GAAG,QAAQ,EAC3D,eAAe,CAChB,CAAC;IACF,8BAA8B,EAAE,eAAe,CAC7C,WAAW,CAAC,8BAA8B,CAAC,GAAG,QAAQ,GAAG,SAAS,EAClE,eAAe,CAChB,CAAC;IACF,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,QAAQ,EAC7D,eAAe,CAChB,CAAC;IACF,gCAAgC,EAAE,eAAe,CAC/C,WAAW,CAAC,gCAAgC,CAAC,GAAG,QAAQ,GAAG,SAAS,EACpE,eAAe,CAChB,CAAC;IACF,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,QAAQ,EAC7D,eAAe,CAChB,CAAC;IACF,gCAAgC,EAAE,eAAe,CAC/C,WAAW,CAAC,gCAAgC,CAAC,GAAG,QAAQ,GAAG,SAAS,EACpE,eAAe,CAChB,CAAC;IACF,6CAA6C,EAAE,eAAe,CAC5D,WAAW,CAAC,6CAA6C,CAAC,GACxD,SAAS,GACT,OAAO,GACP,UAAU,EACZ,gBAAgB,CACjB,CAAC;IACF,mCAAmC,EAAE,eAAe,CAClD,eAAe,CAAC,mCAAmC,CAAC,GAAG,OAAO,GAAG,UAAU,EAC3E,eAAe,CAChB,CAAC;IACF,kCAAkC,EAAE,eAAe,CACjD,WAAW,CAAC,kCAAkC,CAAC,GAC7C,OAAO,GACP,UAAU,GACV,SAAS,EACX,eAAe,CAChB,CAAC;IACF,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,OAAO,GACP,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,OAAO,GAAG,QAAQ,EACvE,eAAe,CAChB,CAAC;IACF,gCAAgC,EAAE,eAAe,CAC/C,WAAW,CAAC,gCAAgC,CAAC,GAC3C,OAAO,GACP,QAAQ,GACR,SAAS,EACX,eAAe,CAChB,CAAC;IACF,iDAAiD,EAAE,eAAe,CAChE,WAAW,CAAC,iDAAiD,CAAC,GAC5D,SAAS,GACT,OAAO,GACP,aAAa,EACf,gBAAgB,CACjB,CAAC;IACF,uCAAuC,EAAE,eAAe,CACtD,eAAe,CAAC,uCAAuC,CAAC,GACtD,aAAa,GACb,OAAO,EACT,eAAe,CAChB,CAAC;IACF,sCAAsC,EAAE,eAAe,CACrD,WAAW,CAAC,sCAAsC,CAAC,GACjD,SAAS,GACT,OAAO,GACP,aAAa,EACf,eAAe,CAChB,CAAC;IACF,8CAA8C,EAAE,eAAe,CAC7D,WAAW,CAAC,8CAA8C,CAAC,GACzD,SAAS,GACT,OAAO,GACP,WAAW,EACb,gBAAgB,CACjB,CAAC;IACF,oCAAoC,EAAE,eAAe,CACnD,eAAe,CAAC,oCAAoC,CAAC,GACnD,OAAO,GACP,WAAW,EACb,eAAe,CAChB,CAAC;IACF,mCAAmC,EAAE,eAAe,CAClD,WAAW,CAAC,mCAAmC,CAAC,GAC9C,OAAO,GACP,WAAW,GACX,SAAS,EACX,eAAe,CAChB,CAAC;IACF,oDAAoD,EAAE,eAAe,CACnE,WAAW,CAAC,oDAAoD,CAAC,GAC/D,SAAS,GACT,OAAO,GACP,eAAe,EACjB,gBAAgB,CACjB,CAAC;IACF,0CAA0C,EAAE,eAAe,CACzD,eAAe,CAAC,0CAA0C,CAAC,GACzD,SAAS,GACT,OAAO,GACP,eAAe,EACjB,eAAe,CAChB,CAAC;IACF,iCAAiC,EAAE,eAAe,CAGhD;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,GAAG,UAAU,GAAG,kCAAkC,EACtE,iBAAiB,CAClB,CAAC;CACH;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,eAAe,IAC/D,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAEtB;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CAAC,EAAE,SAAS,MAAM,gBAAgB,IAClE,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;AAEnC;;;GAGG;AACH,MAAM,MAAM,qBAAqB,CAAC,EAAE,SAAS,MAAM,gBAAgB,IACjE,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;KACjC,EAAE,IAAI,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,EAAE,CAAC,SAAS,eAAe,CAC1E,GAAG,EACH,GAAG,CACJ,GACG,EAAE,GACF,KAAK;CACV,CAAC,MAAM,gBAAgB,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;KAC5B,EAAE,IAAI,qBAAqB,GAAG,gBAAgB,CAAC,EAAE,CAAC;CACpD,CAAC;AAEF,KAAK,+BAA+B,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,CACjE,MAAM,GAAG,EACT,GAAG,CACJ,GACG,GAAG,GACH,KAAK,CAAC;AAEV,KAAK,6CAA6C,CAAC,CAAC,IAClD,CAAC,SAAS,eAAe,CAAC,GAAG,EAAE,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,KAAK,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAAC,EAAE,SAAS,MAAM,gBAAgB,IACjE,+BAA+B,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,mCAAmC,CAC7C,EAAE,SAAS,MAAM,gBAAgB,IAC/B,6CAA6C,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC"}
+{"version":3,"file":"targets.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/targets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,eAAe,EACf,OAAO,EACP,eAAe,EACf,WAAW,EACX,aAAa,EACb,UAAU,EACV,QAAQ,EACT,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAC,kCAAkC,EAAC,MAAM,sCAAsC,CAAC;AAC7F,OAAO,EAAC,UAAU,EAAC,MAAM,sCAAsC,CAAC;AAEhE,KAAK,mBAAmB,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACzE,KAAK,gBAAgB,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AACxE,KAAK,iBAAiB,GAAG,mBAAmB,CAC1C,IAAI,CAAC,UAAU,EAAE,iBAAiB,GAAG,MAAM,GAAG,QAAQ,CAAC,CACxD,CAAC;AACF,KAAK,eAAe,GAAG,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACrE,KAAK,eAAe,GAAG,mBAAmB,CACxC,IAAI,CACF,UAAU,EACR,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,OAAO,GACP,UAAU,GACV,aAAa,GACb,OAAO,GACP,MAAM,GACN,YAAY,CACf,CACF,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,sBAAsB,EAAE,eAAe,CACrC,WAAW,CAAC,sBAAsB,CAAC,GAAG,SAAS,GAAG,OAAO,EACzD,mBAAmB,CACpB,CAAC;IACF;;;;OAIG;IACH,uBAAuB,EAAE,eAAe,CACtC,eAAe,CAAC,uBAAuB,CAAC,GAAG,OAAO,EAClD,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,yCAAyC,EAAE,eAAe,CACxD,WAAW,CAAC,yCAAyC,CAAC,GACpD,SAAS,GACT,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,+BAA+B,EAAE,eAAe,CAC9C,eAAe,CAAC,+BAA+B,CAAC,GAAG,QAAQ,EAC3D,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,8BAA8B,EAAE,eAAe,CAC7C,WAAW,CAAC,8BAA8B,CAAC,GAAG,QAAQ,GAAG,SAAS,EAClE,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,QAAQ,EAC7D,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,gCAAgC,EAAE,eAAe,CAC/C,WAAW,CAAC,gCAAgC,CAAC,GAAG,QAAQ,GAAG,SAAS,EACpE,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,QAAQ,EAC7D,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,gCAAgC,EAAE,eAAe,CAC/C,WAAW,CAAC,gCAAgC,CAAC,GAAG,QAAQ,GAAG,SAAS,EACpE,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,6CAA6C,EAAE,eAAe,CAC5D,WAAW,CAAC,6CAA6C,CAAC,GACxD,SAAS,GACT,OAAO,GACP,UAAU,EACZ,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,mCAAmC,EAAE,eAAe,CAClD,eAAe,CAAC,mCAAmC,CAAC,GAAG,OAAO,GAAG,UAAU,EAC3E,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,kCAAkC,EAAE,eAAe,CACjD,WAAW,CAAC,kCAAkC,CAAC,GAC7C,OAAO,GACP,UAAU,GACV,SAAS,EACX,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,OAAO,GACP,QAAQ,EACV,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,OAAO,GAAG,QAAQ,EACvE,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,gCAAgC,EAAE,eAAe,CAC/C,WAAW,CAAC,gCAAgC,CAAC,GAC3C,OAAO,GACP,QAAQ,GACR,SAAS,EACX,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,iDAAiD,EAAE,eAAe,CAChE,WAAW,CAAC,iDAAiD,CAAC,GAC5D,SAAS,GACT,OAAO,GACP,aAAa,EACf,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,uCAAuC,EAAE,eAAe,CACtD,eAAe,CAAC,uCAAuC,CAAC,GACtD,aAAa,GACb,OAAO,EACT,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,sCAAsC,EAAE,eAAe,CACrD,WAAW,CAAC,sCAAsC,CAAC,GACjD,SAAS,GACT,OAAO,GACP,aAAa,EACf,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,8CAA8C,EAAE,eAAe,CAC7D,WAAW,CAAC,8CAA8C,CAAC,GACzD,SAAS,GACT,OAAO,GACP,WAAW,EACb,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,oCAAoC,EAAE,eAAe,CACnD,eAAe,CAAC,oCAAoC,CAAC,GACnD,OAAO,GACP,WAAW,EACb,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,mCAAmC,EAAE,eAAe,CAClD,WAAW,CAAC,mCAAmC,CAAC,GAC9C,OAAO,GACP,WAAW,GACX,SAAS,EACX,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,oDAAoD,EAAE,eAAe,CACnE,WAAW,CAAC,oDAAoD,CAAC,GAC/D,SAAS,GACT,OAAO,GACP,eAAe,EACjB,gBAAgB,CACjB,CAAC;IACF;;;;OAIG;IACH,0CAA0C,EAAE,eAAe,CACzD,eAAe,CAAC,0CAA0C,CAAC,GACzD,SAAS,GACT,OAAO,GACP,eAAe,EACjB,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,iCAAiC,EAAE,eAAe,CAGhD;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,GAAG,UAAU,GAAG,kCAAkC,EACtE,iBAAiB,CAClB,CAAC;IACF;;;;OAIG;IACH,iCAAiC,EAAE,eAAe,CAChD;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,GAAG,UAAU,GAAG,kCAAkC,EACtE,iBAAiB,CAClB,CAAC;CACH;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,eAAe,IAC/D,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAEtB;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CAAC,EAAE,SAAS,MAAM,gBAAgB,IAClE,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;AAEnC;;;GAGG;AACH,MAAM,MAAM,qBAAqB,CAAC,EAAE,SAAS,MAAM,gBAAgB,IACjE,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;KACjC,EAAE,IAAI,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,EAAE,CAAC,SAAS,eAAe,CAC1E,GAAG,EACH,GAAG,CACJ,GACG,EAAE,GACF,KAAK;CACV,CAAC,MAAM,gBAAgB,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;KAC5B,EAAE,IAAI,qBAAqB,GAAG,gBAAgB,CAAC,EAAE,CAAC;CACpD,CAAC;AAEF,KAAK,+BAA+B,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,CACjE,MAAM,GAAG,EACT,GAAG,CACJ,GACG,GAAG,GACH,KAAK,CAAC;AAEV,KAAK,6CAA6C,CAAC,CAAC,IAClD,CAAC,SAAS,eAAe,CAAC,GAAG,EAAE,MAAM,UAAU,CAAC,GAAG,UAAU,GAAG,KAAK,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAAC,EAAE,SAAS,MAAM,gBAAgB,IACjE,+BAA+B,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,mCAAmC,CAC7C,EAAE,SAAS,MAAM,gBAAgB,IAC/B,6CAA6C,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC"}

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

@@ -4,18 +4,57 @@ import type { Payment } from './payment';
 import type { ShippingLine } from './shipping-line';
 import type { TaxLine } from './tax-line';
 import type { TransactionType } from './transaction-type';
+/**
+ * Base interface for completed transaction data shared across all transaction types.
+ */
 export interface BaseTransactionComplete {
+    /**
+     * The transaction type identifier indicating which kind of transaction was completed (for example, `'Sale'` for new purchases, `'Return'` for refunds, `'Exchange'` for item swaps, `'Reprint'` for receipt reprints). This determines the transaction's business logic, receipt format, and inventory impact.
+     */
     transactionType: TransactionType;
+    /**
+     * The unique numeric identifier for the Shopify order created by this transaction. This ID links the POS transaction to the order record in Shopify's system and can be used for order lookups, tracking, and API operations. Returns `undefined` for transactions that don't create orders (for example, reprints) or when order creation is pending.
+     */
     orderId?: number;
+    /**
+     * The customer information if this transaction is associated with a customer account. Contains the customer ID for linking to customer records. Returns `undefined` for guest transactions where no customer was selected or when the transaction doesn't support customer association.
+     */
     customer?: Customer;
+    /**
+     * An array of all discounts applied to this transaction, including cart-level discounts, automatic discounts, and discount codes. Each discount entry contains the discount amount, type, and description. Returns `undefined` or empty array when no discounts were applied. The sum of discount amounts reduces the final transaction total.
+     */
     discounts?: Discount[];
+    /**
+     * The total tax amount charged on this transaction as a `Money` object. This is the sum of all tax lines and represents the combined tax from all applicable tax jurisdictions and rules. Tax calculations are based on the location, products, customer, and tax settings configured in Shopify.
+     */
     taxTotal: Money;
+    /**
+     * The subtotal amount before taxes and after discounts are applied, as a `Money` object. This represents the sum of all line item prices (quantity × unit price) minus any discounts, but before tax is added. This is the taxable base amount for most tax calculations.
+     */
     subtotal: Money;
+    /**
+     * The final total amount the customer pays for this transaction as a `Money` object. This includes all line items, shipping charges, taxes, and accounts for all discounts. This is the amount that must be tendered through payment methods. Calculated as: subtotal + taxTotal + shipping - discounts.
+     */
     grandTotal: Money;
+    /**
+     * An array of all payment methods used to complete this transaction. Each payment entry specifies the payment type (for example, cash, credit card), amount tendered, and currency. Multiple entries indicate split payments where the customer paid using multiple methods (for example, part cash, part credit card). The sum of all payment amounts should equal or exceed the `grandTotal`.
+     */
     paymentMethods: Payment[];
+    /**
+     * The remaining balance still owed on this transaction as a `Money` object. Typically `{amount: 0, currency: "USD"}` for fully paid transactions. A positive balance indicates partial payment or layaway scenarios. A negative balance indicates overpayment, where change should be returned to the customer. Calculated as: grandTotal minus sum of all payment amounts.
+     */
     balanceDue: Money;
+    /**
+     * An array of shipping charges applied to this transaction. Each shipping line represents a shipping method with its price and associated taxes. Multiple entries can exist when different shipping methods apply to different items or when combining shipping with pickup. Returns `undefined` or empty array for transactions with no shipping charges (for example, in-store purchases, digital products).
+     */
     shippingLines?: ShippingLine[];
+    /**
+     * An array of individual tax lines showing the detailed tax breakdown by jurisdiction and tax type. Each tax line represents a specific tax (for example, state tax, federal tax, VAT, GST) with its rate and calculated amount. Multiple tax lines can apply to a single transaction based on location, product taxability, and tax rules. Returns `undefined` or empty array for tax-exempt transactions or when detailed tax breakdown isn't available.
+     */
     taxLines?: TaxLine[];
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the transaction was executed and completed (for example, `"2024-05-15T14:30:00Z"`). This marks the exact moment the transaction was finalized, payment was processed, and the order was created. Commonly used for transaction history, chronological sorting, reporting, audit trails, and synchronization with external systems.
+     */
     executedAt: string;
 }
 //# sourceMappingURL=base-transaction-complete.d.ts.map

package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-transaction-complete.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/base-transaction-complete.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAE,QAAQ,EAAC,MAAM,QAAQ,CAAC;AAC/C,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAExD,MAAM,WAAW,uBAAuB;IACtC,eAAe,EAAE,eAAe,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,QAAQ,EAAE,KAAK,CAAC;IAChB,QAAQ,EAAE,KAAK,CAAC;IAChB,UAAU,EAAE,KAAK,CAAC;IAClB,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,UAAU,EAAE,KAAK,CAAC;IAClB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAC/B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB"}
+{"version":3,"file":"base-transaction-complete.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/base-transaction-complete.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAE,QAAQ,EAAC,MAAM,QAAQ,CAAC;AAC/C,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC;IAClB;;OAEG;IACH,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB"}