@shopify/ui-extensions 2023.4.2 → 2023.7.0
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/README.md +1 -1
- package/build/cjs/surfaces/admin/components/ResourceItem/ResourceItem.js +14 -0
- package/build/cjs/surfaces/admin/components/ResourceList/ResourceList.js +15 -0
- package/build/cjs/surfaces/admin/components/Thumbnail/Thumbnail.js +12 -0
- package/build/cjs/surfaces/admin.js +6 -0
- package/build/cjs/surfaces/checkout/extension.js +7 -28
- package/build/cjs/surfaces/checkout.js +0 -1
- package/build/esm/surfaces/admin/components/ResourceItem/ResourceItem.mjs +10 -0
- package/build/esm/surfaces/admin/components/ResourceList/ResourceList.mjs +11 -0
- package/build/esm/surfaces/admin/components/Thumbnail/Thumbnail.mjs +8 -0
- package/build/esm/surfaces/admin.mjs +3 -0
- package/build/esm/surfaces/checkout/extension.mjs +7 -27
- package/build/esm/surfaces/checkout.mjs +1 -1
- package/build/esnext/surfaces/admin/components/ResourceItem/ResourceItem.esnext +10 -0
- package/build/esnext/surfaces/admin/components/ResourceList/ResourceList.esnext +11 -0
- package/build/esnext/surfaces/admin/components/Thumbnail/Thumbnail.esnext +8 -0
- package/build/esnext/surfaces/admin.esnext +3 -0
- package/build/esnext/surfaces/checkout/extension.esnext +7 -27
- package/build/esnext/surfaces/checkout.esnext +1 -1
- package/build/ts/api.d.ts +0 -15
- package/build/ts/api.d.ts.map +1 -1
- package/build/ts/extension.d.ts +0 -3
- package/build/ts/extension.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/action/action.d.ts +5 -2
- package/build/ts/surfaces/admin/api/action/action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/block/block.d.ts +10 -0
- package/build/ts/surfaces/admin/api/block/block.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/block/block.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/api/block/block.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts +45 -0
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts +46 -0
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/shared.d.ts +9 -0
- package/build/ts/surfaces/admin/api/shared.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/standard/standard.d.ts +18 -2
- package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api.d.ts +4 -1
- package/build/ts/surfaces/admin/api.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Checkbox/Checkbox.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Form/Form.d.ts +0 -10
- package/build/ts/surfaces/admin/components/Form/Form.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Form/Form.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/HeadingGroup/HeadingGroup.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ResourceItem/ResourceItem.d.ts +17 -0
- package/build/ts/surfaces/admin/components/ResourceItem/ResourceItem.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/ResourceList/ResourceList.d.ts +26 -0
- package/build/ts/surfaces/admin/components/ResourceList/ResourceList.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.d.ts +19 -0
- package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components.d.ts +6 -0
- package/build/ts/surfaces/admin/components.d.ts.map +1 -1
- package/build/ts/surfaces/admin/extension-targets.d.ts +10 -4
- package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts +9 -0
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +67 -1
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/{payment-method/render.d.ts → payment/payment-option-item.d.ts} +2 -2
- package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/api/pickup/{pickup-points.d.ts → pickup-location-list.d.ts} +3 -3
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/api/pickup/{pickup-locations.d.ts → pickup-point-list.d.ts} +3 -3
- package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/api/redeemable/{render.d.ts → redeemable.d.ts} +2 -2
- package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/api/shared.d.ts +91 -1
- package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shipping/{shipping-method-details.d.ts → shipping-option-item.d.ts} +4 -4
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +171 -171
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api.d.ts +9 -9
- package/build/ts/surfaces/checkout/api.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/PhoneField/PhoneField.d.ts +1 -1
- package/build/ts/surfaces/checkout/components/TextField/TextField.d.ts +1 -1
- package/build/ts/surfaces/checkout/components/shared.d.ts +11 -2
- package/build/ts/surfaces/checkout/components/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/extension.d.ts +7 -28
- package/build/ts/surfaces/checkout/extension.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/globals.d.ts +2 -2
- package/build/ts/surfaces/checkout/globals.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/targets.d.ts +411 -0
- package/build/ts/surfaces/checkout/targets.d.ts.map +1 -0
- package/build/ts/surfaces/checkout.d.ts +1 -1
- package/build/ts/surfaces/checkout.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts +9 -0
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +1212 -0
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/api/shared.d.ts +126 -0
- package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/api.d.ts +4 -0
- package/build/ts/surfaces/customer-account/api.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/extension.d.ts +16 -0
- package/build/ts/surfaces/customer-account/extension.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/globals.d.ts +11 -0
- package/build/ts/surfaces/customer-account/globals.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/targets.d.ts +78 -0
- package/build/ts/surfaces/customer-account/targets.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account.d.ts +8 -0
- package/build/ts/surfaces/customer-account.d.ts.map +1 -0
- package/build/ts/utilities/registration.d.ts +5 -5
- package/build/ts/utilities/registration.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +17 -8
- package/src/api.ts +0 -18
- package/src/extension.ts +0 -4
- package/src/surfaces/admin/api/action/action.ts +6 -4
- package/src/surfaces/admin/api/block/block.doc.ts +20 -0
- package/src/surfaces/admin/api/block/block.ts +11 -0
- package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts +49 -0
- package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts +50 -0
- package/src/surfaces/admin/api/shared.ts +6 -0
- package/src/surfaces/admin/api/standard/standard.ts +20 -8
- package/src/surfaces/admin/api.ts +4 -1
- package/src/surfaces/admin/components/Checkbox/Checkbox.doc.ts +1 -7
- package/src/surfaces/admin/components/Form/Form.doc.ts +0 -5
- package/src/surfaces/admin/components/Form/Form.ts +0 -12
- package/src/surfaces/admin/components/HeadingGroup/HeadingGroup.doc.ts +0 -7
- package/src/surfaces/admin/components/ResourceItem/ResourceItem.ts +19 -0
- package/src/surfaces/admin/components/ResourceItem/examples/basic-ResourceItem.example.ts +22 -0
- package/src/surfaces/admin/components/ResourceList/ResourceList.ts +30 -0
- package/src/surfaces/admin/components/ResourceList/examples/basic-ResourceList.example.ts +29 -0
- package/src/surfaces/admin/components/Select/Select.doc.ts +1 -7
- package/src/surfaces/admin/components/Thumbnail/Thumbnail.ts +31 -0
- package/src/surfaces/admin/components/Thumbnail/examples/basic-Thumbnail.example.ts +13 -0
- package/src/surfaces/admin/components.ts +6 -0
- package/src/surfaces/admin/extension-targets.ts +38 -3
- package/src/surfaces/checkout/api/cart-line/cart-line-item.ts +10 -0
- package/src/surfaces/checkout/api/checkout/checkout.ts +83 -1
- package/src/surfaces/checkout/api/{payment-method/render.ts → payment/payment-option-item.ts} +1 -1
- package/src/surfaces/checkout/api/pickup/{pickup-points.ts → pickup-location-list.ts} +2 -2
- package/src/surfaces/checkout/api/pickup/{pickup-locations.ts → pickup-point-list.ts} +2 -2
- package/src/surfaces/checkout/api/redeemable/{render.ts → redeemable.ts} +1 -1
- package/src/surfaces/checkout/api/shared.ts +103 -0
- package/src/surfaces/checkout/api/shipping/{shipping-method-details.ts → shipping-option-item.ts} +3 -3
- package/src/surfaces/checkout/api/standard/README.md +12 -10
- package/src/surfaces/checkout/api/standard/standard.ts +180 -187
- package/src/surfaces/checkout/api.ts +18 -10
- package/src/surfaces/checkout/components/Banner/examples/basic-banner.example.ts +1 -1
- package/src/surfaces/checkout/components/BlockLayout/examples/basic-blockLayout.example.ts +1 -1
- package/src/surfaces/checkout/components/BlockLayout/examples/basic-blocklayout.example.ts +1 -1
- package/src/surfaces/checkout/components/BlockSpacer/examples/basic-blockspacer.example.ts +1 -1
- package/src/surfaces/checkout/components/BlockStack/examples/basic-blockstack.example.ts +1 -1
- package/src/surfaces/checkout/components/Button/examples/basic-button.example.ts +1 -1
- package/src/surfaces/checkout/components/Checkbox/examples/basic-checkbox.example.ts +1 -1
- package/src/surfaces/checkout/components/Choice/examples/basic-choice.example.ts +1 -1
- package/src/surfaces/checkout/components/ChoiceList/examples/basic-choicelist.example.ts +1 -1
- package/src/surfaces/checkout/components/DateField/examples/basic-datefield.example.ts +1 -1
- package/src/surfaces/checkout/components/DatePicker/examples/basic-datepicker.example.ts +1 -1
- package/src/surfaces/checkout/components/Disclosure/examples/basic-disclosure.example.ts +1 -1
- package/src/surfaces/checkout/components/Divider/examples/basic-divider.example.ts +1 -1
- package/src/surfaces/checkout/components/Form/examples/basic-form.example.ts +1 -1
- package/src/surfaces/checkout/components/Grid/examples/basic-grid.example.ts +1 -1
- package/src/surfaces/checkout/components/GridItem/examples/basic-griditem.example.ts +1 -1
- package/src/surfaces/checkout/components/Heading/examples/basic-heading.example.ts +1 -1
- package/src/surfaces/checkout/components/HeadingGroup/examples/basic-headinggroup.example.ts +1 -1
- package/src/surfaces/checkout/components/Icon/examples/basic-icon.example.ts +1 -1
- package/src/surfaces/checkout/components/Image/examples/basic-image.example.ts +1 -1
- package/src/surfaces/checkout/components/InlineLayout/examples/basic-inlineLayout.example.ts +1 -1
- package/src/surfaces/checkout/components/InlineLayout/examples/basic-inlinelayout.example.ts +1 -1
- package/src/surfaces/checkout/components/InlineSpacer/examples/basic-inlinespacer.example.ts +1 -1
- package/src/surfaces/checkout/components/InlineStack/examples/basic-inlinestack.example.ts +1 -1
- package/src/surfaces/checkout/components/Link/examples/basic-link.example.ts +1 -1
- package/src/surfaces/checkout/components/List/examples/basic-list.example.ts +1 -1
- package/src/surfaces/checkout/components/ListItem/examples/basic-listitem.example.ts +1 -1
- package/src/surfaces/checkout/components/Modal/examples/basic-modal.example.ts +1 -1
- package/src/surfaces/checkout/components/PhoneField/PhoneField.ts +1 -1
- package/src/surfaces/checkout/components/PhoneField/examples/basic-phonefield.example.ts +1 -1
- package/src/surfaces/checkout/components/Popover/examples/basic-popover.example.ts +1 -1
- package/src/surfaces/checkout/components/Pressable/examples/basic-pressable.example.ts +1 -1
- package/src/surfaces/checkout/components/ScrollView/examples/basic-scrollview.example.ts +1 -1
- package/src/surfaces/checkout/components/Select/examples/basic-select.example.ts +1 -1
- package/src/surfaces/checkout/components/SkeletonImage/examples/basic-skeletonimage.example.ts +1 -1
- package/src/surfaces/checkout/components/SkeletonText/examples/basic-skeletontext.example.ts +1 -1
- package/src/surfaces/checkout/components/SkeletonTextBlock/examples/basic-skeletontextblock.example.ts +1 -1
- package/src/surfaces/checkout/components/Spinner/examples/basic-spinner.example.ts +1 -1
- package/src/surfaces/checkout/components/Stepper/examples/basic-stepper.example.ts +1 -1
- package/src/surfaces/checkout/components/Tag/examples/basic-tag.example.ts +1 -1
- package/src/surfaces/checkout/components/Text/examples/basic-text.example.ts +1 -1
- package/src/surfaces/checkout/components/TextBlock/examples/basic-textblock.example.ts +1 -1
- package/src/surfaces/checkout/components/TextField/TextField.ts +1 -1
- package/src/surfaces/checkout/components/TextField/examples/basic-textfield.example.ts +1 -1
- package/src/surfaces/checkout/components/Tooltip/examples/basic-tooltip.example.ts +1 -1
- package/src/surfaces/checkout/components/View/examples/basic-view.example.ts +1 -1
- package/src/surfaces/checkout/components/shared.ts +22 -5
- package/src/surfaces/checkout/extension.ts +10 -56
- package/src/surfaces/checkout/globals.ts +7 -4
- package/src/surfaces/checkout/style/examples/style.example.ts +1 -1
- package/src/surfaces/checkout/style/examples/style.example.tsx +8 -2
- package/src/surfaces/checkout/targets.ts +701 -0
- package/src/surfaces/checkout.ts +1 -1
- package/src/surfaces/customer-account/api/cart-line/cart-line-item.ts +10 -0
- package/src/surfaces/customer-account/api/order-status/order-status.ts +1414 -0
- package/src/surfaces/customer-account/api/shared.ts +953 -0
- package/src/surfaces/customer-account/api.ts +66 -0
- package/src/surfaces/customer-account/extension.ts +21 -0
- package/src/surfaces/customer-account/globals.ts +18 -0
- package/src/surfaces/customer-account/targets.ts +116 -0
- package/src/surfaces/customer-account.ts +8 -0
- package/src/utilities/registration.ts +13 -12
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-details.d.ts +0 -9
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-details.d.ts.map +0 -1
- package/build/ts/surfaces/checkout/api/payment-method/render.d.ts.map +0 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-locations.d.ts.map +0 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-points.d.ts.map +0 -1
- package/build/ts/surfaces/checkout/api/redeemable/render.d.ts.map +0 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-method-details.d.ts.map +0 -1
- package/build/ts/surfaces/checkout/extension-points.d.ts +0 -220
- package/build/ts/surfaces/checkout/extension-points.d.ts.map +0 -1
- package/src/surfaces/checkout/api/cart-line/cart-line-details.ts +0 -10
- package/src/surfaces/checkout/components/Banner/README.md +0 -14
- package/src/surfaces/checkout/components/BlockLayout/README.md +0 -101
- package/src/surfaces/checkout/components/BlockSpacer/README.md +0 -14
- package/src/surfaces/checkout/components/BlockStack/README.md +0 -77
- package/src/surfaces/checkout/components/Button/README.md +0 -22
- package/src/surfaces/checkout/components/Checkbox/README.md +0 -18
- package/src/surfaces/checkout/components/Choice/README.md +0 -14
- package/src/surfaces/checkout/components/ChoiceList/README.md +0 -14
- package/src/surfaces/checkout/components/Divider/README.md +0 -13
- package/src/surfaces/checkout/components/Form/README.md +0 -21
- package/src/surfaces/checkout/components/Grid/README.md +0 -105
- package/src/surfaces/checkout/components/GridItem/README.md +0 -72
- package/src/surfaces/checkout/components/Heading/README.md +0 -19
- package/src/surfaces/checkout/components/HeadingGroup/README.md +0 -7
- package/src/surfaces/checkout/components/Icon/README.md +0 -15
- package/src/surfaces/checkout/components/Image/README.md +0 -53
- package/src/surfaces/checkout/components/InlineLayout/README.md +0 -103
- package/src/surfaces/checkout/components/InlineSpacer/README.md +0 -14
- package/src/surfaces/checkout/components/InlineStack/README.md +0 -87
- package/src/surfaces/checkout/components/Link/README.md +0 -18
- package/src/surfaces/checkout/components/List/README.md +0 -19
- package/src/surfaces/checkout/components/ListItem/README.md +0 -5
- package/src/surfaces/checkout/components/PhoneField/README.md +0 -49
- package/src/surfaces/checkout/components/Pressable/README.md +0 -74
- package/src/surfaces/checkout/components/ScrollView/README.md +0 -62
- package/src/surfaces/checkout/components/Select/README.md +0 -41
- package/src/surfaces/checkout/components/SkeletonImage/README.md +0 -13
- package/src/surfaces/checkout/components/SkeletonText/README.md +0 -13
- package/src/surfaces/checkout/components/SkeletonTextBlock/README.md +0 -13
- package/src/surfaces/checkout/components/Spinner/README.md +0 -14
- package/src/surfaces/checkout/components/Stepper/README.md +0 -28
- package/src/surfaces/checkout/components/Tag/README.md +0 -14
- package/src/surfaces/checkout/components/Text/README.md +0 -17
- package/src/surfaces/checkout/components/TextBlock/README.md +0 -15
- package/src/surfaces/checkout/components/TextField/README.md +0 -49
- package/src/surfaces/checkout/components/Tooltip/README.md +0 -8
- package/src/surfaces/checkout/components/View/README.md +0 -97
- package/src/surfaces/checkout/extension-points.ts +0 -369
|
@@ -0,0 +1,701 @@
|
|
|
1
|
+
import type {RenderExtension} from './extension';
|
|
2
|
+
import type {
|
|
3
|
+
CartLineItemApi,
|
|
4
|
+
PaymentOptionItemApi,
|
|
5
|
+
PickupLocationListApi,
|
|
6
|
+
RedeemableApi,
|
|
7
|
+
ShippingOptionItemApi,
|
|
8
|
+
PickupPointListApi,
|
|
9
|
+
StandardApi,
|
|
10
|
+
CheckoutApi,
|
|
11
|
+
OrderStatusApi,
|
|
12
|
+
} from './api';
|
|
13
|
+
import type {AnyComponent} from './shared';
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* A UI extension will register for one or more extension targets using `shopify.extend()`.
|
|
17
|
+
* An extension target in a UI extension is a plain JavaScript function.
|
|
18
|
+
* This function receives some API for interacting with the application,
|
|
19
|
+
* and is expected to return a value in a specific shape.
|
|
20
|
+
* The input arguments and the output type are different
|
|
21
|
+
* for each extension target.
|
|
22
|
+
*/
|
|
23
|
+
export interface ExtensionTargets {
|
|
24
|
+
/**
|
|
25
|
+
* A static extension target that is rendered immediately before any actions within each step.
|
|
26
|
+
*/
|
|
27
|
+
'purchase.checkout.actions.render-before': RenderExtension<
|
|
28
|
+
CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,
|
|
29
|
+
AnyComponent
|
|
30
|
+
>;
|
|
31
|
+
/**
|
|
32
|
+
* A static extension target that is rendered immediately before any actions within each step.
|
|
33
|
+
*
|
|
34
|
+
* @deprecated Use `purchase.checkout.actions.render-before` instead.
|
|
35
|
+
*/
|
|
36
|
+
'Checkout::Actions::RenderBefore': RenderExtension<
|
|
37
|
+
CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,
|
|
38
|
+
AnyComponent
|
|
39
|
+
>;
|
|
40
|
+
/**
|
|
41
|
+
* A static extension target that is rendered after all line items.
|
|
42
|
+
*/
|
|
43
|
+
'purchase.checkout.cart-line-list.render-after': RenderExtension<
|
|
44
|
+
CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,
|
|
45
|
+
AnyComponent
|
|
46
|
+
>;
|
|
47
|
+
/**
|
|
48
|
+
* A static extension target that is rendered after all line items.
|
|
49
|
+
*
|
|
50
|
+
* @deprecated Use `purchase.checkout.cart-line-list.render-after` instead.
|
|
51
|
+
*/
|
|
52
|
+
'Checkout::CartLines::RenderAfter': RenderExtension<
|
|
53
|
+
CheckoutApi &
|
|
54
|
+
StandardApi<'Checkout::CartLines::RenderAfter'> &
|
|
55
|
+
OrderStatusApi,
|
|
56
|
+
AnyComponent
|
|
57
|
+
>;
|
|
58
|
+
/**
|
|
59
|
+
* A static extension target that renders on every line item, inside the details
|
|
60
|
+
* under the line item properties element.
|
|
61
|
+
*/
|
|
62
|
+
'purchase.checkout.cart-line-item.render-after': RenderExtension<
|
|
63
|
+
CheckoutApi &
|
|
64
|
+
CartLineItemApi &
|
|
65
|
+
StandardApi<'purchase.checkout.cart-line-item.render-after'>,
|
|
66
|
+
AnyComponent
|
|
67
|
+
>;
|
|
68
|
+
/**
|
|
69
|
+
* A static extension target that renders on every line item, inside the details
|
|
70
|
+
* under the line item properties element.
|
|
71
|
+
*
|
|
72
|
+
* @deprecated Use `purchase.checkout.cart-line-item.render-after` instead.
|
|
73
|
+
*/
|
|
74
|
+
'Checkout::CartLineDetails::RenderAfter': RenderExtension<
|
|
75
|
+
CheckoutApi &
|
|
76
|
+
CartLineItemApi &
|
|
77
|
+
StandardApi<'Checkout::CartLineDetails::RenderAfter'> &
|
|
78
|
+
OrderStatusApi,
|
|
79
|
+
AnyComponent
|
|
80
|
+
>;
|
|
81
|
+
/**
|
|
82
|
+
* A static extension target that renders on every line item, inside the details
|
|
83
|
+
* under the line item properties element. It replaces the default component rendering.
|
|
84
|
+
*/
|
|
85
|
+
'purchase.cart-line-item.line-components.render': RenderExtension<
|
|
86
|
+
CartLineItemApi &
|
|
87
|
+
StandardApi<'purchase.cart-line-item.line-components.render'>,
|
|
88
|
+
AnyComponent
|
|
89
|
+
>;
|
|
90
|
+
/**
|
|
91
|
+
* A static extension target that renders on every line item, inside the details
|
|
92
|
+
* under the line item properties element. It replaces the default component rendering.
|
|
93
|
+
*
|
|
94
|
+
* @deprecated Use `purchase.cart-line-item.line-components.render` instead.
|
|
95
|
+
*/
|
|
96
|
+
'Checkout::CartLineDetails::RenderLineComponents': RenderExtension<
|
|
97
|
+
CartLineItemApi &
|
|
98
|
+
StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,
|
|
99
|
+
AnyComponent
|
|
100
|
+
>;
|
|
101
|
+
/**
|
|
102
|
+
* A static extension target that is rendered immediately after the contact form element.
|
|
103
|
+
*/
|
|
104
|
+
'purchase.checkout.contact.render-after': RenderExtension<
|
|
105
|
+
CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,
|
|
106
|
+
AnyComponent
|
|
107
|
+
>;
|
|
108
|
+
/**
|
|
109
|
+
* A static extension target that is rendered immediately after the contact form element.
|
|
110
|
+
*
|
|
111
|
+
* @deprecated Use `purchase.checkout.contact.render-after` instead.
|
|
112
|
+
*/
|
|
113
|
+
'Checkout::Contact::RenderAfter': RenderExtension<
|
|
114
|
+
CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,
|
|
115
|
+
AnyComponent
|
|
116
|
+
>;
|
|
117
|
+
/**
|
|
118
|
+
* A static extension target that is rendered after a purchase below the customer information.
|
|
119
|
+
*
|
|
120
|
+
* @deprecated Use `purchase.thank-you.customer-information.render-after` or
|
|
121
|
+
* `customer-account.order-status.customer-information.render-after` instead.
|
|
122
|
+
*/
|
|
123
|
+
'Checkout::CustomerInformation::RenderAfter': RenderExtension<
|
|
124
|
+
OrderStatusApi &
|
|
125
|
+
CheckoutApi &
|
|
126
|
+
StandardApi<'Checkout::CustomerInformation::RenderAfter'>,
|
|
127
|
+
AnyComponent
|
|
128
|
+
>;
|
|
129
|
+
/**
|
|
130
|
+
* A static extension target that is rendered between the shipping address header
|
|
131
|
+
* and shipping address form elements.
|
|
132
|
+
*/
|
|
133
|
+
'purchase.checkout.delivery-address.render-before': RenderExtension<
|
|
134
|
+
CheckoutApi &
|
|
135
|
+
StandardApi<'purchase.checkout.delivery-address.render-before'>,
|
|
136
|
+
AnyComponent
|
|
137
|
+
>;
|
|
138
|
+
/**
|
|
139
|
+
* A static extension target that is rendered between the shipping address header
|
|
140
|
+
* and shipping address form elements.
|
|
141
|
+
*
|
|
142
|
+
* @deprecated Use `purchase.checkout.delivery-address.render-before` instead.
|
|
143
|
+
*/
|
|
144
|
+
'Checkout::DeliveryAddress::RenderBefore': RenderExtension<
|
|
145
|
+
CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,
|
|
146
|
+
AnyComponent
|
|
147
|
+
>;
|
|
148
|
+
/**
|
|
149
|
+
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that isn't tied to a specific checkout section or feature.
|
|
150
|
+
* Unlike static extension targets, dynamic extension targets render where the merchant
|
|
151
|
+
* sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
|
|
152
|
+
*
|
|
153
|
+
* The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for dynamic extension targets can be previewed during development
|
|
154
|
+
* by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#dynamic-extension-targets).
|
|
155
|
+
*/
|
|
156
|
+
'purchase.checkout.block.render': RenderExtension<
|
|
157
|
+
CheckoutApi & StandardApi<'purchase.checkout.block.render'>,
|
|
158
|
+
AnyComponent
|
|
159
|
+
>;
|
|
160
|
+
/**
|
|
161
|
+
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that isn't tied to a specific checkout section or feature.
|
|
162
|
+
* Unlike static extension targets, dynamic extension targets render where the merchant
|
|
163
|
+
* sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
|
|
164
|
+
*
|
|
165
|
+
* The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for dynamic extension targets can be previewed during development
|
|
166
|
+
* by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#dynamic-extension-targets).
|
|
167
|
+
*
|
|
168
|
+
* @deprecated Use `purchase.checkout.block.render` instead.
|
|
169
|
+
*/
|
|
170
|
+
'Checkout::Dynamic::Render': RenderExtension<
|
|
171
|
+
CheckoutApi & OrderStatusApi & StandardApi<'Checkout::Dynamic::Render'>,
|
|
172
|
+
AnyComponent
|
|
173
|
+
>;
|
|
174
|
+
/**
|
|
175
|
+
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that renders exclusively on the Thank You Page.
|
|
176
|
+
* Unlike static extension targets, dynamic extension targets render where the merchant
|
|
177
|
+
* sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
|
|
178
|
+
*
|
|
179
|
+
* The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for dynamic extension targets can be previewed during development
|
|
180
|
+
* by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#dynamic-extension-targets).
|
|
181
|
+
*
|
|
182
|
+
*/
|
|
183
|
+
'purchase.thank-you.block.render': RenderExtension<
|
|
184
|
+
StandardApi<'purchase.thank-you.block.render'>,
|
|
185
|
+
AnyComponent
|
|
186
|
+
>;
|
|
187
|
+
/**
|
|
188
|
+
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that renders exclusively on the Thank You Page.
|
|
189
|
+
* Unlike static extension targets, dynamic extension targets render where the merchant
|
|
190
|
+
* sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
|
|
191
|
+
*
|
|
192
|
+
* The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for dynamic extension targets can be previewed during development
|
|
193
|
+
* by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#dynamic-extension-targets).
|
|
194
|
+
*
|
|
195
|
+
* @deprecated Use `purchase.thank-you.block.render` instead.
|
|
196
|
+
*/
|
|
197
|
+
'Checkout::ThankYou::Dynamic::Render': RenderExtension<
|
|
198
|
+
StandardApi<'Checkout::ThankYou::Dynamic::Render'>,
|
|
199
|
+
AnyComponent
|
|
200
|
+
>;
|
|
201
|
+
/**
|
|
202
|
+
* A static extension target that renders on every line item, inside the details
|
|
203
|
+
* under the line item properties element on the Thank You Page.
|
|
204
|
+
*/
|
|
205
|
+
'purchase.thank-you.cart-line-item.render-after': RenderExtension<
|
|
206
|
+
CartLineItemApi &
|
|
207
|
+
StandardApi<'purchase.thank-you.cart-line-item.render-after'>,
|
|
208
|
+
AnyComponent
|
|
209
|
+
>;
|
|
210
|
+
/**
|
|
211
|
+
* A static extension target that renders on every line item, inside the details
|
|
212
|
+
* under the line item properties element on the Thank You Page.
|
|
213
|
+
*
|
|
214
|
+
* @deprecated Use `purchase.thank-you.cart-line-item.render-after` instead.
|
|
215
|
+
*/
|
|
216
|
+
'Checkout::ThankYou::CartLineDetails::RenderAfter': RenderExtension<
|
|
217
|
+
CartLineItemApi &
|
|
218
|
+
StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,
|
|
219
|
+
AnyComponent
|
|
220
|
+
>;
|
|
221
|
+
/**
|
|
222
|
+
* A static extension target that is rendered after all line items on the Thank You page.
|
|
223
|
+
*/
|
|
224
|
+
'purchase.thank-you.cart-line-list.render-after': RenderExtension<
|
|
225
|
+
StandardApi<'purchase.thank-you.cart-line-list.render-after'>,
|
|
226
|
+
AnyComponent
|
|
227
|
+
>;
|
|
228
|
+
/**
|
|
229
|
+
* A static extension target that is rendered after all line items on the Thank You page.
|
|
230
|
+
*
|
|
231
|
+
* @deprecated Use `purchase.thank-you.cart-line-list.render-after` instead.
|
|
232
|
+
*/
|
|
233
|
+
'Checkout::ThankYou::CartLines::RenderAfter': RenderExtension<
|
|
234
|
+
StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,
|
|
235
|
+
AnyComponent
|
|
236
|
+
>;
|
|
237
|
+
/**
|
|
238
|
+
* A static extension target that is rendered after a purchase below the customer information on the Thank You page.
|
|
239
|
+
*/
|
|
240
|
+
'purchase.thank-you.customer-information.render-after': RenderExtension<
|
|
241
|
+
StandardApi<'purchase.thank-you.customer-information.render-after'>,
|
|
242
|
+
AnyComponent
|
|
243
|
+
>;
|
|
244
|
+
/**
|
|
245
|
+
* A static extension target that is rendered after a purchase below the customer information on the Thank You page.
|
|
246
|
+
*
|
|
247
|
+
* @deprecated Use `purchase.thank-you.customer-information.render-after` instead.
|
|
248
|
+
*/
|
|
249
|
+
'Checkout::ThankYou::CustomerInformation::RenderAfter': RenderExtension<
|
|
250
|
+
StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,
|
|
251
|
+
AnyComponent
|
|
252
|
+
>;
|
|
253
|
+
/**
|
|
254
|
+
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that renders exclusively on the Order Status Page.
|
|
255
|
+
* Unlike static extension targets, dynamic extension targets render where the merchant
|
|
256
|
+
* sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
|
|
257
|
+
*
|
|
258
|
+
* The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for dynamic extension targets can be previewed during development
|
|
259
|
+
* by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#dynamic-extension-targets).
|
|
260
|
+
*/
|
|
261
|
+
'customer-account.order-status.block.render': RenderExtension<
|
|
262
|
+
OrderStatusApi &
|
|
263
|
+
CustomerAccountStandardApi<'customer-account.order-status.block.render'>,
|
|
264
|
+
AnyComponent
|
|
265
|
+
>;
|
|
266
|
+
/**
|
|
267
|
+
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that renders exclusively on the Order Status Page.
|
|
268
|
+
* Unlike static extension targets, dynamic extension targets render where the merchant
|
|
269
|
+
* sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
|
|
270
|
+
*
|
|
271
|
+
* The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for dynamic extension targets can be previewed during development
|
|
272
|
+
* by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#dynamic-extension-targets).
|
|
273
|
+
*
|
|
274
|
+
* @deprecated Use `customer-account.order-status.block.render` instead.
|
|
275
|
+
*/
|
|
276
|
+
'Checkout::OrderStatus::Dynamic::Render': RenderExtension<
|
|
277
|
+
OrderStatusApi &
|
|
278
|
+
CustomerAccountStandardApi<'Checkout::OrderStatus::Dynamic::Render'>,
|
|
279
|
+
AnyComponent
|
|
280
|
+
>;
|
|
281
|
+
/**
|
|
282
|
+
* A static extension target that renders on every line item, inside the details
|
|
283
|
+
* under the line item properties element on the Order Status Page.
|
|
284
|
+
*/
|
|
285
|
+
'customer-account.order-status.cart-line-item.render-after': RenderExtension<
|
|
286
|
+
CartLineItemApi &
|
|
287
|
+
OrderStatusApi &
|
|
288
|
+
CustomerAccountStandardApi<'customer-account.order-status.cart-line-item.render-after'>,
|
|
289
|
+
AnyComponent
|
|
290
|
+
>;
|
|
291
|
+
/**
|
|
292
|
+
* A static extension target that renders on every line item, inside the details
|
|
293
|
+
* under the line item properties element on the Order Status Page.
|
|
294
|
+
*
|
|
295
|
+
* @deprecated Use `customer-account.order-status.cart-line-item.render-after` instead.
|
|
296
|
+
*/
|
|
297
|
+
'Checkout::OrderStatus::CartLineDetails::RenderAfter': RenderExtension<
|
|
298
|
+
CartLineItemApi &
|
|
299
|
+
OrderStatusApi &
|
|
300
|
+
CustomerAccountStandardApi<'Checkout::OrderStatus::CartLineDetails::RenderAfter'>,
|
|
301
|
+
AnyComponent
|
|
302
|
+
>;
|
|
303
|
+
/**
|
|
304
|
+
* A static extension target that is rendered after all line items on the Order Status page.
|
|
305
|
+
*/
|
|
306
|
+
'customer-account.order-status.cart-line-list.render-after': RenderExtension<
|
|
307
|
+
OrderStatusApi &
|
|
308
|
+
CustomerAccountStandardApi<'customer-account.order-status.cart-line-list.render-after'>,
|
|
309
|
+
AnyComponent
|
|
310
|
+
>;
|
|
311
|
+
/**
|
|
312
|
+
* A static extension target that is rendered after all line items on the Order Status page.
|
|
313
|
+
*
|
|
314
|
+
* @deprecated Use `customer-account.order-status.cart-line-list.render-after` instead.
|
|
315
|
+
*/
|
|
316
|
+
'Checkout::OrderStatus::CartLines::RenderAfter': RenderExtension<
|
|
317
|
+
OrderStatusApi &
|
|
318
|
+
CustomerAccountStandardApi<'Checkout::OrderStatus::CartLines::RenderAfter'>,
|
|
319
|
+
AnyComponent
|
|
320
|
+
>;
|
|
321
|
+
/**
|
|
322
|
+
* A static extension target that is rendered after a purchase below the customer information on the Order Status page.
|
|
323
|
+
*/
|
|
324
|
+
'customer-account.order-status.customer-information.render-after': RenderExtension<
|
|
325
|
+
OrderStatusApi &
|
|
326
|
+
CustomerAccountStandardApi<'customer-account.order-status.customer-information.render-after'>,
|
|
327
|
+
AnyComponent
|
|
328
|
+
>;
|
|
329
|
+
/**
|
|
330
|
+
* A static extension target that is rendered after a purchase below the customer information on the Order Status page.
|
|
331
|
+
*
|
|
332
|
+
* @deprecated Use `customer-account.order-status.customer-information.render-after` instead.
|
|
333
|
+
*/
|
|
334
|
+
'Checkout::OrderStatus::CustomerInformation::RenderAfter': RenderExtension<
|
|
335
|
+
OrderStatusApi &
|
|
336
|
+
CustomerAccountStandardApi<'Checkout::OrderStatus::CustomerInformation::RenderAfter'>,
|
|
337
|
+
AnyComponent
|
|
338
|
+
>;
|
|
339
|
+
/**
|
|
340
|
+
* A static extension target that renders the gift card entry form fields after
|
|
341
|
+
* the buyer ticks a box to use a gift card. This does not replace the
|
|
342
|
+
* native gift card entry form which is rendered in a separate part of checkout.
|
|
343
|
+
*
|
|
344
|
+
* @private
|
|
345
|
+
*/
|
|
346
|
+
'purchase.checkout.gift-card.render': RenderExtension<
|
|
347
|
+
RedeemableApi &
|
|
348
|
+
CheckoutApi &
|
|
349
|
+
StandardApi<'purchase.checkout.gift-card.render'>,
|
|
350
|
+
AnyComponent
|
|
351
|
+
>;
|
|
352
|
+
/**
|
|
353
|
+
* A static extension target that renders the gift card entry form fields after
|
|
354
|
+
* the buyer ticks a box to use a gift card. This does not replace the
|
|
355
|
+
* native gift card entry form which is rendered in a separate part of checkout.
|
|
356
|
+
*
|
|
357
|
+
* @private
|
|
358
|
+
* @deprecated Use `purchase.checkout.gift-card.render` instead.
|
|
359
|
+
*/
|
|
360
|
+
'Checkout::GiftCard::Render': RenderExtension<
|
|
361
|
+
RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,
|
|
362
|
+
AnyComponent
|
|
363
|
+
>;
|
|
364
|
+
/**
|
|
365
|
+
* A static extension target that renders the form fields for a payment method when selected by the buyer.
|
|
366
|
+
*
|
|
367
|
+
* @private
|
|
368
|
+
*/
|
|
369
|
+
'purchase.checkout.payment-option-item.details.render': RenderExtension<
|
|
370
|
+
PaymentOptionItemApi &
|
|
371
|
+
CheckoutApi &
|
|
372
|
+
StandardApi<'purchase.checkout.payment-option-item.details.render'>,
|
|
373
|
+
AnyComponent
|
|
374
|
+
>;
|
|
375
|
+
/**
|
|
376
|
+
* A static extension target that renders the form fields for a payment method when selected by the buyer.
|
|
377
|
+
*
|
|
378
|
+
* @private
|
|
379
|
+
* @deprecated Use `purchase.checkout.payment-option-item.details.render` instead.
|
|
380
|
+
*/
|
|
381
|
+
'Checkout::PaymentMethod::Render': RenderExtension<
|
|
382
|
+
PaymentOptionItemApi &
|
|
383
|
+
CheckoutApi &
|
|
384
|
+
StandardApi<'Checkout::PaymentMethod::Render'>,
|
|
385
|
+
AnyComponent
|
|
386
|
+
>;
|
|
387
|
+
/**
|
|
388
|
+
* A static extension target that renders a form modal when a buyer selects the custom onsite payment method.
|
|
389
|
+
*
|
|
390
|
+
* @private
|
|
391
|
+
*/
|
|
392
|
+
'purchase.checkout.payment-option-item.action-required.render': RenderExtension<
|
|
393
|
+
CheckoutApi &
|
|
394
|
+
StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,
|
|
395
|
+
AnyComponent
|
|
396
|
+
>;
|
|
397
|
+
/**
|
|
398
|
+
* A static extension target that renders a form modal when a buyer selects the custom onsite payment method.
|
|
399
|
+
*
|
|
400
|
+
* @private
|
|
401
|
+
* @deprecated Use `purchase.checkout.payment-option-item.action-required.render` instead.
|
|
402
|
+
*/
|
|
403
|
+
'Checkout::PaymentMethod::RenderRequiredAction': RenderExtension<
|
|
404
|
+
CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,
|
|
405
|
+
AnyComponent
|
|
406
|
+
>;
|
|
407
|
+
/**
|
|
408
|
+
* A static extension target that is rendered in the order summary, before the discount form element.
|
|
409
|
+
*/
|
|
410
|
+
'purchase.checkout.reductions.render-before': RenderExtension<
|
|
411
|
+
CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,
|
|
412
|
+
AnyComponent
|
|
413
|
+
>;
|
|
414
|
+
/**
|
|
415
|
+
* A static extension target that is rendered in the order summary, before the discount form element.
|
|
416
|
+
*
|
|
417
|
+
* @deprecated Use `purchase.checkout.reductions.render-before` instead.
|
|
418
|
+
*/
|
|
419
|
+
'Checkout::Reductions::RenderBefore': RenderExtension<
|
|
420
|
+
CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,
|
|
421
|
+
AnyComponent
|
|
422
|
+
>;
|
|
423
|
+
/**
|
|
424
|
+
* A static extension target that is rendered in the order summary, after the discount form
|
|
425
|
+
* and discount tag elements.
|
|
426
|
+
*/
|
|
427
|
+
'purchase.checkout.reductions.render-after': RenderExtension<
|
|
428
|
+
CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,
|
|
429
|
+
AnyComponent
|
|
430
|
+
>;
|
|
431
|
+
/**
|
|
432
|
+
* A static extension target that is rendered in the order summary, after the discount form
|
|
433
|
+
* and discount tag elements.
|
|
434
|
+
*
|
|
435
|
+
* @deprecated Use `purchase.checkout.reductions.render-after` instead.
|
|
436
|
+
*/
|
|
437
|
+
'Checkout::Reductions::RenderAfter': RenderExtension<
|
|
438
|
+
CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,
|
|
439
|
+
AnyComponent
|
|
440
|
+
>;
|
|
441
|
+
/**
|
|
442
|
+
* A static extension target that is rendered between the shipping method
|
|
443
|
+
* header and shipping method options.
|
|
444
|
+
*/
|
|
445
|
+
'purchase.checkout.shipping-option-list.render-before': RenderExtension<
|
|
446
|
+
CheckoutApi &
|
|
447
|
+
StandardApi<'purchase.checkout.shipping-option-list.render-before'>,
|
|
448
|
+
AnyComponent
|
|
449
|
+
>;
|
|
450
|
+
/**
|
|
451
|
+
* A static extension target that is rendered between the shipping method
|
|
452
|
+
* header and shipping method options.
|
|
453
|
+
*
|
|
454
|
+
* @deprecated Use `purchase.checkout.shipping-option-list.render-before` instead.
|
|
455
|
+
*/
|
|
456
|
+
'Checkout::ShippingMethods::RenderBefore': RenderExtension<
|
|
457
|
+
CheckoutApi & StandardApi<'Checkout::ShippingMethods::RenderBefore'>,
|
|
458
|
+
AnyComponent
|
|
459
|
+
>;
|
|
460
|
+
/**
|
|
461
|
+
* A static extension target that is rendered after the shipping method
|
|
462
|
+
* options.
|
|
463
|
+
*/
|
|
464
|
+
'purchase.checkout.shipping-option-list.render-after': RenderExtension<
|
|
465
|
+
CheckoutApi &
|
|
466
|
+
StandardApi<'purchase.checkout.shipping-option-list.render-after'>,
|
|
467
|
+
AnyComponent
|
|
468
|
+
>;
|
|
469
|
+
/**
|
|
470
|
+
* A static extension target that is rendered after the shipping method
|
|
471
|
+
* options.
|
|
472
|
+
*
|
|
473
|
+
* @deprecated Use `purchase.checkout.shipping-option-list.render-after` instead.
|
|
474
|
+
*/
|
|
475
|
+
'Checkout::ShippingMethods::RenderAfter': RenderExtension<
|
|
476
|
+
CheckoutApi & StandardApi<'Checkout::ShippingMethods::RenderAfter'>,
|
|
477
|
+
AnyComponent
|
|
478
|
+
>;
|
|
479
|
+
/**
|
|
480
|
+
* A static extension target that is rendered before pickup location options.
|
|
481
|
+
*/
|
|
482
|
+
'purchase.checkout.pickup-location-list.render-before': RenderExtension<
|
|
483
|
+
PickupLocationListApi &
|
|
484
|
+
CheckoutApi &
|
|
485
|
+
StandardApi<'purchase.checkout.pickup-location-list.render-before'>,
|
|
486
|
+
AnyComponent
|
|
487
|
+
>;
|
|
488
|
+
/**
|
|
489
|
+
* A static extension target that is rendered before pickup location options.
|
|
490
|
+
*
|
|
491
|
+
* @deprecated Use `purchase.checkout.pickup-location-list.render-before` instead.
|
|
492
|
+
*/
|
|
493
|
+
'Checkout::PickupLocations::RenderBefore': RenderExtension<
|
|
494
|
+
PickupLocationListApi &
|
|
495
|
+
CheckoutApi &
|
|
496
|
+
StandardApi<'Checkout::PickupLocations::RenderBefore'>,
|
|
497
|
+
AnyComponent
|
|
498
|
+
>;
|
|
499
|
+
/**
|
|
500
|
+
* A static extension target that is rendered after pickup location options.
|
|
501
|
+
*/
|
|
502
|
+
'purchase.checkout.pickup-location-list.render-after': RenderExtension<
|
|
503
|
+
PickupLocationListApi &
|
|
504
|
+
CheckoutApi &
|
|
505
|
+
StandardApi<'purchase.checkout.pickup-location-list.render-after'>,
|
|
506
|
+
AnyComponent
|
|
507
|
+
>;
|
|
508
|
+
/**
|
|
509
|
+
* A static extension target that is rendered after pickup location options.
|
|
510
|
+
*
|
|
511
|
+
* @deprecated Use `purchase.checkout.pickup-location-list.render-after` instead.
|
|
512
|
+
*/
|
|
513
|
+
'Checkout::PickupLocations::RenderAfter': RenderExtension<
|
|
514
|
+
PickupLocationListApi &
|
|
515
|
+
CheckoutApi &
|
|
516
|
+
StandardApi<'Checkout::PickupLocations::RenderAfter'>,
|
|
517
|
+
AnyComponent
|
|
518
|
+
>;
|
|
519
|
+
/**
|
|
520
|
+
* A static extension target that is rendered after the shipping method
|
|
521
|
+
* details within the shipping method option list, for each option.
|
|
522
|
+
*/
|
|
523
|
+
'purchase.checkout.shipping-option-item.render-after': RenderExtension<
|
|
524
|
+
ShippingOptionItemApi &
|
|
525
|
+
CheckoutApi &
|
|
526
|
+
StandardApi<'purchase.checkout.shipping-option-item.render-after'>,
|
|
527
|
+
AnyComponent
|
|
528
|
+
>;
|
|
529
|
+
/**
|
|
530
|
+
* A static extension target that is rendered after the shipping method
|
|
531
|
+
* details within the shipping method option list, for each option.
|
|
532
|
+
*
|
|
533
|
+
* @deprecated Use `purchase.checkout.shipping-option-item.render-after` instead.
|
|
534
|
+
*/
|
|
535
|
+
'Checkout::ShippingMethodDetails::RenderAfter': RenderExtension<
|
|
536
|
+
ShippingOptionItemApi &
|
|
537
|
+
CheckoutApi &
|
|
538
|
+
StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,
|
|
539
|
+
AnyComponent
|
|
540
|
+
>;
|
|
541
|
+
/**
|
|
542
|
+
* A static extension target that is rendered under the shipping method
|
|
543
|
+
* within the shipping method option list, for each option.
|
|
544
|
+
*/
|
|
545
|
+
'purchase.checkout.shipping-option-item.details.render': RenderExtension<
|
|
546
|
+
ShippingOptionItemApi &
|
|
547
|
+
CheckoutApi &
|
|
548
|
+
StandardApi<'purchase.checkout.shipping-option-item.details.render'>,
|
|
549
|
+
AnyComponent
|
|
550
|
+
>;
|
|
551
|
+
/**
|
|
552
|
+
* A static extension target that is rendered under the shipping method
|
|
553
|
+
* within the shipping method option list, for each option.
|
|
554
|
+
*
|
|
555
|
+
* @deprecated Use `purchase.checkout.shipping-option-item.details.render` instead.
|
|
556
|
+
*/
|
|
557
|
+
'Checkout::ShippingMethodDetails::RenderExpanded': RenderExtension<
|
|
558
|
+
ShippingOptionItemApi &
|
|
559
|
+
CheckoutApi &
|
|
560
|
+
StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,
|
|
561
|
+
AnyComponent
|
|
562
|
+
>;
|
|
563
|
+
/**
|
|
564
|
+
* A static extension target that is rendered immediately before the pickup points.
|
|
565
|
+
*/
|
|
566
|
+
'purchase.checkout.pickup-point-list.render-before': RenderExtension<
|
|
567
|
+
PickupPointListApi &
|
|
568
|
+
CheckoutApi &
|
|
569
|
+
StandardApi<'purchase.checkout.pickup-point-list.render-before'>,
|
|
570
|
+
AnyComponent
|
|
571
|
+
>;
|
|
572
|
+
/**
|
|
573
|
+
* A static extension target that is rendered immediately before the pickup points.
|
|
574
|
+
*
|
|
575
|
+
* @deprecated Use `purchase.checkout.pickup-point-list.render-before` instead.
|
|
576
|
+
*/
|
|
577
|
+
'Checkout::PickupPoints::RenderBefore': RenderExtension<
|
|
578
|
+
PickupPointListApi &
|
|
579
|
+
CheckoutApi &
|
|
580
|
+
StandardApi<'Checkout::PickupPoints::RenderBefore'>,
|
|
581
|
+
AnyComponent
|
|
582
|
+
>;
|
|
583
|
+
/**
|
|
584
|
+
* A static extension target that is rendered immediately after the pickup points.
|
|
585
|
+
*/
|
|
586
|
+
'purchase.checkout.pickup-point-list.render-after': RenderExtension<
|
|
587
|
+
PickupPointListApi &
|
|
588
|
+
CheckoutApi &
|
|
589
|
+
StandardApi<'purchase.checkout.pickup-point-list.render-after'>,
|
|
590
|
+
AnyComponent
|
|
591
|
+
>;
|
|
592
|
+
/**
|
|
593
|
+
* A static extension target that is rendered immediately after the pickup points.
|
|
594
|
+
*
|
|
595
|
+
* @deprecated Use `purchase.checkout.pickup-point-list.render-after` instead.
|
|
596
|
+
*/
|
|
597
|
+
'Checkout::PickupPoints::RenderAfter': RenderExtension<
|
|
598
|
+
PickupPointListApi &
|
|
599
|
+
CheckoutApi &
|
|
600
|
+
StandardApi<'Checkout::PickupPoints::RenderAfter'>,
|
|
601
|
+
AnyComponent
|
|
602
|
+
>;
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
export type ExtensionTarget = keyof ExtensionTargets;
|
|
606
|
+
|
|
607
|
+
/**
|
|
608
|
+
* For a given extension target, returns the value that is expected to be
|
|
609
|
+
* returned by that extension target’s callback type.
|
|
610
|
+
*/
|
|
611
|
+
export type ReturnTypeForExtension<Target extends keyof ExtensionTargets> =
|
|
612
|
+
ReturnType<ExtensionTargets[Target]>;
|
|
613
|
+
|
|
614
|
+
/**
|
|
615
|
+
* For a given extension target, returns the tuple of arguments that would
|
|
616
|
+
* be provided to that extension target’s callback type.
|
|
617
|
+
*/
|
|
618
|
+
export type ArgumentsForExtension<Target extends keyof ExtensionTargets> =
|
|
619
|
+
Parameters<ExtensionTargets[Target]>;
|
|
620
|
+
|
|
621
|
+
/**
|
|
622
|
+
* A union type containing all of the extension targets that follow the pattern of
|
|
623
|
+
* accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-ui/tree/main/packages/core)
|
|
624
|
+
* and an additional `api` argument, and using those arguments to render
|
|
625
|
+
* UI.
|
|
626
|
+
*/
|
|
627
|
+
export type RenderExtensionTarget = {
|
|
628
|
+
[Target in keyof ExtensionTargets]: ExtensionTargets[Target] extends RenderExtension<
|
|
629
|
+
any,
|
|
630
|
+
any
|
|
631
|
+
>
|
|
632
|
+
? Target
|
|
633
|
+
: never;
|
|
634
|
+
}[keyof ExtensionTargets];
|
|
635
|
+
|
|
636
|
+
/**
|
|
637
|
+
* A mapping of each “render extension” name to its callback type.
|
|
638
|
+
*/
|
|
639
|
+
export type RenderExtensions = {
|
|
640
|
+
[Target in RenderExtensionTarget]: ExtensionTargets[Target];
|
|
641
|
+
};
|
|
642
|
+
|
|
643
|
+
type ExtractedApiFromRenderExtension<T> = T extends RenderExtension<
|
|
644
|
+
infer Api,
|
|
645
|
+
any
|
|
646
|
+
>
|
|
647
|
+
? Api
|
|
648
|
+
: never;
|
|
649
|
+
|
|
650
|
+
type ExtractedAllowedComponentsFromRenderExtension<T> =
|
|
651
|
+
T extends RenderExtension<any, infer Components> ? Components : never;
|
|
652
|
+
|
|
653
|
+
/**
|
|
654
|
+
* For a given rendering extension target, returns the type of the API that the
|
|
655
|
+
* extension will receive at runtime. This API type is the second argument to
|
|
656
|
+
* the callback for that extension target. The first callback for all of the rendering
|
|
657
|
+
* extension targets each receive a `RemoteRoot` object.
|
|
658
|
+
*/
|
|
659
|
+
export type ApiForRenderExtension<Target extends keyof RenderExtensions> =
|
|
660
|
+
ExtractedApiFromRenderExtension<RenderExtensions[Target]>;
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* For a given rendering extension target, returns the UI components that the
|
|
664
|
+
* extension target supports.
|
|
665
|
+
*/
|
|
666
|
+
export type AllowedComponentsForRenderExtension<
|
|
667
|
+
Target extends keyof RenderExtensions,
|
|
668
|
+
> = ExtractedAllowedComponentsFromRenderExtension<RenderExtensions[Target]>;
|
|
669
|
+
|
|
670
|
+
/**
|
|
671
|
+
* The part of the standard API implemented for customer-account targets. Must
|
|
672
|
+
* match the types defined in the `surfaces/customer-account` section of this package.
|
|
673
|
+
*/
|
|
674
|
+
export type CustomerAccountStandardApi<Target extends keyof ExtensionTargets> =
|
|
675
|
+
Pick<
|
|
676
|
+
StandardApi<Target>,
|
|
677
|
+
| 'analytics'
|
|
678
|
+
| 'appliedGiftCards'
|
|
679
|
+
| 'appMetafields'
|
|
680
|
+
| 'attributes'
|
|
681
|
+
| 'buyerIdentity'
|
|
682
|
+
| 'checkoutSettings'
|
|
683
|
+
| 'cost'
|
|
684
|
+
| 'discountCodes'
|
|
685
|
+
| 'discountAllocations'
|
|
686
|
+
| 'extension'
|
|
687
|
+
| 'extensionPoint'
|
|
688
|
+
| 'i18n'
|
|
689
|
+
| 'lines'
|
|
690
|
+
| 'localization'
|
|
691
|
+
| 'metafields'
|
|
692
|
+
| 'note'
|
|
693
|
+
| 'query'
|
|
694
|
+
| 'sessionToken'
|
|
695
|
+
| 'settings'
|
|
696
|
+
| 'shippingAddress'
|
|
697
|
+
| 'shop'
|
|
698
|
+
| 'storage'
|
|
699
|
+
| 'ui'
|
|
700
|
+
| 'version'
|
|
701
|
+
>;
|