Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
27b21ab
v14 release notes
mattbrailsford Aug 22, 2024
4faa3df
Update 14/umbraco-commerce/release-notes/README.md
eshanrnh Aug 26, 2024
81691ef
Update 14/umbraco-commerce/release-notes/README.md
eshanrnh Aug 26, 2024
209c745
Update commerce-add-ons/packages/deploy/release-notes.md
eshanrnh Aug 26, 2024
f4d7a79
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
b6362f4
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
88131db
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
e13435a
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
b247609
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
fccc082
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
3344b78
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
4763419
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
ff3c8f8
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
d359f38
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
3deee91
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
dcbcd69
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
f97a654
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
d8ebade
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
ce2760c
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
aa1b1d9
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
ae2cf06
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
e57d12d
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
76cd505
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
e28c352
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
1940096
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
e4fa70b
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
a34ce0c
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
c3aca8c
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 26, 2024
a9a0528
Add 14.0.0 release notes to nav
mattbrailsford Aug 27, 2024
79f7435
Update 14/umbraco-commerce/release-notes/v14.0.0.md
eshanrnh Aug 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions 14/umbraco-commerce/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions 14/umbraco-commerce/release-notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
125 changes: 125 additions & 0 deletions 14/umbraco-commerce/release-notes/v14.0.0.md
Original file line number Diff line number Diff line change
@@ -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<UcManifestOrderLineProperty> = [
{
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.
10 changes: 10 additions & 0 deletions commerce-add-ons/packages/checkout/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ In this section, you can find the release notes for each version of Checkout pac

<details>

<summary>Version 14</summary>

#### 14.0.0 (August 23rd 2024)

* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support.

</details>

<details>

<summary>Version 13</summary>

**13.1.0 (February 21st 2024)**
Expand Down
6 changes: 5 additions & 1 deletion commerce-add-ons/packages/deploy/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,13 @@ In this section, you can find the release notes for each version of Deploy packa

<summary>Version 14</summary>

#### 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.

</details>

Expand Down
10 changes: 10 additions & 0 deletions commerce-add-ons/shipping-providers/dhl/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ In this section, you can find the release notes for each version of DHL Shipping

<details>

<summary>Version 14</summary>

#### 14.0.0 (August 23rd 2024)

* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support.

</details>

<details>

<summary>Version 13</summary>

#### 13.0.0 (February 21st 2024)
Expand Down
10 changes: 10 additions & 0 deletions commerce-add-ons/shipping-providers/easypost/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ In this section, you can find the release notes for each version of EasyPost Shi

<details>

<summary>Version 14</summary>

#### 14.0.0 (August 23rd 2024)

* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support.

</details>

<details>

<summary>Version 13</summary>

#### 13.0.0 (February 21st 2024)
Expand Down
10 changes: 10 additions & 0 deletions commerce-add-ons/shipping-providers/shipmondo/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ In this section, you can find the release notes for each version of Shipmondo Sh

<details>

<summary>Version 14</summary>

#### 14.0.0 (August 23rd 2024)

* Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support.

</details>

<details>

<summary>Version 13</summary>

#### 13.0.0 (February 21st 2024)
Expand Down