Skip to content

Commit

Permalink
✏️ update changelog and migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
erincdustin committed Dec 5, 2024
1 parent 9761897 commit 1e1d74d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

# [9.0.0] - 2024-12-05
- This version includes a breaking change that updates the following return types:
- `ProductCollectionBuyerProduct` (updated from `BuyerProduct`) is the new type returned from `Me.ListProductCollectionEntries`
- `ProductCollectionProduct` (updated from `Product`) is the new type returned from `ProductCollections.ListEntries`

# [8.0.2] - 2024-12-03
- Bug fix for "process is undefined" accessor error when not using NextJS

Expand Down
25 changes: 25 additions & 0 deletions MIGRATION_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,31 @@

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

## version 8.x.x to version 9.x.x
* The return type for the `Me.ListProductCollectionEntries` method has been updated from `BuyerProduct` to `ProductCollectionBuyerProduct`

Before:
```typescript
ListProductCollectionEntries<TBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TBuyerProduct>>>
```

After:
```typescript
ListProductCollectionEntries<TProductCollectionBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProductCollectionBuyerProduct>>>
```

* The return type for the `ProductCollections.ListEntries` method has been updated from `Product` to `ProductCollectionProduct`

Before:
```typescript
ListEntries<TProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProduct>>>
```

After:
```typescript
ListEntries<TProductCollectionBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProductCollectionBuyerProduct>>>
```

## version 7.x.x to version 8.x.x
* The return type for the `ListEligiblePromotions` method has been updated from `Promotion` to `OrderPromotion`

Expand Down

0 comments on commit 1e1d74d

Please sign in to comment.