CHANGELOG.md

@shopify/ui-extensions

2024.4.0

Minor Changes

• #1693 5d2905b1 Thanks @elskhn! - Adds new purchase.checkout.pickup-location-option-item.render-after extension target, rendered inside each local pickup option item.

• #1781 0772c011 Thanks @jonathanhamel4! - Adds buyerJourney.steps, buyerJourney.activeStep, and their associated react hooks to the checkout surface API.

• #1673 21cb3205 Thanks @brianshen1990! - add requireLogin for CA order status api

• #1832 43390b05 Thanks @rcaplanshopify! - Adds region to Customer Privacy API.

• #1682 02ca0b9a Thanks @thitemple! - Adds the OrderConfirmationApi to purchase.thank-you and customer-account.order-status extension targets.

• #1837 947b4433 Thanks @JoshuaWhite1! - add new targets for action extensions

• #1689 dd256672 Thanks @klenotiw! - Adds the new customerPrivacy and applyTrackingConsentChange APIs.

Patch Changes

• #1695 c6c4a60d Thanks @cpeddecord! - exporting FunctionSettingsError

• #1838 57ab9d90 Thanks @aledalgrande! - Update the ValidationData type to include metafields.

• #1684 48a5f605 Thanks @cpeddecord! - New Section component available to admin UI extensions.

• #1648 8476dfee Thanks @NathanJolly! - Updates to the point-of-sale directories to catch them up to main branch

• #1840 e5b82886 Thanks @aledalgrande! - Redefine types for validations in a way that works for doc generation

• #1663 7d2fdcb5 Thanks @jamesvidler! - Adds 2024-01 as a valid ApiVersion type value.

• #1658 58026776 Thanks @brianshen1990! - Drop runExtension support for customer account ui extension

• #1824 6211f9a5 Thanks @aledalgrande! - Updates the shopifyFunction type to use id rather than uuid for Checkout rules.

• #1685 a1b884ed Thanks @brianshen1990! - expose authenticated account related hooks

• #1654 e096e9a2 Thanks @oliverigor! - Add docs fixes for the conditional style Style type

• #1679 45687187 Thanks @cpeddecord! - Adds a top-level component to admin surface

• #1681 9d21ef30 Thanks @cpeddecord! - adds definitions for validation settings admin extension target

2024.1.0

Major Changes

• #1585 70f9bdc1 Thanks @jamesvidler! - The purchase.checkout.shipping-option-list.render-before and purchase.checkout.shipping-option-list.render-after will be duplicated for possible types of delivery groups (One Time Purchase and Subscription). You can use the new target or useDeliveryGroupTarget() React hook to access the delivery group the extension is attached to.

Minor Changes

• #1515 2452a939 Thanks @rcaplanshopify! - Adds custom header and footer unified extension targets for checkout and thank you pages

• #1472 9c836557 Thanks @sirgalleto! - Add order routing extension targets and API

• #1437 6de2fce0 Thanks @shopi-dori! - Adds the bankIdNumber to the PaymentOptionItemApi. Adds background to View, Grid, GridItem, Pressable, ScrollView, InlineStack, and BlockStack components.

• #1424 9a8dda8c Thanks @MitchLillie! - Add Badge component to admin

• #1428 9cd7d6f9 Thanks @MitchLillie! - Add Banner component to admin

• #1430 0a8b378a Thanks @MitchLillie! - Add ChoiceList to admin

• #1625 29625d18 Thanks @billfienberg! - Add ColorPicker remote component

• #1431 8f82c578 Thanks @MitchLillie! - Add ProgressIndicator to admin

Patch Changes

• #1601 ccbb2353 Thanks @belalsj! - Update Button and Text with interestTarget API

• #1503 f4268b21 Thanks @anahita-m! - Removing legacy customer account extension targets

• #1473 903a62c7 Thanks @mikewilson01! - Add additional props to LWS component

• #1401 0f0e410d Thanks @JoshuaWhite1! - Added details about title/summary truncation to docs

• #1448 be9465df Thanks @robin-drexler! - add previously internal customer account apis to unstable

• #1458 1fb524f6 Thanks @robin-drexler! - fix policy modal handling

• #1434 b45e1b7f Thanks @mikewilson01! - Add onStatusChange callback to LoginWithShop component

• #1466 e53621b6 Thanks @mikewilson01! - Update props for LoginWithShop component

• #1496 bb30cc52 Thanks @brianshen1990! - remove deprecated fields from doc in customer account ui extensions

• #1569 cbc51b33 Thanks @oluwatimio! - Remove customer account location api

• #1598 345ed9a0 Thanks @MitchLillie! - Deprecate summary prop for AdminBlock

2023.10.0

Minor Changes

• #1296 a8e16322 Thanks @MitchLillie! - Bump @remote-ui/core version.

• #1340 a7ea6cb0 Thanks @lsit! - Add PaymentIcon component to the checkout surface

• #1351 8df8429b Thanks @jkeohan! - Add ProductThumbnail component to the checkout surface

• #1397 198d0848 Thanks @jamesvidler! - New ConsentCheckbox and ConsentPhoneField components which allow extensions to render their own consent UI, supporting the "sms-marketing" policy.

• #1364 3437fc05 Thanks @rcaplanshopify! - Adds purchase.checkout.payment-method-list.render-before and purchase.checkout.payment-method-list.render-after extension targets, rendered above and below the payment method list.

• #1281 d539b687 Thanks @elanalynn! - Add download and target props to ButtonAnchorProps in admin

• #1364 39553479 Thanks @rcaplanshopify! - Adds useCartlineTarget API and deprecates useTarget API.

• #1364 1dd9abf0 Thanks @rcaplanshopify! - Storage API stored data is now shared between all activated extension targets of the extension.

• #1364 39553479 Thanks @rcaplanshopify! - Includes masked identifier when submitting custom redeemable data.

• #1364 39553479 Thanks @rcaplanshopify! - Provides payment attributes to checkout extension.

• #1364 39553479 Thanks @rcaplanshopify! - Adds support for decorative color in Text and TextBlock components.

• #1364 7a65c283 Thanks @rcaplanshopify! - Adds the purchase.checkout.delivery-address.render-after static extension target which is rendered after the shipping address form elements.

• #1315 22f71433 Thanks @dnagoda! - # Add checkoutToken Api

  Extensions now have access to the checkout token (a stable id used to identify the checkout) directly through the standard api. The checkout token will match:

  • token field in WebPixel checkout payload.
  • checkout_token in the Admin REST Api Order resource

Patch Changes

• #1361 82ba4be1 Thanks @lauramann! - Adds b2bEnabled enabledFeature on CustomerSegmentTemplateApi

• #1286 d0bd64d2 Thanks @PrescilliaA! - Add exports for InternalCustomerSegmentTemplate categories and icons

• #1274 e198e10a Thanks @PrescilliaA! - Update CustomerSegmentTemplate prop names

• #1316 0905d719 Thanks @lihaokx! - 1. Rename point to target; 2. Update extension target names; 3, Add new types

• #1403 1de5d9cf Thanks @jamesvidler! - Supports improvements for new checkout extensibility docs IA. Organizes docs by targets, and groups APIs.

• #1275 f4d0ea17 Thanks @PrescilliaA! - Expose CustomerSegmentTemplate category and icon types

• #1074 3e60fb40 Thanks @MitchLillie! - Rename components with Admin prefix

• #1343 fa561eed Thanks @MitchLillie! - Update docs for action extension GA

• #1294 1dd7a197 Thanks @PrescilliaA! - Remove CustomerSegmentationTemplate and deprecated prop names

• #1283 8a9917b2 Thanks @lihaokx! - Move customer account ui extension from main to unstable branch.

• #1289 1be8d871 Thanks @lauramann! - Adds extension target for segment details

• #1279 f537b081 Thanks @PrescilliaA! - Introduces InternalCustomerSegmentTemplate component

2023.7.2

Patch Changes

• #1267 dc7f7395 Thanks @robin-drexler! - fix customer-account surface build and context

2023.7.1

Patch Changes

• #1249 fc0186ef Thanks @mleandres! - New useDeliveryGroup() hook and improved documentation.

• #1210 1faf52a5 Thanks @vividviolet! - Expose query API for Admin UI extensions

2023.7.0

Major Changes

• #1145 2d147efa Thanks @lemonmade! - Update API type names to match new extension target names

Minor Changes

• #1064 266c13c0 Thanks @Fionoble! - Added new admin components: Box, BlockStack, Checkbox, Form, InlineStack, TextArea

• #1100 c7dba7ad Thanks @jamesvidler! - Add support for reading and writing cart metafields.

• #1145 2d147efa Thanks @lemonmade! - Add Extension.target field for checkout UI extensions to read the current extension target being rendered.

• #1057 3dff93ac Thanks @Fionoble! - Exposes Action and Block extension targets in the admin surface.

• #1145 2d147efa Thanks @lemonmade! - Add customer-account entrypoints for order status page extensions

• #774 feaab61b Thanks @carolopolo! - Changes typing of description prop of <CustomerSegmentationTemplate/> from string to string | string[]

• #1145 2d147efa Thanks @lemonmade! - Add support for new extension target names

Patch Changes

• #1152 505582a6 Thanks @vividviolet! - Rename all extensionPoint references to extension target

2023.4.3

Patch Changes

• #1216 9052b155 Thanks @jamesvidler! - PickupLocationsApi and PickupPointsApi now return a isLocationFormVisible property as opposed to locationFormVisible. ShippingMethodDetailsApi now gurantees a target (ShippingOption) will be returned.

2023.4.2

Patch Changes

• #1135 b6df631c Thanks @lemonmade! - Backported Extension.target field for checkout UI extensions

• #1135 b6df631c Thanks @lemonmade! - Preserve generic type argument for I18nTranslate function

2023.4.1

Minor Changes

• #1100 c7dba7ad Thanks @jamesvidler! - Add support for reading and writing cart metafields.

Patch Changes

• #1117 8e11ad23 Thanks @olavoasantos! - Clean up on Admin examples and types

• #1100 c7dba7ad Thanks @jamesvidler! - Updated faker dependancies for ui-extensions-react.

• #1100 c7dba7ad Thanks @jamesvidler! - Updated the documented examples to import from the ui-extensions package.

2023.4.0

Minor Changes

• #1064 266c13c0 Thanks @Fionoble! - Added new admin components: Box, BlockStack, Checkbox, Form, InlineStack, TextArea

• #1057 3dff93ac Thanks @Fionoble! - Exposes Action and Block extension targets in the admin surface.

• #774 feaab61b Thanks @carolopolo! - Changes typing of description prop of <CustomerSegmentationTemplate/> from string to string | string[]

Patch Changes

• #1050 df9ff575 Thanks @lauramann! - Add viewMajor to source in CustomerSegmentationTemplate

• #1044 ca55a50c Thanks @olavoasantos! - Add Heading and HeadingGroup components to admin surface

• #1048 faaacfe3 Thanks @olavoasantos! - Add Button component to the Admin surface

• #806 d0e44415 Thanks @jonathanhamel4! - Moving the Segmentation TemplateCategory from the api to the CustomerSegmentationTemplate component props.

• #703 100cfeda Thanks @vividviolet! - Add Admin surface to packages

• #823 0095a792 Thanks @lemonmade! - Example unstable change

• #892 0d68e3d1 Thanks @LTiger14! - Add confettiMajor to source in CustomerSegmentationTemplate

• #1023 d250d7df Thanks @olavoasantos! - Remove legacy components on the admin surface and add components based on the unified API

• #771 2a3b4bd0 Thanks @loic-d! - Introduce dateAdded on CustomerSegmentationTemplate

• #1042 de735136 Thanks @MitchLillie! - Add AppAction component

• #1034 35a34867 Thanks @jamesvidler! - Ported latest changes from @shopify/checkout-ui-extensions package for corresponding version 2023-04.

• #1074 3e60fb40 Thanks @MitchLillie! - Rename components with Admin prefix

• #759 4e71987f Thanks @loic-d! - Introduces CustomerSegmentationTemplate component

• #1073 ad9d0f75 Thanks @jamesvidler! - Added ability to generate docs from within the repository.

• #766 0c5b0d5b Thanks @loic-d! - Introduces standardMetafieldDependencies prop on CustomerSegmentationTemplate

• #722 c4d3ef8e Thanks @vividviolet! - Call root.mount for a rendering extension point

• #822 a49cfe5d Thanks @jonathanhamel4! - Changing the dateAdded type from Date to ISO 8601 string

• #1062 aad2fb79 Thanks @lauramann! - Adds buyButtonMajor to source in CustomerSegmentationTemplate

• #1043 1db18001 Thanks @olavoasantos! - Add Text component to the Admin surface

2022.10.6

Patch Changes

• #717 5c2f511b Thanks @vividviolet! - Fix exports for Checkout's surface

2022.10.5

Patch Changes

• #661 2bef7a10 Thanks @lemonmade! - Bring in @shopify/checkout-ui-extensions@0.22.0