diff --git a/14/umbraco-commerce/SUMMARY.md b/14/umbraco-commerce/SUMMARY.md index c61f16c457e..ab50399d603 100644 --- a/14/umbraco-commerce/SUMMARY.md +++ b/14/umbraco-commerce/SUMMARY.md @@ -2,6 +2,7 @@ * [Umbraco Commerce 14 (Alpha) Documentation](README.md) * [Release Notes](release-notes/README.md) + * [v14.0.0](release-notes/v14.0.0.md) * [v14.0.0-Alpha](release-notes/v14.0.0-alpha.md) ## Commerce Products diff --git a/14/umbraco-commerce/release-notes/README.md b/14/umbraco-commerce/release-notes/README.md index f01e0a6e3fa..bd3423fdac2 100644 --- a/14/umbraco-commerce/release-notes/README.md +++ b/14/umbraco-commerce/release-notes/README.md @@ -17,6 +17,13 @@ If you are upgrading to a new major version, check the breaking changes in the [ This section contains the release notes for Umbraco Commerce 14 including all changes for this version. +#### 14.0.0 (23rd August 2024) + +Read the [v14.0.0 release post](./v14.0.0.md) for more information about this release. + +* Added "No results" messages to collection views +* Upgraded Umbraco CMS dependency to v14.2.0 + #### 14.0.0-rc3 (12th August 2024) * Added warning on store dashboard/analytics section if the store has multiple currencies when no currency exchange rate service is configured. diff --git a/14/umbraco-commerce/release-notes/v14.0.0.md b/14/umbraco-commerce/release-notes/v14.0.0.md new file mode 100644 index 00000000000..786314c3ef4 --- /dev/null +++ b/14/umbraco-commerce/release-notes/v14.0.0.md @@ -0,0 +1,125 @@ +--- +description: >- + Umbraco Commerce v14.0.0 release notes. +--- + +# Umbraco Commerce v14.0.0 + +This release marks the v14 build of Umbraco Commerce, now feature complete and ready for developers to start using it. + +## Key Takeaways + +* [New backoffice UI](#new-backoffice-ui) build with web-components. +* Some [breaking changes](#breaking-changes) to be expected. +* New more flexible [UI extension points](#ui-extension-points) added. +* New [Management API](#management-api) added. +* [Localization](#localization) support added (in progress). + +## New Backoffice UI + +As with everything v14, this is a complete rebuild of the backoffice UI using web components. This ensures Umbraco Commerce is set for the future and creates a solid foundation to develop new features and functionality. + +![Umbraco Commerce v14 Order Editor](../media/v14/order-editor.png) + +![Umbraco Commerce v14 Settings Section](../media/v14/store-settings.png) + +## Breaking Changes + +With the new backoffice UI, there has inevitably been the need to change some functionalities, and as such breaking changes could not be avoided. These have tried to be minimized as much as possible, whilst also ensuring we embrace the new front-end architecture to its fullest. + +The key breaking changes to expect are: + +* **UI Config Files Removed** + +Previously, in Umbraco Commerce, it was possible to configure the backoffice order list view, order editor, and analytics dashboards using JSON UI config files. These have now all been updated to use the new manifests pattern in Umbraco v14. For more details, see the [UI Extension Points](#ui-extension-points) section below. + +In addition to this, the UI config files were also used in the backoffice to extract key order properties. For example, extracting the shipping address to calculate shipping rates. This functionality has now been split, and the mapping functionality has been moved to a new server-based configuration API. + + ``` + builder.WithOrderPropertyConfigs() + .Add("myStoreAlias", b => b + .For(x => x.Customer.FirstName).MapFrom("firstName") + .For(x => x.Customer.LastName).MapFrom("lastName") + ... + ); + ``` + +* **Web Notification Events Removed** + + The following notifications are no longer being fired: + + * `AnalyticsDashboardConfigParsingNotification` + * `CartEditorConfigParsingNotification` + * `OrderEditorConfigParsingNotification` + * `StoreActionsRenderingNotification` + * `ActivityLogEntriesRenderingNotification` + +* **Web Controllers/Models Removed** + + With the new Management API, any controllers or models previously located in `Umbraco.Commerce.Cms.Web` have been removed. Please use the **Management API** instead. + +The only exception to this rule is the `PaymentController`, which serves as a callback for payment gateways. It is currently located at the same URL to avoid disrupting existing transaction communications. However, all new integrations should communicate with a new Payments API. + +## UI Extension Points + +With the new backoffice comes a new extensions system for the UI, and we have tried to maximize its use. This means converting the old UI configs system to use the new manifests system. + +With the new extension points it is possible to: + +* Change the properties used by the order editor. +* Add properties to the order line properties editor. +* Add properties to the Notes, Additional Info, and Customer Details modals. +* Add properties to the order collection view. +* Add analytics widgets (still in progress) +* Define custom views for properties to control value rendering. + +Here is an example of how you would configure these properties: + +```javascript +export const manifests : Array = [ + { + type: 'ucOrderLineProperty', + alias: 'Uc.OrderLineProperty.Color', + name: 'Order Line Color', + weight: 100, + meta: { + propertyAlias: 'color', + editorUiAlias: 'Umb.PropertyEditorUi.EyeDropper', + labelElementName: 'uc-mini-color-swatch' + } + }, + { + type: 'ucOrderLineProperty', + alias: 'Uc.OrderLineProperty.GiftMessage', + name: 'Order Line Gift Message', + weight: 100, + meta: { + propertyAlias: 'giftMessage', + editorUiAlias: 'Umb.PropertyEditorUi.TextArea', + summaryStyle: 'table' + } + } +]; +``` + +With these extension points, the Umbraco Commerce order editor is now more flexible than it has ever been before. + +{% hint style="info" %} +We are yet to launch an Umbraco Commerce NPM module, so these functionalities are not currently available for external use. However, we wanted to give you a heads-up about what is coming so you can prepare. +{% endhint %} + +## Management API + +With the new UI, a new API layer is also introduced, similar to the CMS. + +![Umbraco Commerce Management API](../media/v14/management-api.png) + +With the Umbraco Commerce API, we have aimed to keep it aligned with the Storefront API with support for filtering and expansion where possible. + +We developed this API for external developers who can use it to create different UIs for Umbraco Commerce, such as a dedicated mobile app. We have made sure that there are no "special" endpoints exclusively for the Umbraco CMS UI. + +## Localization + +Given the fresh start, we made sure that everything we built fully supports localization, so this will be included in this release. + +In this update, we have made some changes to payment and shipping providers, as well as other CSharp extension points where properties are defined. These changes mean that labels and descriptions will no longer be hard-coded; instead, the values will be looked up from the localization file. diff --git a/commerce-add-ons/packages/checkout/release-notes.md b/commerce-add-ons/packages/checkout/release-notes.md index da3970a731b..6e7c54ea1e2 100644 --- a/commerce-add-ons/packages/checkout/release-notes.md +++ b/commerce-add-ons/packages/checkout/release-notes.md @@ -14,6 +14,16 @@ In this section, you can find the release notes for each version of Checkout pac
+Version 14 + +#### 14.0.0 (August 23rd 2024) + +* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support. + +
+ +
+ Version 13 **13.1.0 (February 21st 2024)** diff --git a/commerce-add-ons/packages/deploy/release-notes.md b/commerce-add-ons/packages/deploy/release-notes.md index 78e345f8c74..1bc2bbce6b0 100644 --- a/commerce-add-ons/packages/deploy/release-notes.md +++ b/commerce-add-ons/packages/deploy/release-notes.md @@ -26,9 +26,13 @@ In this section, you can find the release notes for each version of Deploy packa Version 14 +#### 14.0.0 (August 23rd 2024) + +* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support. + #### 14.0.0-rc1 (August 5th 2024) -* Initial conversion for Umbraco v14 and Umbraco Commerce v14 support. +* Initial conversion for Umbraco v14.0.0 and Umbraco Commerce v14.0.0 support.
diff --git a/commerce-add-ons/shipping-providers/dhl/release-notes.md b/commerce-add-ons/shipping-providers/dhl/release-notes.md index d89adc0851f..d876ff5ba08 100644 --- a/commerce-add-ons/shipping-providers/dhl/release-notes.md +++ b/commerce-add-ons/shipping-providers/dhl/release-notes.md @@ -10,6 +10,16 @@ In this section, you can find the release notes for each version of DHL Shipping
+Version 14 + +#### 14.0.0 (August 23rd 2024) + +* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support. + +
+ +
+ Version 13 #### 13.0.0 (February 21st 2024) diff --git a/commerce-add-ons/shipping-providers/easypost/release-notes.md b/commerce-add-ons/shipping-providers/easypost/release-notes.md index 9a641ae786f..c9a5e572200 100644 --- a/commerce-add-ons/shipping-providers/easypost/release-notes.md +++ b/commerce-add-ons/shipping-providers/easypost/release-notes.md @@ -10,6 +10,16 @@ In this section, you can find the release notes for each version of EasyPost Shi
+Version 14 + +#### 14.0.0 (August 23rd 2024) + +* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support. + +
+ +
+ Version 13 #### 13.0.0 (February 21st 2024) diff --git a/commerce-add-ons/shipping-providers/shipmondo/release-notes.md b/commerce-add-ons/shipping-providers/shipmondo/release-notes.md index e9cc65d65de..5ca03123453 100644 --- a/commerce-add-ons/shipping-providers/shipmondo/release-notes.md +++ b/commerce-add-ons/shipping-providers/shipmondo/release-notes.md @@ -10,6 +10,16 @@ In this section, you can find the release notes for each version of Shipmondo Sh
+Version 14 + +#### 14.0.0 (August 23rd 2024) + +* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support. + +
+ +
+ Version 13 #### 13.0.0 (February 21st 2024)