Skip to content

Commit 1e1d74d

Browse files
committed
✏️ update changelog and migration guide
1 parent 9761897 commit 1e1d74d

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
# [9.0.0] - 2024-12-05
9+
- This version includes a breaking change that updates the following return types:
10+
- `ProductCollectionBuyerProduct` (updated from `BuyerProduct`) is the new type returned from `Me.ListProductCollectionEntries`
11+
- `ProductCollectionProduct` (updated from `Product`) is the new type returned from `ProductCollections.ListEntries`
12+
813
# [8.0.2] - 2024-12-03
914
- Bug fix for "process is undefined" accessor error when not using NextJS
1015

MIGRATION_GUIDE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
The objective of this guide is to document the breaking changes and updates required to migrate from one major version to the next.
44

5+
## version 8.x.x to version 9.x.x
6+
* The return type for the `Me.ListProductCollectionEntries` method has been updated from `BuyerProduct` to `ProductCollectionBuyerProduct`
7+
8+
Before:
9+
```typescript
10+
ListProductCollectionEntries<TBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TBuyerProduct>>>
11+
```
12+
13+
After:
14+
```typescript
15+
ListProductCollectionEntries<TProductCollectionBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProductCollectionBuyerProduct>>>
16+
```
17+
18+
* The return type for the `ProductCollections.ListEntries` method has been updated from `Product` to `ProductCollectionProduct`
19+
20+
Before:
21+
```typescript
22+
ListEntries<TProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProduct>>>
23+
```
24+
25+
After:
26+
```typescript
27+
ListEntries<TProductCollectionBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProductCollectionBuyerProduct>>>
28+
```
29+
530
## version 7.x.x to version 8.x.x
631
* The return type for the `ListEligiblePromotions` method has been updated from `Promotion` to `OrderPromotion`
732

0 commit comments

Comments
 (0)