Cloud SDK release notes
Version:
@sitecore-cloudsdk/core
The following table contains release notes for the Cloud SDK core package:
| Version | Release notes |
|---|---|
| 0.6.1 | The sc_cid cookie, introduced in version 0.6.0, now inherits its value from the old sc_{SitecoreEdgeContextId} cookie, if the old cookie is present in the web browser. To ensure the value is inherited, please upgrade to version 0.6.1, not to 0.6.0.To upgrade your app to SDK version 0.6, see Upgrade from v0.5 to v0.6. |
| 0.6.0 | Renamed the sc_{SitecoreEdgeContextId} cookie to sc_cid.In this version of the SDK, the new cookie does not inherit its value from the old cookie. To ensure the value is inherited, please upgrade to version 0.6.1, not to 0.6.0. |
| 0.5.8 | Version number update due to changes in the personalize package. |
| 0.5.7 | Version number update due to changes in the personalize package. |
| 0.5.6 | Version number update due to changes in the personalize package. |
| 0.5.5 | Version number update due to changes in the search package. |
| 0.5.2 | Version number update due to changes in the search package. |
| 0.5.1 | Version number update due to changes in the personalize and search packages. |
| 0.5.0 | Version number update due to changes in the events, personalize, and search packages. |
| 0.4.4 | Version number update due to changes in the personalize package. |
| 0.4.3 | Version number update due to changes in the events and personalize packages. |
| 0.4.2 | siteName is now available on window.scCloudSDK.core.settings. |
| 0.4.1 | Fixed a bug where the guest ID was undefined during initialization when the browser ID was already set. |
| 0.4.0 | The core package is now publicly available. The package now contains the Cloud SDK initialization logic.The getBrowserId and getGuestId functions are now available in the browser module. |
@sitecore-cloudsdk/events
The following table contains release notes for the Cloud SDK events package:
| Version | Release notes |
|---|---|
| 0.6.1 | Version number update due to changes in the core and personalize packages.To upgrade your app to SDK version 0.6, see Upgrade from v0.5 to v0.6. |
| 0.6.0 | Version number update due to changes in the core and personalize packages. |
| 0.5.8 | Version number update due to changes in the personalize package. |
| 0.5.7 | Version number update due to changes in the personalize package. |
| 0.5.6 | Version number update due to changes in the personalize package. |
| 0.5.5 | Version number update due to changes in the search package. |
| 0.5.2 | Version number update due to changes in the search package. |
| 0.5.1 | Version number update due to changes in the personalize and search packages. |
| 0.5.0 | The old initialization logic using the init function is no longer available. Upgrade your initialization code to the new initialization logic introduced in version 0.4.If you set up Sitecore Search event capturing in version 0.4.0, you used the event function to send SC_SEARCH_WIDGET_VIEW and SC_SEARCH_WIDGET_CLICK events. Cloud SDK version 0.5 introduces the search package with dedicated functions for capturing search events. We recommend that you update your code to use those dedicated functions instead of the event function to send search events. |
| 0.4.4 | Version number update due to changes in the personalize package. |
| 0.4.3 | Event-capturing functions on the window object are now available on window.scCloudSDK.events. |
| 0.4.2 | Version number update due to changes in the core package. |
| 0.4.1 | Version number update due to changes in the core and personalize packages. |
| 0.4.0 | Cloud SDK version 0.4 introduces new initialization logic. If you are upgrading from version 0.3 or earlier, we recommend that you upgrade your initialization code. The version 0.3 initialization logic is deprecated in version 0.4 and removed in version 0.5.If you use the version 0.4 initialization logic, the events package no longer uses the sc_{SitecoreEdgeContextId}personalize cookie introduced in version 0.3.1. If you use the new initialization logic, starting with this version, only the personalize package persists this cookie.If you have Sitecore Search, you can now capture Sitecore Search events.When sending custom events, any event name starting with SC is now a reserved event name. When choosing an event name, do not include SC_ in the name. We continue to recommend that you include the name of the site in the unique event name.The getBrowserId and getGuestId functions are now available in the browser module of the core package. These functions will be removed from the events package in a future release.FORM events now require the componentInstanceId parameter. |
| 0.3.1 | The Cloud SDK now stores a new cookie named sc_{SitecoreEdgeContextId}_personalize in the web browser. This cookie persists the guest ID between sessions.Every event now captures the UTC date and time when the event triggered, with millisecond precision. |
| 0.3.0 | We simplified the eventData object and updated function signatures so that the order of function parameters is consistent across packages.Changes to eventData channel and currency attributes used to be required. They are now optional.The extensionData object used to be separate from the eventData object. It is now part of eventData.In the event and the addToEventQueue functions, the type parameter used to define the event name. type is now an attribute in eventData.Changes to function signatures is now the last parameter in server-side functions because it's optional in some cases.request is now the first parameter in server-side functions, followed by response, if available. |
| 0.2.4 | Bug fixes and performance improvements. |
| 0.2.3 | Bug fixes and performance improvements. |
| 0.2.2 | The event queue functions are now asynchronous. |
| 0.1.3 | The first release of the events package lets you track site visitors' behavior by capturing VIEW, IDENTITY, FORM, and custom events in real time. |
@sitecore-cloudsdk/personalize
The following table contains release notes for the Cloud SDK personalize package:
| Version | Release notes |
|---|---|
| 0.6.1 | The sc_cid_personalize cookie, introduced in version 0.6.0, now inherits its value from the old sc_{SitecoreEdgeContextId}_personalize cookie, if the old cookie is present in the web browser. To ensure the value is inherited, please upgrade to version 0.6.1.To upgrade your app to SDK version 0.6, see Upgrade from v0.5 to v0.6. |
| 0.6.0 | Renamed the sc_{SitecoreEdgeContextId}_personalize cookie to sc_cid_personalize.In this version of the SDK, the new cookie does not inherit its value from the old cookie. To ensure the value is inherited, please upgrade to version 0.6.1, not to 0.6.0. |
| 0.5.8 | Reverted a cookie name change introduced in version 0.5.7. Please upgrade from version 0.5.7. |
| 0.5.7 | Introduced an incorrect cookie name change, reverted in version 0.5.8. Please upgrade to version 0.5.8. |
| 0.5.6 | Added support for language parameters in personalize web flows to enable multilingual personalization scenarios. |
| 0.5.5 | Version number update due to changes in the search package. |
| 0.5.2 | Version number update due to changes in the search package. |
| 0.5.1 | Previously, JSS apps automatically captured geolocation data using the PersonalizeData interface. You now need to manually set up the capture of geolocation data, regardless of your app type or hosting provider.This change ensures compatibility with Next.js version 15, which no longer captures geolocation data automatically. |
| 0.5.0 | The old initialization logic using the init function is no longer available. Upgrade your initialization code to the new initialization logic introduced in version 0.4. |
| 0.4.4 | In PersonalizeData, the currency attribute used to be required. It is now optional. |
| 0.4.3 | Event-capturing functions on the window object have been moved to window.scCloudSDK.events. |
| 0.4.2 | Version number update due to changes in the core package. |
| 0.4.1 | Fixed a bug where the guest ID was undefined during initialization when the browser ID was already set. |
| 0.4.0 | Cloud SDK version 0.4 introduces new initialization logic. If you are upgrading from version 0.3 or earlier, we recommend that you upgrade your initialization code. The version 0.3 initialization logic is deprecated in version 0.4 and removed in version 0.5.If you use the version 0.4 initialization logic, the events package no longer uses the sc_{SitecoreEdgeContextId}_personalize cookie introduced in version 0.3.1. If you use the new initialization logic, starting with this version, only the personalize package persists this cookie.The Cloud SDK now supports web experiences and web experiments created in Sitecore Personalize. |
| 0.3.1 | The Cloud SDK now stores a new cookie named sc_{SitecoreEdgeContextId}_personalize in the web browser. This cookie persists the guest ID between sessions.personalizationData now accepts the pageVariantIds parameter. This is an array of strings representing IDs of personalized page variants. |
| 0.3.0 | We updated function signatures so that the order of function parameters is consistent across packages is now the last parameter in server-side functions. This way, the order of function parameters is consistent with that in the events package.request is now the first parameter in server-side functions, followed by response, if available. |
| 0.2.4 | The payload of the personalize function now includes UTM parameters from the URL of the webpage where the function runs. |
| 0.2.3 | Bug fixes and performance improvements. |
| 0.2.2 | Bug fixes and performance improvements. |
| 0.1.3 | The first release of the personalize package lets you show personalized content to site visitors by running live interactive personalizations created in Sitecore Personalize. |
@sitecore-cloudsdk/search
The following table contains release notes for the Cloud SDK search package:
| Version | Release notes |
|---|---|
| 0.6.1 | Version number update due to changes in the core and personalize packages.To upgrade your app to SDK version 0.6, see Upgrade from v0.5 to v0.6. |
| 0.6.0 | Version number update due to changes in the core and personalize packages. |
| 0.5.8 | Version number update due to changes in the personalize package. |
| 0.5.7 | Version number update due to changes in the personalize package. |
| 0.5.6 | Version number update due to changes in the personalize package. |
| 0.5.5 | Fixed a bug where the context property was missing for the server version of the getWidgetData function. |
| 0.5.2 | Widget item classes now support specifying a list of source IDs that identify the sources to include results from. The updated classes are |
| 0.5.1 | The SearchOptions interface now supports disabling and enabling the grouping of search results if document grouping has been enabled for an attribute in Sitecore Search.Search event interfaces now support the capture of country and referrer. The updated interfaces are |
| 0.5.0 | The first release of this package lets you build search experiences for site visitors and capture events that occur inside them. For example, you can create a search results page and other types of search experiences such as content or product recommendations and search suggestions. |
If you have suggestions for improving this article, let us know!