Skip to content

CHANGELOG.md

Latest commit

 

History

History
348 lines (247 loc) · 14.4 KB

CHANGELOG.md

File metadata and controls

348 lines (247 loc) · 14.4 KB
Raw

Changelog

All notable changes to the ordercloud-javascript-sdk will be documented in this file starting in version 4. Migration guide for versions prior to version 4 are documented here

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[14.0.0] - 2026-10-15

  • Breaking: customRoles is a property of the auth options object on Auth.Login, Auth.ElevatedLogin, Auth.ClientCredentials, and Auth.Anonymous, instead of its own argument. Custom roles with no standard roles are sent as the scope string. That case previously sent the literal text undefined.
  • Breaking: a nested model is one type parameter constrained to that model, instead of one parameter per nested xp. Order<MyOrderXp> is unchanged. Order<MyOrderXp, MyFromUserXp> and OrderWorksheet<SomeXp> are not. See the migration guide.
  • Breaking: axios is no longer a peer dependency. Requests use the platform fetch. requestOptions.cancelToken is now requestOptions.signal. axiosAdapter and axios interceptors are replaced by Configuration.Set({ fetch, onRequest, onResponse }). See the migration guide.
  • Docs "Defined in" links are written on a single build. src/Configuration.ts matches the TypeScript filename casing.

[13.0.0] - 2026-09-25

  • Bring SDK up to date with API v1.0.470. Breaking: ApiClient.ClientSecret and SecurityProfile.IsExternalRoleGroup are removed. Buyer product PriceSchedule is now BuyerPriceSchedule.
  • Update dev dependencies, including TypeScript 5.9 and TypeDoc 0.28. TypeDoc 0.28 requires the missing-exports plugin to be listed explicitly.

[12.0.0] - 2026-03-10

  • Bring SDK up to date with API v1.0.437. Includes a breaking change to Message Senders - see migration guide for more details.

[11.1.5] - 2026-03-02

  • Bring SDK up to date with API v1.0.436

[11.1.4] - 2025-12-17

  • Bring SDK up to date with API v1.0.432

[11.1.3] - 2025-11-10

  • Bring SDK up to date with API v1.0.426

[11.1.2] - 2025-08-20

  • Bring SDK up to date with API v1.0.412

[11.1.1] - 2025-07-23

  • Re-published package with missing build output included. No changes to runtime code.

[11.1.0] - 2025-07-22

  • Add identity provider token management

[11.0.7] - 2025-07-16

  • Bring SDK up to date with API v1.0.407

[11.0.6] - 2025-07-09

  • Bring SDK up to date with API v1.0.406

[11.0.5] - 2025-06-12

  • Bring SDK up to date with API v1.0.402

[11.0.4] - 2025-06-10

  • Bring SDK up to date with API v1.0.401

[11.0.3] - 2025-05-20

  • Bring SDK up to date with API v1.0.399
  • Adds Message Sender templates for One Time Passwords

[11.0.2] - 2025-04-04

  • Bring SDK up to date with API v1.0.393

[11.0.1] - 2025-03-05

  • Introduce github action workflows

[11.0.0] - 2025-03-04

  • Bring SDK up to date with API v1.0.384
  • This version includes a breaking change to the return type of Cart.ListEligiblePromotions and Orders.ListEligiblePromotions. See migration guide for more details.

[10.0.3] - 2025-02-05

  • Bring SDK up to date with API v1.0.378

[10.0.2] - 2025-01-29

  • Bring SDK up to date with API v1.0.377

[10.0.1] - 2025-01-23

  • Bring SDK up to date with API v1.0.376

[10.0.0] - 2025-01-14

  • Bring SDK up to date with API v1.0.374
  • This version includes a breaking change to the listOptions in several ListAssignment operations. See migration guide for more details.

[9.0.3] - 2025-01-13

  • Resolve security vulnerabilities

[9.0.2] - 2024-12-19

  • Bring SDK up to date with API v1.0.373

[9.0.1] - 2024-12-13

  • Resolve high and critical security vulnerabilities

[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

[8.0.1] - 2024-11-06

  • Bring SDK up to date with API v1.0.368

[8.0.0] - 2024-10-31

  • This version includes a breaking change that changes the return type for the ListEligiblePromotions method

[7.0.0] - 2024-10-10

  • Bring SDK up to date with API v1.0.365
  • This version includes a breaking change that corrects naming for Entity Sync methods

[6.1.2] - 2024-09-11

  • Bring SDK up to date with API v1.0.359, which adds Gratuity to the Order model

[6.1.1] - 2024-09-05

  • Bring SDK up to date with API v1.0.357, which adds QuantityLimitPerOrder to Promotions and introduces Inventory Record Entity Sync

[6.1.0] - 2024-08-09

  • Bring SDK up to date with API v1.0.354
  • Fixes an incorrect return type on CreatePaymentTransaction

[6.0.8] - 2024-06-20

[6.0.7] - 2024-04-17

  • Bring SDK up to date with API v1.0.338

[6.0.6] - 2024-04-03

  • Bring SDK up to date with API v1.0.333

[6.0.5] - 2024-03-28

  • Bring SDK up to date with API v1.0.332, which adds Suppliers to Entity Sync

[6.0.4] - 2024-03-20

Fixed

  • Error when trying to set token in edge runtime because trying to use document in server environment

[6.0.3] - 2024-03-19

  • Bring SDK up to date with API v1.0.328, which adds Admin, Buyer and Supplier users to Entity Sync

[6.0.2] - 2024-03-13

  • Bring SDK up to date with API v1.0.327

[6.0.1] - 2024-03-05

  • Bring SDK up to date with API v1.0.325, which introduces Entity sync

[6.0.0] - 2024-03-05

  • Bring SDK up to date with API v1.0.324
  • This version includes a breaking change where forgotten passwords and forgotten usernames have been consolidated under ForgottenCredentials

[5.3.0] - 2024-02-08

  • Bring SDK up to date with API v1.0.320 which adds IsOnSale to line items as well as a new error config endpoint
  • Adds a new method for retrieving an identity token used by the Discover 2 proxy. More details in our product sync documentation

[5.2.4] - 2023-12-18

  • Bring SDK up to date with API v1.0.315 which adds routes to Cart API for setting and updating one time shipping and billing addresses

[5.2.3] - 2023-11-06

  • Fixes broken links within the SDK documentation

[5.2.2] - 2023-10-26

  • Bring SDK up to date with API v1.0.309 which adds new endpoints to support Product Bundles in subscriptions.

[5.2.1] - 2023-09-29

  • Bring SDK up to date with API v1.0.304 which introduces OrderSynchronization.

[5.2.0] - 2023-08-30

  • Update SDK to optionally accept a custom axios adapter
  • Bring SDK up to date with API v1.0.299

[5.1.0] - 2023-08-10

  • Allow methods to be called without a scope parameter. When no scope is provided, OrderCloud will simply return all assigned roles

[5.0.10] - 2023-07-27

  • SDK up to date with API v1.0.296, which introduces product synchronization

[5.0.9] - 2023-07-20

  • SDK up to date with API v1.0.294, which adds support for listing product pricing for multiple sellers in a single API call

[5.0.8] - 2023-06-28

  • SDK up to date with API v1.0.293, which contains some changes to Tracking Events and a new Delivery Configuration feature

[5.0.7] - 2023-06-26

  • SDK up to date with API v1.0.292, which expands Product Collections

[5.0.6] - 2023-04-13

  • SDK up to date with API v1.0.276, which introduces Subscription orders

[5.0.5] - 2023-04-03

  • SDK up to date with API v1.0.274, which expands support for Inventory Records

[5.0.4] - 2023-03-17

  • Update axios peer dependency version from ^1.0.0 to ^1.1.3
    • A bug in axios was causing a filtering issue in our sdk

[5.0.3] - 2023-03-02

  • Add new optional param anonuserid to Auth.Anonymous (part of new tracking events feature)

[5.0.2] - 2023-02-27

  • Add missed changes for Tracking Events

[5.0.1] - 2023-02-27

  • SDK up to date with API v1.0.267, adding support for Tracking Events

[5.0.0-beta.5] - 2023-02-10

[5.0.0-beta.4] - 2023-01-23

[5.0.0-beta.3] - 2022-12-06

Added

  • new types for order returns
    • OrderReturnCalculatePayload
    • OrderReturnCalculateResponse
    • LineItemReturnCalculation

[5.0.0-beta.1] - 2022-11-03

[5.0.0-beta.2] - 2022-12-06

Fixed

  • OrderCloudError was not serializing errors correctly (breaking change)

[5.0.0-beta.1] - 2022-11-03

Added

  • Added support for axios ^1.0.0, version less than 1.0.0 no longer supported (breaking change)
  • Updated OrderCloudError (breaking change more details in MIGRATION_GUIDE.md)

[4.11.1] - 2022-11-03

Fixed

  • Updated acceptable version range for axios dependency (v1.0.0 and up won't work)

[4.11.0] - 2022-09-01

Added

[4.10.1] - 2022-07-01

Fixed

  • Incorrect model type on DecodedToken.role #76

[4.10.0] - 2022-06-22

Added

  • New Feature: Ad-Hoc Products
  • Ad-Hoc Products enables adding products from an external system directly to an OrderCloud order

[4.9.9] - 2022-06-21

Fixed

  • Filters set with 0 are dropped #73
  • Access token not saved after refresh #74

[4.9.8] - 2022-06-08

Added

[4.8.8] - 2022-05-19

Added

  • SDK up to date with API v1.0.238
  • Introduces Order Returns and adds Message Sender templates
  • PriceScheduleID added to LineItems

[4.7.8] - 2022-05-04

Added

  • Added an optional customRoles array to the authentication methods to support authenticating with custom roles, in addition to standard ApiRoles.

[4.6.8] - 2022-05-02

Fixed

  • Docs now up to date with API v1.0.235 and previous changes to DecodedToken.role

Removed

  • The ApiRole InventoryAdmin was removed from the OrderCloud API and is now considered a custom role. This role was removed from the ApiRole type definition. This could be a breaking change if your application uses the role InventoryAdmin. In this case, we recommend making this role a custom role.

[4.6.7] - 2022-04-27

Fixed

  • DecodedToken.role was not properly typed. It is now (ApiRole[] | ApiRole | undefined)

Added

  • SDK up to date with API v1.0.235

[4.6.6] - 2022-04-18

Fixed

  • bug where new models from v4.6.5 were not being bundled in the final output

[4.6.5] - 2022-04-14

Added

  • new models for message sender payloads
  • new models for integration event payloads
  • new models for oidc payloads and response #67

[4.5.5] - 2022-04-07

Fixed

  • bug where filter with boolean false was being dropped (#66)

[4.5.4] - 2022-03-23

Added

  • SDK up to date with API v1.0.233

[4.4.4] - 2022-03-09

Added

[4.3.4] - 2022-03-07

Fixed

  • bug where methods for the Cert resource were using the wrong url

[4.3.3] - 2022-02-17

Fixed

  • bug where type parameters on certain complex models are wrong due to being ordered incorrectly. Affects model OrderWorksheet and OrderSplitResult

[4.3.2] - 2022-01-11

Added

[4.2.2] - 2021-11-09

Added

[4.2.1] - 2021-07-29

Added

Fixed

  • cookieOption defaults were being clobbered and as a result defaults were not being applied

[4.2.0] - 2021-03-04

Added

[4.1.0] - 2021-02-27

Added

Fixed

  • OrderCloudError model not exported from public entry point

Security

  • Upgraded axios dependency to version 0.21.1

[4.0.1] - 2021-01-30

Added

  • SDK up to date with API v1.0.183
  • Cookie options configuration to set path - defaults to root path if no path is provided.

Fixed

  • Prevent list options from being mutated. This lead to side effects for any user relying on the options object
  • Typescript only: list options searchOn and sortBy would produce type errors for valid types