@shopify/ui-extensions 2026.7.0-rc.7 → 2026.7.1
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/cjs/surfaces/checkout/preact/buyer-journey.js +3 -0
- package/build/cjs/surfaces/point-of-sale/events.js +1 -1
- package/build/esm/surfaces/checkout/preact/buyer-journey.mjs +3 -0
- package/build/esm/surfaces/point-of-sale/events.mjs +1 -1
- package/build/esnext/surfaces/checkout/preact/buyer-journey.esnext +3 -0
- package/build/esnext/surfaces/point-of-sale/events.esnext +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +21 -0
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/intents/intents.d.ts +11 -4
- package/build/ts/surfaces/admin/api/intents/intents.d.ts.map +1 -1
- 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/shipping/shipping-option-item.d.ts +5 -0
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +3 -3
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Chat.d.ts +101 -3
- package/build/ts/surfaces/checkout/components/Checkbox.d.ts +16 -4
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Chat.d.ts +101 -3
- package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +16 -4
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +5 -2
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/docs.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/api/docs.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/printing-api/printing-api.d.ts +100 -0
- package/build/ts/surfaces/point-of-sale/api/printing-api/printing-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +2 -1
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api.d.ts +3 -1
- package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +1 -1
- 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 -1
- 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 -1
- 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 -1
- 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 -1
- 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 +2 -18
- 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/events/cash-tracking-session-events.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/events/cash-tracking-session-events.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/events/transaction-complete-event.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/events/transaction-complete-event.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/events.d.ts +7 -1
- package/build/ts/surfaces/point-of-sale/events.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +17 -49
- 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.register-details.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 -1
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts +14 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +22 -0
- package/src/surfaces/admin/api/intents/intents.ts +11 -3
- 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/shipping/shipping-option-item.ts +5 -0
- package/src/surfaces/checkout/api/standard/standard.ts +3 -3
- package/src/surfaces/checkout/components/Chat.d.ts +101 -3
- package/src/surfaces/checkout/components/Checkbox.d.ts +16 -4
- package/src/surfaces/checkout/preact/buyer-journey.ts +3 -0
- package/src/surfaces/checkout/preact/shipping-option-target.ts +3 -0
- package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +9 -1
- package/src/surfaces/point-of-sale/api/docs.ts +11 -0
- package/src/surfaces/point-of-sale/api/print-api/print-api.ts +4 -0
- package/src/surfaces/point-of-sale/api/printing-api/printing-api.ts +105 -0
- package/src/surfaces/point-of-sale/api/standard/standard-api.ts +4 -0
- package/src/surfaces/point-of-sale/api.ts +10 -0
- package/src/surfaces/point-of-sale/components/QrCode.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/components-shared.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +1 -1
- package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +0 -2
- package/src/surfaces/point-of-sale/components.d.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +2 -22
- package/src/surfaces/point-of-sale/event/data.ts +1 -11
- package/src/surfaces/point-of-sale/events/cash-tracking-session-events.ts +1 -1
- package/src/surfaces/point-of-sale/events/transaction-complete-event.ts +1 -1
- package/src/surfaces/point-of-sale/events.ts +7 -1
- package/src/surfaces/point-of-sale/extension-targets.ts +16 -68
- package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +2 -1
- package/src/surfaces/point-of-sale/types/cart.ts +15 -0
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +0 -16
- 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 -51
- 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 -8
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-complete.event.observe.d.ts +0 -8
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-start.event.observe.d.ts +0 -8
- package/build/ts/surfaces/point-of-sale/targets/pos.transaction-complete.event.observe.d.ts +0 -8
- package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +0 -16
- package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +0 -52
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Printing API provides methods for triggering document printing and
|
|
3
|
+
* discovering available hardware printers. Content is fetched from a URL
|
|
4
|
+
* and can be sent to a specific printer or to the system print dialog.
|
|
5
|
+
*
|
|
6
|
+
* Accessed via `shopify.printing`, aligning with the web platform's
|
|
7
|
+
* `navigator.printing` namespace from the WICG Web Printing proposal.
|
|
8
|
+
*
|
|
9
|
+
* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/print | Window.print()}
|
|
10
|
+
* for the web platform equivalent (no parameters, prints current document).
|
|
11
|
+
* This API extends the concept with URL-based content and printer selection.
|
|
12
|
+
* @see {@link https://github.com/WICG/web-printing | WICG Web Printing} for the
|
|
13
|
+
* emerging web standard for printer enumeration and job submission. This API
|
|
14
|
+
* aligns with WICG's instance-level printer selection model.
|
|
15
|
+
* @publicDocs
|
|
16
|
+
*/
|
|
17
|
+
export interface PrintingApiContent {
|
|
18
|
+
/**
|
|
19
|
+
* Returns the list of hardware printers currently available to the
|
|
20
|
+
* device. Each printer includes its connection status and a reference
|
|
21
|
+
* that can be passed to `print()`.
|
|
22
|
+
*
|
|
23
|
+
* When no hardware printers are available, returns an empty array.
|
|
24
|
+
* The system print dialog is not included in this list — it is the
|
|
25
|
+
* default behavior when no `printer` option is provided to `print()`.
|
|
26
|
+
*
|
|
27
|
+
* @see {@link https://github.com/WICG/web-printing | WICG Web Printing}
|
|
28
|
+
* for the emerging web standard this aligns with.
|
|
29
|
+
* @returns A promise that resolves with the list of available hardware printers.
|
|
30
|
+
*/
|
|
31
|
+
getPrinters(): Promise<Printer[]>;
|
|
32
|
+
/**
|
|
33
|
+
* Triggers a print operation for the specified document source.
|
|
34
|
+
*
|
|
35
|
+
* When called without a `printer` option, opens the device's system
|
|
36
|
+
* print dialog (e.g., AirPrint on iOS, Android print service). When
|
|
37
|
+
* a `printer` reference is provided (from `getPrinters()`), sends
|
|
38
|
+
* the content directly to that printer without showing a dialog.
|
|
39
|
+
*
|
|
40
|
+
* The `src` parameter accepts either:
|
|
41
|
+
* - A relative path that will be appended to your app's [`application_url`](/docs/apps/build/cli-for-apps/app-configuration)
|
|
42
|
+
* - A full URL to your app's backend
|
|
43
|
+
*
|
|
44
|
+
* The content at the URL is fetched with the extension's session token
|
|
45
|
+
* for authentication. HTML, PDFs, and images are supported content types.
|
|
46
|
+
* PDFs can only be printed via the system print dialog: selecting a
|
|
47
|
+
* `printer` with a PDF `src` throws, because hardware (receipt) printers
|
|
48
|
+
* render HTML and image content only.
|
|
49
|
+
*
|
|
50
|
+
* @param src the source URL of the content to print.
|
|
51
|
+
* @param options optional configuration for the print operation.
|
|
52
|
+
* @returns A promise that resolves when the print job has been
|
|
53
|
+
* successfully sent. For hardware printers, this means the rasterized
|
|
54
|
+
* content has been dispatched — it does not wait for physical printing
|
|
55
|
+
* to complete. For the system print dialog, this resolves when the
|
|
56
|
+
* content is ready and the dialog appears.
|
|
57
|
+
* @throws {Error} when the content cannot be fetched from `src`.
|
|
58
|
+
* @throws {Error} when the specified `printer` is not connected.
|
|
59
|
+
* @throws {Error} when `src` is a PDF and a `printer` is selected, since
|
|
60
|
+
* receipt printers render HTML and image content only.
|
|
61
|
+
*/
|
|
62
|
+
print(src: string, options?: PrintOptions): Promise<void>;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Options for `shopify.printing.print()`.
|
|
66
|
+
* @publicDocs
|
|
67
|
+
*/
|
|
68
|
+
export interface PrintOptions {
|
|
69
|
+
/**
|
|
70
|
+
* A printer reference obtained from `getPrinters()`. When provided,
|
|
71
|
+
* the print job is sent directly to this printer without showing
|
|
72
|
+
* a system print dialog.
|
|
73
|
+
*
|
|
74
|
+
* When omitted, the system print dialog is shown, allowing the
|
|
75
|
+
* user to select a printer and configure print settings.
|
|
76
|
+
*/
|
|
77
|
+
printer?: Printer;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* A hardware printer available to the device, as returned by `shopify.printing.getPrinters()`.
|
|
81
|
+
* @publicDocs
|
|
82
|
+
*/
|
|
83
|
+
export interface Printer {
|
|
84
|
+
/** Unique identifier for this printer. */
|
|
85
|
+
id: string;
|
|
86
|
+
/** Human-readable display name (e.g., "Star TSP143" or "Front Counter Printer"). */
|
|
87
|
+
name: string;
|
|
88
|
+
/** Whether the printer is currently able to accept print jobs. */
|
|
89
|
+
connected: boolean;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* The `PrintingApi` object provides methods for triggering document printing
|
|
93
|
+
* and discovering available hardware printers. Access these methods through
|
|
94
|
+
* `shopify.printing`.
|
|
95
|
+
* @publicDocs
|
|
96
|
+
*/
|
|
97
|
+
export interface PrintingApi {
|
|
98
|
+
printing: PrintingApiContent;
|
|
99
|
+
}
|
|
100
|
+
//# sourceMappingURL=printing-api.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"printing-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/printing-api/printing-api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;OAYG;IACH,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3D;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC;IAEb,kEAAkE;IAClE,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,kBAAkB,CAAC;CAC9B"}
|
|
@@ -7,6 +7,7 @@ import { SessionApi } from '../session-api/session-api';
|
|
|
7
7
|
import { ToastApi } from '../toast-api/toast-api';
|
|
8
8
|
import { ProductSearchApi } from '../product-search-api/product-search-api';
|
|
9
9
|
import { PrintApi } from '../print-api/print-api';
|
|
10
|
+
import { PrintingApi } from '../printing-api/printing-api';
|
|
10
11
|
import { StorageApi } from '../storage-api/storage-api';
|
|
11
12
|
import { PinPadApi } from '../pin-pad-api';
|
|
12
13
|
import type { I18n } from '../../../../api';
|
|
@@ -21,5 +22,5 @@ export type StandardApi<T> = {
|
|
|
21
22
|
*/
|
|
22
23
|
extensionPoint: T;
|
|
23
24
|
i18n: I18n;
|
|
24
|
-
} & ExtensionApi<T> & LocaleApi & ToastApi & SessionApi & PrintApi & ProductSearchApi & DeviceApi & ConnectivityApi & StorageApi & PinPadApi & CameraApi;
|
|
25
|
+
} & ExtensionApi<T> & LocaleApi & ToastApi & SessionApi & PrintApi & PrintingApi & ProductSearchApi & DeviceApi & ConnectivityApi & StorageApi & PinPadApi & CameraApi;
|
|
25
26
|
//# sourceMappingURL=standard-api.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"standard-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/standard/standard-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAC,eAAe,EAAC,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAC,gBAAgB,EAAC,MAAM,0CAA0C,CAAC;
|
|
1
|
+
{"version":3,"file":"standard-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/standard/standard-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAC,eAAe,EAAC,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAC,gBAAgB,EAAC,MAAM,0CAA0C,CAAC;AAE1E,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,GAAG;IAClD;;OAEG;IACH,cAAc,EAAE,CAAC,CAAC;IAClB,IAAI,EAAE,IAAI,CAAC;CACZ,GAAG,YAAY,CAAC,CAAC,CAAC,GACjB,SAAS,GACT,QAAQ,GACR,UAAU,GAEV,QAAQ,GACR,WAAW,GACX,gBAAgB,GAChB,SAAS,GACT,eAAe,GACf,UAAU,GACV,SAAS,GACT,SAAS,CAAC"}
|
|
@@ -16,16 +16,18 @@ export type { OrderApiContent, OrderApi } from './api/order-api/order-api';
|
|
|
16
16
|
export type { ProductApi, ProductApiContent, } from './api/product-api/product-api';
|
|
17
17
|
export type { DraftOrderApi, DraftOrderApiContent, } from './api/draft-order-api/draft-order-api';
|
|
18
18
|
export type { PrintApi, PrintApiContent } from './api/print-api/print-api';
|
|
19
|
+
export type { PrintingApi, PrintingApiContent, PrintOptions, Printer, } from './api/printing-api/printing-api';
|
|
19
20
|
export type { PaginationParams, ProductSortType, ProductSearchParams, ProductSearchApi, ProductSearchApiContent, } from './api/product-search-api/product-search-api';
|
|
20
21
|
export type { ScannerSource, ScannerSubscriptionResult, ScannerApi, ScannerApiContent, } from './api/scanner-api/scanner-api';
|
|
21
22
|
export type { SessionApiContent, SessionApi, } from './api/session-api/session-api';
|
|
22
23
|
export type { StorageApi } from './api/storage-api/storage-api';
|
|
23
24
|
export type { ToastApiContent, ToastApi } from './api/toast-api/toast-api';
|
|
24
|
-
export type { Cart, CartUpdateInput, Customer, LineItem, LineItemComponent, Discount, SetLineItemPropertiesInput, SetLineItemDiscountInput, LineItemDiscount, CustomSale, Address, SellingPlan, SetLineItemSellingPlanInput, } from './types/cart';
|
|
25
|
+
export type { AddLineItemOptions, Cart, CartUpdateInput, Customer, LineItem, LineItemComponent, Discount, SetLineItemPropertiesInput, SetLineItemDiscountInput, LineItemDiscount, CustomSale, Address, SellingPlan, SetLineItemSellingPlanInput, } from './types/cart';
|
|
25
26
|
export type { OrderLineItem, LineItemRefund } from './types/order';
|
|
26
27
|
export type { DirectApiRequestBody } from './types/direct-api-request-body';
|
|
27
28
|
export type { ShippingLine, CalculatedShippingLine, CustomShippingLine, } from './types/shipping-line';
|
|
28
29
|
export type { TaxLine } from './types/tax-line';
|
|
30
|
+
export type { DiscountAllocation } from './types/discount-allocation';
|
|
29
31
|
export type { PaymentMethod, Payment } from './types/payment';
|
|
30
32
|
export type { MultipleResourceResult } from './types/multiple-resource-result';
|
|
31
33
|
export type { PaginatedResult } from './types/paginated-result';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/api.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,OAAO,EACP,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AAEjC,YAAY,EAAC,eAAe,EAAC,MAAM,6CAA6C,CAAC;AAEjF,YAAY,EAAC,aAAa,EAAC,MAAM,uCAAuC,CAAC;AAEzE,YAAY,EAAC,SAAS,EAAE,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EAAC,WAAW,EAAC,MAAM,6BAA6B,CAAC;AAC7D,YAAY,EACV,YAAY,EACZ,mBAAmB,GACpB,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EAAC,eAAe,EAAC,MAAM,2CAA2C,CAAC;AAC/E,YAAY,EAAC,aAAa,EAAC,MAAM,uCAAuC,CAAC;AACzE,YAAY,EACV,wBAAwB,EACxB,6BAA6B,EAC7B,gCAAgC,EAChC,eAAe,GAChB,MAAM,UAAU,CAAC;AAElB,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AAErC,YAAY,EACV,yBAAyB,EACzB,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,GAChB,MAAM,yCAAyC,CAAC;AAEjD,YAAY,EACV,WAAW,EACX,kBAAkB,GACnB,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAC,SAAS,EAAE,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EAAC,SAAS,EAAE,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EAAC,eAAe,EAAE,QAAQ,EAAC,MAAM,2BAA2B,CAAC;AAEzE,YAAY,EACV,UAAU,EACV,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACV,aAAa,EACb,oBAAoB,GACrB,MAAM,uCAAuC,CAAC;AAE/C,YAAY,EAAC,QAAQ,EAAE,eAAe,EAAC,MAAM,2BAA2B,CAAC;AAEzE,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,uBAAuB,GACxB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACV,aAAa,EACb,yBAAyB,EACzB,UAAU,EACV,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACV,iBAAiB,EACjB,UAAU,GACX,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EAAC,UAAU,EAAC,MAAM,+BAA+B,CAAC;AAE9D,YAAY,EAAC,eAAe,EAAE,QAAQ,EAAC,MAAM,2BAA2B,CAAC;AAGzE,YAAY,EACV,IAAI,EACJ,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,0BAA0B,EAC1B,wBAAwB,EACxB,gBAAgB,EAChB,UAAU,EACV,OAAO,EACP,WAAW,EACX,2BAA2B,GAC5B,MAAM,cAAc,CAAC;AAEtB,YAAY,EAAC,aAAa,EAAE,cAAc,EAAC,MAAM,eAAe,CAAC;AAEjE,YAAY,EAAC,oBAAoB,EAAC,MAAM,iCAAiC,CAAC;AAE1E,YAAY,EACV,YAAY,EACZ,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAE/B,YAAY,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC;AAE9C,YAAY,EAAC,aAAa,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAE5D,YAAY,EAAC,sBAAsB,EAAC,MAAM,kCAAkC,CAAC;AAE7E,YAAY,EAAC,eAAe,EAAC,MAAM,0BAA0B,CAAC;AAE9D,YAAY,EACV,OAAO,EACP,cAAc,EACd,oBAAoB,EACpB,6BAA6B,EAC7B,aAAa,GACd,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAEtD,YAAY,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAC1D,YAAY,EAAC,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAE7C,YAAY,EAAC,gBAAgB,EAAE,SAAS,EAAC,MAAM,mBAAmB,CAAC;AACnE,YAAY,EACV,aAAa,EACb,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,iBAAiB,CAAC"}
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/api.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,OAAO,EACP,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AAEjC,YAAY,EAAC,eAAe,EAAC,MAAM,6CAA6C,CAAC;AAEjF,YAAY,EAAC,aAAa,EAAC,MAAM,uCAAuC,CAAC;AAEzE,YAAY,EAAC,SAAS,EAAE,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EAAC,WAAW,EAAC,MAAM,6BAA6B,CAAC;AAC7D,YAAY,EACV,YAAY,EACZ,mBAAmB,GACpB,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EAAC,eAAe,EAAC,MAAM,2CAA2C,CAAC;AAC/E,YAAY,EAAC,aAAa,EAAC,MAAM,uCAAuC,CAAC;AACzE,YAAY,EACV,wBAAwB,EACxB,6BAA6B,EAC7B,gCAAgC,EAChC,eAAe,GAChB,MAAM,UAAU,CAAC;AAElB,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AAErC,YAAY,EACV,yBAAyB,EACzB,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,GAChB,MAAM,yCAAyC,CAAC;AAEjD,YAAY,EACV,WAAW,EACX,kBAAkB,GACnB,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAC,SAAS,EAAE,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EAAC,SAAS,EAAE,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EAAC,eAAe,EAAE,QAAQ,EAAC,MAAM,2BAA2B,CAAC;AAEzE,YAAY,EACV,UAAU,EACV,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACV,aAAa,EACb,oBAAoB,GACrB,MAAM,uCAAuC,CAAC;AAE/C,YAAY,EAAC,QAAQ,EAAE,eAAe,EAAC,MAAM,2BAA2B,CAAC;AAEzE,YAAY,EACV,WAAW,EACX,kBAAkB,EAClB,YAAY,EACZ,OAAO,GACR,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,uBAAuB,GACxB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACV,aAAa,EACb,yBAAyB,EACzB,UAAU,EACV,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACV,iBAAiB,EACjB,UAAU,GACX,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EAAC,UAAU,EAAC,MAAM,+BAA+B,CAAC;AAE9D,YAAY,EAAC,eAAe,EAAE,QAAQ,EAAC,MAAM,2BAA2B,CAAC;AAGzE,YAAY,EACV,kBAAkB,EAClB,IAAI,EACJ,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,0BAA0B,EAC1B,wBAAwB,EACxB,gBAAgB,EAChB,UAAU,EACV,OAAO,EACP,WAAW,EACX,2BAA2B,GAC5B,MAAM,cAAc,CAAC;AAEtB,YAAY,EAAC,aAAa,EAAE,cAAc,EAAC,MAAM,eAAe,CAAC;AAEjE,YAAY,EAAC,oBAAoB,EAAC,MAAM,iCAAiC,CAAC;AAE1E,YAAY,EACV,YAAY,EACZ,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAE/B,YAAY,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC;AAE9C,YAAY,EAAC,kBAAkB,EAAC,MAAM,6BAA6B,CAAC;AAEpE,YAAY,EAAC,aAAa,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAE5D,YAAY,EAAC,sBAAsB,EAAC,MAAM,kCAAkC,CAAC;AAE7E,YAAY,EAAC,eAAe,EAAC,MAAM,0BAA0B,CAAC;AAE9D,YAAY,EACV,OAAO,EACP,cAAc,EACd,oBAAoB,EACpB,6BAA6B,EAC7B,aAAa,GACd,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAEtD,YAAY,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAC1D,YAAY,EAAC,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAE7C,YAAY,EAAC,gBAAgB,EAAE,SAAS,EAAC,MAAM,mBAAmB,CAAC;AACnE,YAAY,EACV,aAAa,EACb,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,iBAAiB,CAAC"}
|
|
@@ -45,7 +45,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
|
|
|
45
45
|
export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T & HTMLElement>;
|
|
46
46
|
|
|
47
47
|
declare const tagName = 's-qr-code';
|
|
48
|
-
/** @
|
|
48
|
+
/** @private */
|
|
49
49
|
export interface QrCodeJSXProps extends Pick<QRCodeProps, 'id' | 'content'> {}
|
|
50
50
|
declare global {
|
|
51
51
|
interface HTMLElementTagNameMap {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @publicDocs
|
|
3
3
|
*/
|
|
4
|
-
export type StandardComponents = 'Badge' | 'Banner' | 'Box' | 'Button' | 'Choice' | 'ChoiceList' | 'Clickable' | 'DateField' | 'DatePicker' | 'DateSpinner' | 'Divider' | 'EmailField' | 'Embed' | 'EmptyState' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'Modal' | 'NumberField' | 'Page' | 'POSBlock' | 'PosBlock' | '
|
|
4
|
+
export type StandardComponents = 'Badge' | 'Banner' | 'Box' | 'Button' | 'Choice' | 'ChoiceList' | 'Clickable' | 'DateField' | 'DatePicker' | 'DateSpinner' | 'Divider' | 'EmailField' | 'Embed' | 'EmptyState' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'Modal' | 'NumberField' | 'Page' | 'POSBlock' | 'PosBlock' | 'Route' | 'Router' | 'ScrollBox' | 'SearchField' | 'Section' | 'Spinner' | 'Stack' | 'Switch' | 'Tab' | 'TabList' | 'TabPanel' | 'Tabs' | 'Text' | 'TextArea' | 'TextField' | 'Tile' | 'TimeField' | 'TimePicker';
|
|
5
5
|
export default StandardComponents;
|
|
6
6
|
//# sourceMappingURL=StandardComponents.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StandardComponents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/targets/StandardComponents.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,OAAO,GACP,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,aAAa,GACb,SAAS,GACT,YAAY,GACZ,OAAO,GACP,YAAY,GACZ,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,OAAO,GACP,aAAa,GACb,MAAM,GACN,UAAU,GACV,UAAU,GACV,
|
|
1
|
+
{"version":3,"file":"StandardComponents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/targets/StandardComponents.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,OAAO,GACP,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,aAAa,GACb,SAAS,GACT,YAAY,GACZ,OAAO,GACP,YAAY,GACZ,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,OAAO,GACP,aAAa,GACb,MAAM,GACN,UAAU,GACV,UAAU,GACV,OAAO,GACP,QAAQ,GACR,WAAW,GACX,aAAa,GACb,SAAS,GACT,SAAS,GACT,OAAO,GACP,QAAQ,GACR,KAAK,GACL,SAAS,GACT,UAAU,GACV,MAAM,GACN,MAAM,GACN,UAAU,GACV,WAAW,GACX,MAAM,GACN,WAAW,GACX,YAAY,CAAC;AAEjB,eAAe,kBAAkB,CAAC"}
|
|
@@ -2,7 +2,8 @@ import { BaseTransactionComplete } from '../../types/base-transaction-complete';
|
|
|
2
2
|
import { LineItem } from '../../types/cart';
|
|
3
3
|
/**
|
|
4
4
|
* Defines the data structure for completed exchange transactions.
|
|
5
|
-
*
|
|
5
|
+
*
|
|
6
|
+
* @private
|
|
6
7
|
*/
|
|
7
8
|
export interface ExchangeTransactionData extends BaseTransactionComplete {
|
|
8
9
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ExchangeTransactionData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE1C
|
|
1
|
+
{"version":3,"file":"ExchangeTransactionData.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,cAAc,EAAE,QAAQ,EAAE,CAAC;IAC3B;;OAEG;IACH,gBAAgB,EAAE,QAAQ,EAAE,CAAC;CAC9B"}
|
|
@@ -3,7 +3,8 @@ import { LineItem } from '../../types/cart';
|
|
|
3
3
|
import { OrderLineItem } from '../../types/order';
|
|
4
4
|
/**
|
|
5
5
|
* Defines the data structure for receipt reprint requests.
|
|
6
|
-
*
|
|
6
|
+
*
|
|
7
|
+
* @private
|
|
7
8
|
*/
|
|
8
9
|
export interface ReprintReceiptData extends BaseTransactionComplete {
|
|
9
10
|
/**
|
|
@@ -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"}
|
|
@@ -2,7 +2,8 @@ import { BaseTransactionComplete } from '../../types/base-transaction-complete';
|
|
|
2
2
|
import { LineItem } from '../../types/cart';
|
|
3
3
|
/**
|
|
4
4
|
* Defines the data structure for completed return transactions.
|
|
5
|
-
*
|
|
5
|
+
*
|
|
6
|
+
* @private
|
|
6
7
|
*/
|
|
7
8
|
export interface ReturnTransactionData extends BaseTransactionComplete {
|
|
8
9
|
/**
|
|
@@ -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"}
|
|
@@ -2,7 +2,8 @@ import { BaseTransactionComplete } from '../../types/base-transaction-complete';
|
|
|
2
2
|
import { LineItem } from '../../types/cart';
|
|
3
3
|
/**
|
|
4
4
|
* Defines the data structure for completed sale transactions.
|
|
5
|
-
*
|
|
5
|
+
*
|
|
6
|
+
* @private
|
|
6
7
|
*/
|
|
7
8
|
export interface SaleTransactionData extends BaseTransactionComplete {
|
|
8
9
|
/**
|
|
@@ -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,26 +4,10 @@ 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
|
-
* @publicDocs
|
|
10
|
-
*/
|
|
11
|
-
export interface TransactionCompleteData extends BaseData, BaseApi {
|
|
12
|
-
/**
|
|
13
|
-
* Provides access to persistent local storage methods for your POS UI extension. Use this to store, retrieve, and manage data that persists across sessions.
|
|
14
|
-
*/
|
|
15
|
-
storage: BaseApi['storage'];
|
|
16
|
-
/**
|
|
17
|
-
* The transaction data, which can be one of the following types:
|
|
18
|
-
* - `SaleTransactionData`: Defines the data structure for completed sale transactions.
|
|
19
|
-
* - `ReturnTransactionData`: Defines the data structure for completed return transactions.
|
|
20
|
-
* - `ExchangeTransactionData`: Defines the data structure for completed exchange transactions.
|
|
21
|
-
*/
|
|
22
|
-
transaction: SaleTransactionData | ReturnTransactionData | ExchangeTransactionData;
|
|
23
|
-
}
|
|
24
7
|
/**
|
|
25
8
|
* The data object provided to receipt targets containing transaction details and reprint information.
|
|
26
|
-
*
|
|
9
|
+
*
|
|
10
|
+
* @private
|
|
27
11
|
*/
|
|
28
12
|
export interface TransactionCompleteWithReprintData extends BaseData, BaseApi {
|
|
29
13
|
/**
|
|
@@ -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;;;;GAIG;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 { SaleTransactionData } from './data/SaleTransactionData';
|
|
8
6
|
export type { ReturnTransactionData } from './data/ReturnTransactionData';
|
|
9
7
|
export type { ExchangeTransactionData } from './data/ExchangeTransactionData';
|
|
@@ -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;AACvF,YAAY,EAAC,mBAAmB,EAAC,MAAM,4BAA4B,CAAC;AACpE,YAAY,EAAC,qBAAqB,EAAC,MAAM,8BAA8B,CAAC;AACxE,YAAY,EAAC,uBAAuB,EAAC,MAAM,gCAAgC,CAAC;AAE5E,YAAY,EAAC,MAAM,EAAC,MAAM,iBAAiB,CAAC;AAC5C,YAAY,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Shared fields for every cash tracking session event.
|
|
3
3
|
*/
|
|
4
|
-
interface CashTrackingSessionEvent
|
|
4
|
+
interface CashTrackingSessionEvent {
|
|
5
5
|
/** The numeric identifier for the cash tracking session. */
|
|
6
6
|
readonly id: number;
|
|
7
7
|
/** ISO 8601 timestamp when the session was opened. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cash-tracking-session-events.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/events/cash-tracking-session-events.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,
|
|
1
|
+
{"version":3,"file":"cash-tracking-session-events.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/events/cash-tracking-session-events.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,wBAAwB;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,6BACf,SAAQ,wBAAwB;CAAG;AAErC;;;;GAIG;AACH,MAAM,WAAW,gCACf,SAAQ,wBAAwB;IAChC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B"}
|
|
@@ -7,7 +7,7 @@ import type { TaxLine } from '../types/tax-line';
|
|
|
7
7
|
* Shared fields on every transaction-complete event, available regardless of
|
|
8
8
|
* `transactionType`.
|
|
9
9
|
*/
|
|
10
|
-
interface BaseTransactionCompleteEvent
|
|
10
|
+
interface BaseTransactionCompleteEvent {
|
|
11
11
|
/**
|
|
12
12
|
* The transaction type identifier indicating which kind of transaction was completed (for example, `'Sale'` for new purchases, `'Return'` for refunds, `'Exchange'` for item swaps). Narrow on this field to access transaction-type-specific properties.
|
|
13
13
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transaction-complete-event.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/events/transaction-complete-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AAChE,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,mBAAmB,CAAC;AAE/C;;;GAGG;AACH,UAAU,
|
|
1
|
+
{"version":3,"file":"transaction-complete-event.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/events/transaction-complete-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AAChE,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,mBAAmB,CAAC;AAE/C;;;GAGG;AACH,UAAU,4BAA4B;IACpC;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IACzD;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,YAAY,EAAE,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,KAAK,CAAC;CACzC;AAED;;GAEG;AACH,UAAU,iBAAkB,SAAQ,4BAA4B;IAC9D,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,UAAU,mBAAoB,SAAQ,4BAA4B;IAChE,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,UAAU,qBAAsB,SAAQ,4BAA4B;IAClE,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,QAAQ,EAAE,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,EAAE,CAAC;CACvC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,wBAAwB,GAChC,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,CAAC"}
|
|
@@ -12,7 +12,7 @@ export declare const POS_EVENT_NAMES: {
|
|
|
12
12
|
readonly CASH_TRACKING_SESSION_COMPLETE: "cashtrackingsessioncomplete";
|
|
13
13
|
};
|
|
14
14
|
/**
|
|
15
|
-
* Maps Shopify POS event names to their corresponding
|
|
15
|
+
* Maps Shopify POS event names to their corresponding payload types.
|
|
16
16
|
*
|
|
17
17
|
* Used as the generic type parameter for `shopify.addEventListener` and
|
|
18
18
|
* `shopify.removeEventListener`.
|
|
@@ -20,8 +20,14 @@ export declare const POS_EVENT_NAMES: {
|
|
|
20
20
|
* @publicDocs
|
|
21
21
|
*/
|
|
22
22
|
export interface ShopifyEventMap {
|
|
23
|
+
/**
|
|
24
|
+
* Dispatched when a sale, return, or exchange transaction completes.
|
|
25
|
+
* Narrow on `transactionType` to access per-type fields.
|
|
26
|
+
*/
|
|
23
27
|
[POS_EVENT_NAMES.TRANSACTION_COMPLETE]: TransactionCompleteEvent;
|
|
28
|
+
/** Dispatched when a cash tracking session opens. */
|
|
24
29
|
[POS_EVENT_NAMES.CASH_TRACKING_SESSION_START]: CashTrackingSessionStartEvent;
|
|
30
|
+
/** Dispatched when a cash tracking session closes after reconciliation. */
|
|
25
31
|
[POS_EVENT_NAMES.CASH_TRACKING_SESSION_COMPLETE]: CashTrackingSessionCompleteEvent;
|
|
26
32
|
}
|
|
27
33
|
export type { TransactionCompleteEvent, CashTrackingSessionStartEvent, CashTrackingSessionCompleteEvent, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,wBAAwB,EAAC,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EACV,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,uCAAuC,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;;CAIlB,CAAC;AAEX;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,eAAe,CAAC,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IACjE,CAAC,eAAe,CAAC,2BAA2B,CAAC,EAAE,6BAA6B,CAAC;IAC7E,CAAC,eAAe,CAAC,8BAA8B,CAAC,EAAE,gCAAgC,CAAC;CACpF;AAED,YAAY,EACV,wBAAwB,EACxB,6BAA6B,EAC7B,gCAAgC,GACjC,CAAC"}
|
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,wBAAwB,EAAC,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EACV,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,uCAAuC,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;;CAIlB,CAAC;AAEX;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,CAAC,eAAe,CAAC,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IACjE,qDAAqD;IACrD,CAAC,eAAe,CAAC,2BAA2B,CAAC,EAAE,6BAA6B,CAAC;IAC7E,2EAA2E;IAC3E,CAAC,eAAe,CAAC,8BAA8B,CAAC,EAAE,gCAAgC,CAAC;CACpF;AAED,YAAY,EACV,wBAAwB,EACxB,6BAA6B,EAC7B,gCAAgC,GACjC,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, RunnableExtension } from '../../extension';
|
|
6
2
|
import type { DataTargetApi } from './api/data-target-api/data-target-api';
|
|
7
3
|
import type { StandardApi, ActionApi, ActionTargetApi, CartApi, CartLineItemApi, CustomerApi, DraftOrderApi, ProductApi, OrderApi, StorageApi, CashDrawerApi } from './api';
|
|
@@ -11,46 +7,6 @@ import type { SmartGridComponents } from './components/targets/SmartGridComponen
|
|
|
11
7
|
import type { ReceiptComponents } from './components/targets/ReceiptComponents';
|
|
12
8
|
import type { BasicComponents } from './components/targets/BasicComponents';
|
|
13
9
|
import type { TransactionCompleteWithReprintData } from './event/data';
|
|
14
|
-
/**
|
|
15
|
-
* @publicDocs
|
|
16
|
-
*/
|
|
17
|
-
export interface EventExtensionTargets {
|
|
18
|
-
/**
|
|
19
|
-
* Fires when a transaction completes successfully.
|
|
20
|
-
*
|
|
21
|
-
* @deprecated Deprecated as of version `2026-07`. Use the
|
|
22
|
-
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data) with
|
|
23
|
-
* `shopify.addEventListener('transactioncomplete', callback)` instead.
|
|
24
|
-
* @private
|
|
25
|
-
*/
|
|
26
|
-
'pos.transaction-complete.event.observe': (data: TransactionCompleteData) => Promise<BaseOutput>;
|
|
27
|
-
/**
|
|
28
|
-
* Fires when a cash tracking session starts.
|
|
29
|
-
*
|
|
30
|
-
* @deprecated Deprecated as of version `2026-07`. Use the
|
|
31
|
-
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data) with
|
|
32
|
-
* `shopify.addEventListener('cashtrackingsessionstart', callback)` instead.
|
|
33
|
-
* @private
|
|
34
|
-
*/
|
|
35
|
-
'pos.cash-tracking-session-start.event.observe': (data: CashTrackingSessionStartData) => Promise<BaseOutput>;
|
|
36
|
-
/**
|
|
37
|
-
* Fires when a cash tracking session completes.
|
|
38
|
-
*
|
|
39
|
-
* @deprecated Deprecated as of version `2026-07`. Use the
|
|
40
|
-
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data) with
|
|
41
|
-
* `shopify.addEventListener('cashtrackingsessioncomplete', callback)` instead.
|
|
42
|
-
* @private
|
|
43
|
-
*/
|
|
44
|
-
'pos.cash-tracking-session-complete.event.observe': (data: CashTrackingSessionCompleteData) => Promise<BaseOutput>;
|
|
45
|
-
/**
|
|
46
|
-
* Fires when the cart is updated.
|
|
47
|
-
*
|
|
48
|
-
* @deprecated Deprecated as of version `2026-07`. Use `api.cart.current.subscribe()` on the
|
|
49
|
-
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data) instead.
|
|
50
|
-
* @private
|
|
51
|
-
*/
|
|
52
|
-
'pos.cart-update.event.observe': (data: CartUpdateEventData) => Promise<BaseOutput>;
|
|
53
|
-
}
|
|
54
10
|
/**
|
|
55
11
|
* @publicDocs
|
|
56
12
|
*/
|
|
@@ -82,36 +38,48 @@ export interface RenderExtensionTargets {
|
|
|
82
38
|
* 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.
|
|
83
39
|
*
|
|
84
40
|
* 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.
|
|
41
|
+
*
|
|
42
|
+
* @private
|
|
85
43
|
*/
|
|
86
44
|
'pos.return.post.action.menu-item.render': RenderExtension<StandardApi<'pos.return.post.action.menu-item.render'> & ActionApi & OrderApi, ActionExtensionComponents>;
|
|
87
45
|
/**
|
|
88
46
|
* 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.
|
|
89
47
|
*
|
|
90
48
|
* Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
|
|
49
|
+
*
|
|
50
|
+
* @private
|
|
91
51
|
*/
|
|
92
52
|
'pos.return.post.action.render': RenderExtension<ActionTargetApi<'pos.return.post.action.render'> & OrderApi, BasicComponents>;
|
|
93
53
|
/**
|
|
94
54
|
* 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.
|
|
95
55
|
*
|
|
96
56
|
* 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.
|
|
57
|
+
*
|
|
58
|
+
* @private
|
|
97
59
|
*/
|
|
98
60
|
'pos.return.post.block.render': RenderExtension<StandardApi<'pos.return.post.block.render'> & OrderApi & ActionApi, BlockExtensionComponents>;
|
|
99
61
|
/**
|
|
100
62
|
* 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.
|
|
101
63
|
*
|
|
102
64
|
* 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.
|
|
65
|
+
*
|
|
66
|
+
* @private
|
|
103
67
|
*/
|
|
104
68
|
'pos.exchange.post.action.menu-item.render': RenderExtension<StandardApi<'pos.exchange.post.action.menu-item.render'> & ActionApi & OrderApi, ActionExtensionComponents>;
|
|
105
69
|
/**
|
|
106
70
|
* 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.
|
|
107
71
|
*
|
|
108
72
|
* Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
|
|
73
|
+
*
|
|
74
|
+
* @private
|
|
109
75
|
*/
|
|
110
76
|
'pos.exchange.post.action.render': RenderExtension<ActionTargetApi<'pos.exchange.post.action.render'> & OrderApi, BasicComponents>;
|
|
111
77
|
/**
|
|
112
78
|
* 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.
|
|
113
79
|
*
|
|
114
80
|
* 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.
|
|
81
|
+
*
|
|
82
|
+
* @private
|
|
115
83
|
*/
|
|
116
84
|
'pos.exchange.post.block.render': RenderExtension<StandardApi<'pos.exchange.post.block.render'> & OrderApi & ActionApi, BlockExtensionComponents>;
|
|
117
85
|
/**
|
|
@@ -220,6 +188,8 @@ export interface RenderExtensionTargets {
|
|
|
220
188
|
* 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.
|
|
221
189
|
*
|
|
222
190
|
* Extensions at this target appear in the receipt footer area and support limited components optimized for print formatting, including text content for information display.
|
|
191
|
+
*
|
|
192
|
+
* @private
|
|
223
193
|
*/
|
|
224
194
|
'pos.receipt-footer.block.render': RenderExtension<{
|
|
225
195
|
[key: string]: any;
|
|
@@ -228,6 +198,8 @@ export interface RenderExtensionTargets {
|
|
|
228
198
|
* 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.
|
|
229
199
|
*
|
|
230
200
|
* Extensions at this target appear in the receipt header area and support limited components optimized for print formatting, including text content for information display.
|
|
201
|
+
*
|
|
202
|
+
* @private
|
|
231
203
|
*/
|
|
232
204
|
'pos.receipt-header.block.render': RenderExtension<{
|
|
233
205
|
[key: string]: any;
|
|
@@ -254,16 +226,12 @@ export interface RenderExtensionTargets {
|
|
|
254
226
|
/**
|
|
255
227
|
* @publicDocs
|
|
256
228
|
*/
|
|
257
|
-
export interface ExtensionTargets extends RenderExtensionTargets,
|
|
229
|
+
export interface ExtensionTargets extends RenderExtensionTargets, DataExtensionTargets {
|
|
258
230
|
}
|
|
259
231
|
/**
|
|
260
232
|
* @publicDocs
|
|
261
233
|
*/
|
|
262
234
|
export type RenderExtensionTarget = keyof RenderExtensionTargets;
|
|
263
|
-
/**
|
|
264
|
-
* @publicDocs
|
|
265
|
-
*/
|
|
266
|
-
export type EventExtensionTarget = keyof EventExtensionTargets;
|
|
267
235
|
/**
|
|
268
236
|
* @publicDocs
|
|
269
237
|
*/
|
|
@@ -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,EAAE,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAExE,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,uCAAuC,CAAC;AAEzE,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,eAAe,EACf,OAAO,EACP,eAAe,EACf,WAAW,EACX,aAAa,EACb,UAAU,EACV,QAAQ,EACR,UAAU,EACV,aAAa,EACd,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;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,oBAAoB,EAAE,iBAAiB,CACrC,aAAa,CAAC,oBAAoB,CAAC,EACnC,SAAS,CACV,CAAC;CACH;AAED;;GAEG;AACH,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;;;;;;OAMG;IACH,yCAAyC,EAAE,eAAe,CACxD,WAAW,CAAC,yCAAyC,CAAC,GACpD,SAAS,GACT,QAAQ,EACV,yBAAyB,CAC1B,CAAC;IACF;;;;;;OAMG;IACH,+BAA+B,EAAE,eAAe,CAC9C,eAAe,CAAC,+BAA+B,CAAC,GAAG,QAAQ,EAC3D,eAAe,CAChB,CAAC;IACF;;;;;;OAMG;IACH,8BAA8B,EAAE,eAAe,CAC7C,WAAW,CAAC,8BAA8B,CAAC,GAAG,QAAQ,GAAG,SAAS,EAClE,wBAAwB,CACzB,CAAC;IACF;;;;;;OAMG;IACH,2CAA2C,EAAE,eAAe,CAC1D,WAAW,CAAC,2CAA2C,CAAC,GACtD,SAAS,GACT,QAAQ,EACV,yBAAyB,CAC1B,CAAC;IACF;;;;;;OAMG;IACH,iCAAiC,EAAE,eAAe,CAChD,eAAe,CAAC,iCAAiC,CAAC,GAAG,QAAQ,EAC7D,eAAe,CAChB,CAAC;IACF;;;;;;OAMG;IACH,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;;;;;;OAMG;IACH,iCAAiC,EAAE,eAAe,CAChD;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,GAAG,UAAU,GAAG,kCAAkC,EACtE,iBAAiB,CAClB,CAAC;IACF;;;;;;OAMG;IACH,iCAAiC,EAAE,eAAe,CAChD;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,GAAG,UAAU,GAAG,kCAAkC,EACtE,iBAAiB,CAClB,CAAC;IACF;;;;OAIG;IACH,8CAA8C,EAAE,eAAe,CAC7D,WAAW,CAAC,8CAA8C,CAAC,GACzD,SAAS,GACT,aAAa,EACf,yBAAyB,CAC1B,CAAC;IACF;;;;OAIG;IACH,oCAAoC,EAAE,eAAe,CACnD,eAAe,CAAC,oCAAoC,CAAC,GAAG,aAAa,EACrE,eAAe,CAChB,CAAC;IACF;;;;OAIG;IACH,mCAAmC,EAAE,eAAe,CAClD,WAAW,CAAC,mCAAmC,CAAC,GAC9C,SAAS,GACT,aAAa,EACf,wBAAwB,CACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gBACf,SAAQ,sBAAsB,EAC5B,oBAAoB;CAAG;AAE3B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,sBAAsB,CAAC;AACjE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,oBAAoB,CAAC;AAC7D;;GAEG;AACH,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
|
@@ -20,7 +20,6 @@ import "../components/Modal.d.ts";
|
|
|
20
20
|
import "../components/NumberField.d.ts";
|
|
21
21
|
import "../components/Page.d.ts";
|
|
22
22
|
import "../components/PosBlock.d.ts";
|
|
23
|
-
import "../components/QrCode.d.ts";
|
|
24
23
|
import "../components/ScrollBox.d.ts";
|
|
25
24
|
import "../components/SearchField.d.ts";
|
|
26
25
|
import "../components/Section.d.ts";
|
|
@@ -20,7 +20,6 @@ import "../components/Modal.d.ts";
|
|
|
20
20
|
import "../components/NumberField.d.ts";
|
|
21
21
|
import "../components/Page.d.ts";
|
|
22
22
|
import "../components/PosBlock.d.ts";
|
|
23
|
-
import "../components/QrCode.d.ts";
|
|
24
23
|
import "../components/ScrollBox.d.ts";
|
|
25
24
|
import "../components/SearchField.d.ts";
|
|
26
25
|
import "../components/Section.d.ts";
|
|
@@ -20,7 +20,6 @@ import "../components/Modal.d.ts";
|
|
|
20
20
|
import "../components/NumberField.d.ts";
|
|
21
21
|
import "../components/Page.d.ts";
|
|
22
22
|
import "../components/PosBlock.d.ts";
|
|
23
|
-
import "../components/QrCode.d.ts";
|
|
24
23
|
import "../components/ScrollBox.d.ts";
|
|
25
24
|
import "../components/SearchField.d.ts";
|
|
26
25
|
import "../components/Section.d.ts";
|
|
@@ -20,7 +20,6 @@ import "../components/Modal.d.ts";
|
|
|
20
20
|
import "../components/NumberField.d.ts";
|
|
21
21
|
import "../components/Page.d.ts";
|
|
22
22
|
import "../components/PosBlock.d.ts";
|
|
23
|
-
import "../components/QrCode.d.ts";
|
|
24
23
|
import "../components/ScrollBox.d.ts";
|
|
25
24
|
import "../components/SearchField.d.ts";
|
|
26
25
|
import "../components/Section.d.ts";
|