From 1e1d74d5c0e13bb8657f78a9454d519d928cfa8a Mon Sep 17 00:00:00 2001 From: Erin Date: Thu, 5 Dec 2024 14:24:52 -0800 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20update=20changelog=20and?= =?UTF-8?q?=20migration=20guide?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 5 +++++ MIGRATION_GUIDE.md | 25 +++++++++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a55e7df0..99deeb45 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md index 8d26239b..2e1eea66 100644 --- a/MIGRATION_GUIDE.md +++ b/MIGRATION_GUIDE.md @@ -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(...) : Promise>> + ``` + + After: + ```typescript + ListProductCollectionEntries(...) : Promise>> + ``` + + * The return type for the `ProductCollections.ListEntries` method has been updated from `Product` to `ProductCollectionProduct` + + Before: + ```typescript + ListEntries(...) : Promise>> + ``` + + After: + ```typescript + ListEntries(...) : Promise>> + ``` + ## version 7.x.x to version 8.x.x * The return type for the `ListEligiblePromotions` method has been updated from `Promotion` to `OrderPromotion`