@shopify/ui-extensions 2025.10.15 → 2025.10.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/ts/surfaces/admin/components/Badge.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Button.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Clickable.d.ts +7 -7
- package/build/ts/surfaces/admin/components/Grid.d.ts +12 -12
- package/build/ts/surfaces/admin/components/GridItem.d.ts +7 -7
- package/build/ts/surfaces/admin/components/Image.d.ts +7 -7
- package/build/ts/surfaces/admin/components/Stack.d.ts +11 -11
- package/build/ts/surfaces/admin/components/TextField.d.ts +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +0 -3
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Checkbox.d.ts +12 -4
- package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +12 -4
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +1 -17
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data.d.ts +1 -3
- package/build/ts/surfaces/point-of-sale/event/data.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +33 -20
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.home.modal.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.order-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.product-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.return.post.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/surfaces/admin/components/Badge.d.ts +1 -1
- package/src/surfaces/admin/components/Button.d.ts +1 -1
- package/src/surfaces/admin/components/Clickable.d.ts +7 -7
- package/src/surfaces/admin/components/Grid.d.ts +12 -12
- package/src/surfaces/admin/components/GridItem.d.ts +7 -7
- package/src/surfaces/admin/components/Image.d.ts +7 -7
- package/src/surfaces/admin/components/Stack.d.ts +11 -11
- package/src/surfaces/admin/components/TextField.d.ts +1 -1
- package/src/surfaces/admin/components.d.ts +22 -22
- package/src/surfaces/checkout/api/standard/standard.ts +0 -3
- package/src/surfaces/checkout/components/Checkbox.d.ts +12 -4
- package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +0 -2
- package/src/surfaces/point-of-sale/components.d.ts +1 -1
- package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +2 -0
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +2 -0
- package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +2 -0
- package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +2 -0
- package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +1 -21
- package/src/surfaces/point-of-sale/event/data.ts +1 -10
- package/src/surfaces/point-of-sale/extension-targets.ts +33 -35
- package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +0 -13
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +0 -1
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +0 -43
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.cart-update.event.observe.d.ts +0 -7
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-complete.event.observe.d.ts +0 -7
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-start.event.observe.d.ts +0 -7
- package/build/ts/surfaces/point-of-sale/targets/pos.transaction-complete.event.observe.d.ts +0 -7
- package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +0 -13
- package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +0 -44
|
@@ -2,6 +2,8 @@ import { BaseTransactionComplete } from '../../types/base-transaction-complete';
|
|
|
2
2
|
import { LineItem } from '../../types/cart';
|
|
3
3
|
import { OrderLineItem } from '../../types/order';
|
|
4
4
|
/**
|
|
5
|
+
*
|
|
6
|
+
* @private
|
|
5
7
|
* Defines the data structure for receipt reprint requests.
|
|
6
8
|
*/
|
|
7
9
|
export interface ReprintReceiptData extends BaseTransactionComplete {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ReprintReceiptData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAC,aAAa,EAAC,MAAM,mBAAmB,CAAC;AAEhD
|
|
1
|
+
{"version":3,"file":"ReprintReceiptData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAC,aAAa,EAAC,MAAM,mBAAmB,CAAC;AAEhD;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE;;OAEG;IACH,eAAe,EAAE,SAAS,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC/B"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { BaseTransactionComplete } from '../../types/base-transaction-complete';
|
|
2
2
|
import { LineItem } from '../../types/cart';
|
|
3
3
|
/**
|
|
4
|
+
*
|
|
5
|
+
* @private
|
|
4
6
|
* Defines the data structure for completed return transactions.
|
|
5
7
|
*/
|
|
6
8
|
export interface ReturnTransactionData extends BaseTransactionComplete {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ReturnTransactionData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE1C
|
|
1
|
+
{"version":3,"file":"ReturnTransactionData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,eAAe,EAAE,QAAQ,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { BaseTransactionComplete } from '../../types/base-transaction-complete';
|
|
2
2
|
import { LineItem } from '../../types/cart';
|
|
3
3
|
/**
|
|
4
|
+
*
|
|
5
|
+
* @private
|
|
4
6
|
* Defines the data structure for completed sale transactions.
|
|
5
7
|
*/
|
|
6
8
|
export interface SaleTransactionData extends BaseTransactionComplete {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SaleTransactionData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/SaleTransactionData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE1C
|
|
1
|
+
{"version":3,"file":"SaleTransactionData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/SaleTransactionData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB"}
|
|
@@ -4,25 +4,9 @@ import type { ExchangeTransactionData } from './ExchangeTransactionData';
|
|
|
4
4
|
import type { ReturnTransactionData } from './ReturnTransactionData';
|
|
5
5
|
import type { ReprintReceiptData } from './ReprintReceiptData';
|
|
6
6
|
import { BaseApi } from './BaseApi';
|
|
7
|
-
/**
|
|
8
|
-
* The data object provided to receipt targets containing transaction details.
|
|
9
|
-
*/
|
|
10
|
-
export interface TransactionCompleteData extends BaseData, BaseApi {
|
|
11
|
-
/**
|
|
12
|
-
* Provides access to persistent local storage methods for your POS UI extension. Use this to store, retrieve, and manage data that persists across sessions.
|
|
13
|
-
*/
|
|
14
|
-
storage: BaseApi['storage'];
|
|
15
|
-
/**
|
|
16
|
-
* The transaction data, which can be one of the following types:
|
|
17
|
-
* - `SaleTransactionData`: Defines the data structure for completed sale transactions.
|
|
18
|
-
* - `ReturnTransactionData`: Defines the data structure for completed return transactions.
|
|
19
|
-
* - `ExchangeTransactionData`: Defines the data structure for completed exchange transactions.
|
|
20
|
-
*/
|
|
21
|
-
transaction: SaleTransactionData | ReturnTransactionData | ExchangeTransactionData;
|
|
22
|
-
}
|
|
23
7
|
/**
|
|
24
8
|
* The data object provided to receipt targets containing transaction details and reprint information.
|
|
25
|
-
* @
|
|
9
|
+
* @private
|
|
26
10
|
*/
|
|
27
11
|
export interface TransactionCompleteWithReprintData extends BaseData, BaseApi {
|
|
28
12
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TransactionCompleteData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAC/D,OAAO,KAAK,EAAC,uBAAuB,EAAC,MAAM,2BAA2B,CAAC;AACvE,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAElC
|
|
1
|
+
{"version":3,"file":"TransactionCompleteData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAC/D,OAAO,KAAK,EAAC,uBAAuB,EAAC,MAAM,2BAA2B,CAAC;AACvE,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAElC;;;GAGG;AACH,MAAM,WAAW,kCAAmC,SAAQ,QAAQ,EAAE,OAAO;IAC3E;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B;;;;;;OAMG;IACH,WAAW,EACP,mBAAmB,GACnB,qBAAqB,GACrB,uBAAuB,GACvB,kBAAkB,CAAC;CACxB"}
|
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
export type { BaseData } from './data/BaseData';
|
|
2
2
|
export type { BaseApi } from './data/BaseApi';
|
|
3
3
|
export type { ReprintReceiptData } from './data/ReprintReceiptData';
|
|
4
|
-
export type {
|
|
5
|
-
export type { CashTrackingSessionCompleteData, CashTrackingSessionStartData, } from './data/CashTrackingSessionData';
|
|
6
|
-
export type { CartUpdateEventData } from './data/CartUpdateEventData';
|
|
4
|
+
export type { TransactionCompleteWithReprintData } from './data/TransactionCompleteData';
|
|
7
5
|
export type { Device } from '../types/device';
|
|
8
6
|
export type { Money } from '../types/money';
|
|
9
7
|
//# sourceMappingURL=data.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/event/data.ts"],"names":[],"mappings":"AAAA,YAAY,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EAAC,OAAO,EAAC,MAAM,gBAAgB,CAAC;AAC5C,YAAY,EAAC,kBAAkB,EAAC,MAAM,2BAA2B,CAAC;AAClE,YAAY,
|
|
1
|
+
{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/event/data.ts"],"names":[],"mappings":"AAAA,YAAY,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EAAC,OAAO,EAAC,MAAM,gBAAgB,CAAC;AAC5C,YAAY,EAAC,kBAAkB,EAAC,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAC,kCAAkC,EAAC,MAAM,gCAAgC,CAAC;AAEvF,YAAY,EAAC,MAAM,EAAC,MAAM,iBAAiB,CAAC;AAC5C,YAAY,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC"}
|
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
import { BaseOutput } from './event/output';
|
|
2
|
-
import { CashTrackingSessionStartData, CashTrackingSessionCompleteData } from './event/data/CashTrackingSessionData';
|
|
3
|
-
import { TransactionCompleteData } from './event/data/TransactionCompleteData';
|
|
4
|
-
import { CartUpdateEventData } from './event/data/CartUpdateEventData';
|
|
5
1
|
import type { RenderExtension } from '../../extension';
|
|
6
2
|
import type { StandardApi, ActionApi, ActionTargetApi, CartApi, CartLineItemApi, CustomerApi, DraftOrderApi, ProductApi, OrderApi, StorageApi } from './api';
|
|
7
3
|
import type { ActionExtensionComponents } from './components/targets/ActionExtensionComponents';
|
|
@@ -10,12 +6,6 @@ import type { SmartGridComponents } from './components/targets/SmartGridComponen
|
|
|
10
6
|
import type { ReceiptComponents } from './components/targets/ReceiptComponents';
|
|
11
7
|
import type { BasicComponents } from './components/targets/BasicComponents';
|
|
12
8
|
import type { TransactionCompleteWithReprintData } from './event/data';
|
|
13
|
-
export interface EventExtensionTargets {
|
|
14
|
-
'pos.transaction-complete.event.observe': (data: TransactionCompleteData) => Promise<BaseOutput>;
|
|
15
|
-
'pos.cash-tracking-session-start.event.observe': (data: CashTrackingSessionStartData) => Promise<BaseOutput>;
|
|
16
|
-
'pos.cash-tracking-session-complete.event.observe': (data: CashTrackingSessionCompleteData) => Promise<BaseOutput>;
|
|
17
|
-
'pos.cart-update.event.observe': (data: CartUpdateEventData) => Promise<BaseOutput>;
|
|
18
|
-
}
|
|
19
9
|
export interface RenderExtensionTargets {
|
|
20
10
|
/**
|
|
21
11
|
* 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.
|
|
@@ -33,37 +23,55 @@ export interface RenderExtensionTargets {
|
|
|
33
23
|
* 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.
|
|
34
24
|
*
|
|
35
25
|
* 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.
|
|
36
|
-
|
|
26
|
+
|
|
27
|
+
*
|
|
28
|
+
* @private
|
|
29
|
+
*/
|
|
37
30
|
'pos.return.post.action.menu-item.render': RenderExtension<StandardApi<'pos.return.post.action.menu-item.render'> & ActionApi & OrderApi, ActionExtensionComponents>;
|
|
38
31
|
/**
|
|
39
32
|
* 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.
|
|
40
33
|
*
|
|
41
34
|
* Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
|
|
42
|
-
|
|
35
|
+
|
|
36
|
+
*
|
|
37
|
+
* @private
|
|
38
|
+
*/
|
|
43
39
|
'pos.return.post.action.render': RenderExtension<ActionTargetApi<'pos.return.post.action.render'> & OrderApi, BasicComponents>;
|
|
44
40
|
/**
|
|
45
41
|
* 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.
|
|
46
42
|
*
|
|
47
43
|
* 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.
|
|
48
|
-
|
|
44
|
+
|
|
45
|
+
*
|
|
46
|
+
* @private
|
|
47
|
+
*/
|
|
49
48
|
'pos.return.post.block.render': RenderExtension<StandardApi<'pos.return.post.block.render'> & OrderApi & ActionApi, BlockExtensionComponents>;
|
|
50
49
|
/**
|
|
51
50
|
* 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.
|
|
52
51
|
*
|
|
53
52
|
* 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.
|
|
54
|
-
|
|
53
|
+
|
|
54
|
+
*
|
|
55
|
+
* @private
|
|
56
|
+
*/
|
|
55
57
|
'pos.exchange.post.action.menu-item.render': RenderExtension<StandardApi<'pos.exchange.post.action.menu-item.render'> & ActionApi & OrderApi, ActionExtensionComponents>;
|
|
56
58
|
/**
|
|
57
59
|
* 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.
|
|
58
60
|
*
|
|
59
61
|
* Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
|
|
60
|
-
|
|
62
|
+
|
|
63
|
+
*
|
|
64
|
+
* @private
|
|
65
|
+
*/
|
|
61
66
|
'pos.exchange.post.action.render': RenderExtension<ActionTargetApi<'pos.exchange.post.action.render'> & OrderApi, BasicComponents>;
|
|
62
67
|
/**
|
|
63
68
|
* 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.
|
|
64
69
|
*
|
|
65
70
|
* 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.
|
|
66
|
-
|
|
71
|
+
|
|
72
|
+
*
|
|
73
|
+
* @private
|
|
74
|
+
*/
|
|
67
75
|
'pos.exchange.post.block.render': RenderExtension<StandardApi<'pos.exchange.post.block.render'> & OrderApi & ActionApi, BlockExtensionComponents>;
|
|
68
76
|
/**
|
|
69
77
|
* 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.
|
|
@@ -171,7 +179,10 @@ export interface RenderExtensionTargets {
|
|
|
171
179
|
* 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.
|
|
172
180
|
*
|
|
173
181
|
* Extensions at this target appear in the receipt footer area and support limited components optimized for print formatting, including text content for information display.
|
|
174
|
-
|
|
182
|
+
|
|
183
|
+
*
|
|
184
|
+
* @private
|
|
185
|
+
*/
|
|
175
186
|
'pos.receipt-footer.block.render': RenderExtension<{
|
|
176
187
|
[key: string]: any;
|
|
177
188
|
} & StorageApi & TransactionCompleteWithReprintData, ReceiptComponents>;
|
|
@@ -179,14 +190,16 @@ export interface RenderExtensionTargets {
|
|
|
179
190
|
* 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.
|
|
180
191
|
*
|
|
181
192
|
* Extensions at this target appear in the receipt header area and support limited components optimized for print formatting, including text content for information display.
|
|
182
|
-
|
|
193
|
+
|
|
194
|
+
*
|
|
195
|
+
* @private
|
|
196
|
+
*/
|
|
183
197
|
'pos.receipt-header.block.render': RenderExtension<{
|
|
184
198
|
[key: string]: any;
|
|
185
199
|
} & StorageApi & TransactionCompleteWithReprintData, ReceiptComponents>;
|
|
186
200
|
}
|
|
187
|
-
export interface ExtensionTargets extends RenderExtensionTargets
|
|
201
|
+
export interface ExtensionTargets extends RenderExtensionTargets {
|
|
188
202
|
}
|
|
189
203
|
export type RenderExtensionTarget = keyof RenderExtensionTargets;
|
|
190
|
-
export type EventExtensionTarget = keyof EventExtensionTargets;
|
|
191
204
|
export type ExtensionTarget = keyof ExtensionTargets;
|
|
192
205
|
//# sourceMappingURL=extension-targets.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extension-targets.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/extension-targets.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"extension-targets.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/extension-targets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAC;AAErD,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,eAAe,EACf,OAAO,EACP,eAAe,EACf,WAAW,EACX,aAAa,EACb,UAAU,EACV,QAAQ,EACR,UAAU,EACX,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAC,yBAAyB,EAAC,MAAM,gDAAgD,CAAC;AAC9F,OAAO,KAAK,EAAC,wBAAwB,EAAC,MAAM,+CAA+C,CAAC;AAC5F,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,0CAA0C,CAAC;AAClF,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,wCAAwC,CAAC;AAC9E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,sCAAsC,CAAC;AAC1E,OAAO,KAAK,EAAC,kCAAkC,EAAC,MAAM,cAAc,CAAC;AAErE,MAAM,WAAW,sBAAsB;IACrC;;;;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;;;;;;;KAOC;IACD,yCAAyC,EAAE,eAAe,CACxD,WAAW,CAAC,yCAAyC,CAAC,GACpD,SAAS,GACT,QAAQ,EACV,yBAAyB,CAC1B,CAAC;IACF;;;;;;;KAOC;IACD,+BAA+B,EAAE,eAAe,CAC9C,eAAe,CAAC,+BAA+B,CAAC,GAAG,QAAQ,EAC3D,eAAe,CAChB,CAAC;IACF;;;;;;;KAOC;IACD,8BAA8B,EAAE,eAAe,CAC7C,WAAW,CAAC,8BAA8B,CAAC,GAAG,QAAQ,GAAG,SAAS,EAClE,wBAAwB,CACzB,CAAC;IACF;;;;;;;KAOC;IACD,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,QAAQ,EACV,yBAAyB,CAC1B,CAAC;IACF;;;;;;;KAOC;IACD,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,QAAQ,EAC7D,eAAe,CAChB,CAAC;IACF;;;;;;;KAOC;IACD,gCAAgC,EAAE,eAAe,CAC/C,WAAW,CAAC,gCAAgC,CAAC,GAAG,QAAQ,GAAG,SAAS,EACpE,wBAAwB,CACzB,CAAC;IACF;;;;OAIG;IACH,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,QAAQ,EACV,yBAAyB,CAC1B,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,wBAAwB,CACzB,CAAC;IACF;;;;OAIG;IACH,6CAA6C,EAAE,eAAe,CAC5D,WAAW,CAAC,6CAA6C,CAAC,GACxD,SAAS,GACT,OAAO,GACP,UAAU,EACZ,yBAAyB,CAC1B,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,wBAAwB,CACzB,CAAC;IACF;;;;OAIG;IACH,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,OAAO,GACP,QAAQ,EACV,yBAAyB,CAC1B,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,wBAAwB,CACzB,CAAC;IACF;;;;OAIG;IACH,iDAAiD,EAAE,eAAe,CAChE,WAAW,CAAC,iDAAiD,CAAC,GAC5D,SAAS,GACT,OAAO,GACP,aAAa,EACf,yBAAyB,CAC1B,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,wBAAwB,CACzB,CAAC;IACF;;;;OAIG;IACH,8CAA8C,EAAE,eAAe,CAC7D,WAAW,CAAC,8CAA8C,CAAC,GACzD,SAAS,GACT,OAAO,GACP,WAAW,EACb,yBAAyB,CAC1B,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,wBAAwB,CACzB,CAAC;IACF;;;;OAIG;IACH,oDAAoD,EAAE,eAAe,CACnE,WAAW,CAAC,oDAAoD,CAAC,GAC/D,SAAS,GACT,OAAO,GACP,eAAe,EACjB,yBAAyB,CAC1B,CAAC;IACF;;;;OAIG;IACH,0CAA0C,EAAE,eAAe,CACzD,eAAe,CAAC,0CAA0C,CAAC,GACzD,SAAS,GACT,OAAO,GACP,eAAe,EACjB,eAAe,CAChB,CAAC;IACF;;;;;;;KAOC;IACD,iCAAiC,EAAE,eAAe,CAChD;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,GAAG,UAAU,GAAG,kCAAkC,EACtE,iBAAiB,CAClB,CAAC;IACF;;;;;;;KAOC;IACD,iCAAiC,EAAE,eAAe,CAChD;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,GAAG,UAAU,GAAG,kCAAkC,EACtE,iBAAiB,CAClB,CAAC;CACH;AAED,MAAM,WAAW,gBAAiB,SAAQ,sBAAsB;CAAG;AAEnE,MAAM,MAAM,qBAAqB,GAAG,MAAM,sBAAsB,CAAC;AACjE,MAAM,MAAM,eAAe,GAAG,MAAM,gBAAgB,CAAC"}
|
package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.render.d.ts
CHANGED
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -17,7 +17,6 @@ import "../components/Modal.d.ts";
|
|
|
17
17
|
import "../components/NumberField.d.ts";
|
|
18
18
|
import "../components/Page.d.ts";
|
|
19
19
|
import "../components/PosBlock.d.ts";
|
|
20
|
-
import "../components/QrCode.d.ts";
|
|
21
20
|
import "../components/ScrollBox.d.ts";
|
|
22
21
|
import "../components/SearchField.d.ts";
|
|
23
22
|
import "../components/Section.d.ts";
|
|
@@ -5,6 +5,8 @@ import type { ShippingLine } from './shipping-line';
|
|
|
5
5
|
import type { TaxLine } from './tax-line';
|
|
6
6
|
import type { TransactionType } from './transaction-type';
|
|
7
7
|
/**
|
|
8
|
+
*
|
|
9
|
+
* @private
|
|
8
10
|
* Base interface for completed transaction data shared across all transaction types.
|
|
9
11
|
*/
|
|
10
12
|
export interface BaseTransactionComplete {
|
|
@@ -1 +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
|
|
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;;;;GAIG;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;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB"}
|