CHANGELOG.md

v5.2.0-dev

• Update storefront preview to support base paths #3666

v5.1.0-dev

• Add Page Designer Support #3727
• Bump commerce-sdk-isomorphic to 5.1.0 #3725
• Update ShopperBasketsV2 hooks documentation and query keys
• Add Node 24 support. Drop Node 16 support. #3652
• Add Shopper Consents API support #3674

v5.0.0 (Feb 12, 2026)

• Upgrade to commerce-sdk-isomorphic v5.0.0 and introduce Payment Instrument SCAPI integration #3552

v4.4.0-dev (Dec 17, 2025)

• [Bugfix] Ensure code_verifier can be optional in resetPassword call #3567
• [Improvement] Strengthening typescript types on custom endpoint options and fetchOptions types #3589
• [Feature] Update authorizePasswordless, getPasswordResetToken, and resetPassword to support use of email mode #3525

v4.3.0 (Dec 17, 2025)

• Upgrade to commerce-sdk-isomorphic v4.2.0 and introduce Shopper Configurations SCAPI integration #3071

v4.2.0 (Nov 04, 2025)

• Upgrade to commerce-sdk-isomorphic v4.0.1 #3449
• Prevent headers from being overridden in generateCustomEndpointOptions #3405

v4.1.0 (Sep 25, 2025)

v4.0.0 (Sep 04, 2025)

• [Breaking] Upgrade to commerce-sdk-isomorphic v4.0.0 #2879
• [Breaking] Remove deprecated properties from useDNT in commerce-sdk-react #3177
• Add support for environment level base paths on /mobify routes #2892
• Update USID expiry to match SLAS refresh token expiry #2854
• [Bugfix] Skip deleting dwsid on shopper login if hybrid auth is enabled for current site. #3151
• Update Auth class and CommerceApiProvider to support custom headers in SCAPI requests #3183

v3.4.0 (Jul 22, 2025)

• Optionally disable auth init in CommerceApiProvider #2629
• Now compatible with either React 17 and 18 #2506
• Gracefully handle missing SDK Clients in CommerceApiProvider #2539
• Refactor commerce-sdk-react to allow injecting ApiClients #2519
• Upgrade to commerce-sdk-isomorphic v3.4.0 #2866

v3.3.0 (May 22, 2025)

• Fix inconsistency between dwsid and access token for guest login when hybrid authentication is enabled #2397
• Invalidate cache instead of removing cache when triggering logout #2323
• Fix dependencies vulnerabilities #2338
• Allow custom parameters/body to be passed to SLAS authorize/authenticate calls via commerce-sdk-react auth helpers #2358

v3.2.1 (Mar 05, 2025)

• Update PWA-Kit SDKs to v3.9.1 #2301

v3.2.0 (Feb 18, 2025)

• Allow cookies for ShopperLogin API [#2190](#2190
• Fix refresh token TTL warning from firing when override is not provided #2114
• Readme updates for private clients #2212
• Update CacheUpdateMatrix for mergeBasket mutation #2138
• Clear auth state if session has been invalidated by a password change #2092
• DNT interface improvement #2203
• Support Node 22 #2218
• Add authorizeIDP, loginIDPUser, authorizePasswordless, getPasswordLessAccessToken, getPasswordResetToken, and resetPassword wrapper functions to support Social Login, Passwordless Login, and Password Reset [#2079] (#2079)

v3.1.0 (Oct 28, 2024)

• [Server Affinity] Attach dwsid to SCAPI request headers #2090
• Add the authorizeCustomer and getPasswordResetToken to the ShopperLoginMutations #2056
• Add useDNT hook to commerce-sdk-react and put DNT in auth #2067
• Add Trusted Agent on Behalf of (TAOB) support for SLAS APIs #2077
• Add optional refreshTokenRegisteredCookieTTL and refreshTokenGuestCookieTTL to Commerce API config #2077
• Improve refresh token error logging #2028
• Remove ocapi session-bridging on phased launches #2011
• Add defaultDnt to support setting the dnt flag for SLAS. Upgrade commerce-sdk-isomorphic to v3.1.1 #1979
• Update logout helper to work for guest users #1997
• Update useCustomMutation hook to accept request body as a parameter to the mutate function #2030
• Simplify useCustomMutation hook implementation #2034
• Documentation for useCustomMutation hook along with new dynamic body param option #2042

v3.0.1 (Sep 04, 2024)

• Fixed an issue where the expires attribute in cookies, ensuring it uses seconds instead of days. #1994

v3.0.0 (Aug 07, 2024)

• Add meta.displayName to queries. It can be used to identify queries in performance metrics or logs. #1895
• Upgrade to commerce-sdk-isomorphic v3.0.0 #1914

⚠️ Planned API Changes ⚠️

Shopper Context

Starting July 31st 2024, all endpoints in the Shopper context API will require the siteId parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025. You can read more about the planned change here in the notes section.

Shopper Login (SLAS)

SLAS will soon require new tenants to pass channel_id as an argument for retrieving guest access tokens. You can read more about the planned change here.

Please be aware that existing tenants are on a temporary allow list and will see no immediate disruption to service. We do ask that all users seek to adhere to the channel_id requirement before the end of August to enhance your security posture before the holiday peak season.

In practice, we recommend:

• For customers using the SLAS helpers with a private client, it is recommended to upgrade to v3.0.0 of the commerce-sdk-react.

v2.0.2 (Jul 12, 2024)

• Updated StorefrontPreview component to make siteId available #1874

v2.0.1 (Jul 08, 2024)

• Fix private slas proxy config for commerce api in provider #1883
• Fix useCustomQuery error handling #1883
• Fix updateCustomer squashing existing data #1883
• Fix transferBasket updating the wrong customer basket #1887

v2.0.0 (Jun 25, 2024)

• Add useCustomQuery and useCustomMutation for SCAPI custom endpoint support #1793
• Add Shopper Stores hooks #1788
• Add a helper method to add an item to either new or existing basket #1677
• Add updateItemsInBasket mutation #1852
• Upgrade to commerce-sdk-isomorphic v2.1.0 #1852

v1.4.2 (Apr 17, 2024)

• Update SLAS private proxy path #1752

v1.4.1 (Apr 16, 2024)

• Add missing params keys allVariationProperties and perPricebook for Shopper Search #1750

v1.4.0 (Apr 15, 2024)

• Add Support for SLAS private flow #1722
• Fix invalid query params warnings and allow custom query #1655
• Fix cannot read properties of undefined (reading 'unshift') #1689
• Add Shopper SEO hook #1688
• Update useLocalStorage implementation to be more responsive #1703
• Storefront Preview: avoid stale cached Commerce API responses, whenever the Shopper Context is set #1701

v1.3.0 (Jan 19, 2024)

• Add support for node 20 #1612

v1.2.0 (Dec 08, 2023)

• Add StorefrontPreview component 'onContextChange' property to prepare for future Storefront Preview release #1527
• Update engine compatibility to include npm 10 #1597

v1.1.0 (Nov 03, 2023)

• Add StorefrontPreview component #1508
• Using login for authentication instead of email in registration process #1464
• Fix bug to remove cookies using the default attributes used when setting cookie #1505

v1.0.2 (Sep 21, 2023)

• commerce-sdk-react: have typedoc-related deps as dev dependencies #1425
• Updated commerce-sdk-isomorphic to v1.10.4 #137

v1.0.1 (Jul 26, 2023)

• Updated the expiry of the guest refresh token cookie to 30 days, to match the actual duration of the token. #1342
• Fix potential security vulnerability in semver dependency #1358
• Fix request headers to be the intended headers, rather than parameters #1377

v1.0.0 (Jun 15, 2023)

• First public release of package on npm under @salesforce/commerce-sdk-react
• Add missing cache invalidation for contexts/customers/login/order #1073
• Upgrade React 18, React DOM 18, @types/react@18, @types/react-dom@v18 Testing library 14 #1166

Older Versions Without Namespace

The older versions below were published without the @salesforce namespace.

v2.7.1 (May 11, 2023)

• Re-generate lock files and fix hook lib tests #1186
• Add additional properties to ShopperLogin test types #1185
• Add missing cache invalidation for contexts/customers/login/order #1073
• Fix Shopper Baskets Test case #1082
• Implement remaining Shopper Baskets cache logic #1070
• Decode pre-fetched token and save auth data in storage #1052
• Allow query hook parameters to be null. #1046
• Implement updateCustomerPassword as no-op. #1031

v2.7.0 (Mar 03, 2023)

• Add Page/Region/Component components for shopper experience/page designer page rendering #963
• Namespace Auth storage keys with site identifier to allow multi-site support #911
• Add Shopper Experience usePage and usePages hooks#958

v2.6.0 (Jan 25, 2023)

v2.5.0 (Jan 05, 2023)

• Exclude test files in package file to avoid publishing them #856
• Pass in 'headers' and 'rawResponse' options to mutation hooks #845
• Commerce hooks: basket mutations #834
• Remove overriding of params in mutation hooks #859

v2.4.0 (Dec 01, 2022)