Change Log
All notable changes to the RedPoint JavaScript Web Client will be documented in this file.
[Unreleased]
[RPI 6.6.0] - 2022 TBD
Fixed
Added
Changed
- Removed backwards compatibility for legacy (pre 5.2) visitor cookies
Deprecated
Removed
[RPI 6.5.0] - 2022 April
Fixed
Added
Changed
- Added DOM element as an argument to registerForClickEvents
Deprecated
Removed
[RPI 6.4.0] - 2021 December
Fixed
Added
- Added properties to RpiWebClientConfig to support doNotTrack
Changed
Deprecated
Removed
[RPI 6.3.0] - 2021 July
Fixed
Added
- Added properties to RpiWebClientConfig to support Smart Asset updates
- smartAssetDecisions
- visitorProfileMergeMode
- realtimeContextSearchMode
- Added data property to RpiWebClient to store decision results, lens results and tag data
- Added events to support Smart Asset updates
- rpiWebClientSmartAssetDecisionRender
- rpiDecisionTagLoad
- rpiDecisionRecommendationLoad
Changed
- Changed function getDecision to remove the optional slotName method parameter
- Changed functions getDecision/getDecisions to call /SmartAssets/{clientID}/Results for improved performance
- Changed functions getContextDecision/getContextsDecisions to call /SmartAssets/{clientID}/Results for improved performance
Deprecated
- Deprecated function getDecision, use getSmartAssetDecisions instead
- Deprecated function getDecisions, use getSmartAssetDecisions instead
- Deprecated function renderDecision, use renderSmartAssetDecisions instead
- Deprecated function renderDecisions, use renderSmartAssetDecisions instead
- Deprecated interface ContentDecision, use SmartAssetDecision instead
Removed
- Removed unused declarations
- getApiDecisionRequest
- serializeFormData
- getIsMasterMessage
- getDecisionUrl
- getDecisionContextUrl
- Removed property contentDecisions of RpiWebClientConfig
- Removed property enableDecisionCaching of RpiWebClientConfig
- Removed event rpiWebClientDecisionRender
[RPI 6.2.0] - 2021 March
Fixed
- Fixed bug that prevented the flushing of pending events on init when enablePageVisitTracking is set to false
Added
- Added support for sending list parameters to the realtime web service
- Added support for Realtime Lens functionality to assist in collecting visitor profile data
Changed
- Changed RPIWebClient to transpile from Typescript with a target of ECMAScript 6 (ES6)
Deprecated
Removed
[RPI 6.1.0] - 2020 June
Added
- Added decisionResults array to track decision results for an RPIWebClient instance
- Added realtimeCookieSameSite setting to RpiWebClientConfig to control the SameSite setting for the visitor cookie
- Added serverCookieEnabled setting to RpiWebClientConfig to control specify if the server-side visitor cookie is in use
- Added support for specifying realtime slot names in the DOM using the rg-content-slot custom attribute
- getDomElement will fall back to using DOM IDs if the query for rg-content-slot is undefined
- Added rg-decision-meta custom attribute to the DOM elements replaced with content returned from the realtime service
Changed
- Updated internal implementation to use navigator.sendBeacon for link click tracking, where supported
- Improves link click tracking in Safari 11.1+ and Firefox 31+
- Implemented local storage solution for older versions of Safari and Firefox where click events will be recorded on the subsequent page visit
- Renamed parseDecisionResponse to parseResponseJSON to be concise with usage
- The visitor cookie has been updated to only be transmitted on secure requests
Deprecated
Removed
[RPI 6.0.0] - 2020 February
Added
- Added getDomElement function to enhance plugability of rendering functionality
- Added isInitialized property to track the initialization status of the web client
Changed
Deprecated
Removed
[RPI 5.2.0] - 2019 August
Added
- Added this CHANGELOG file to track web client changes between RPI versions
- Added rpiWebClientInitVisitor event to notify subscribers when the visitor object is initialized
- Added plugin to support LiveRamp pixel redirect implementation with realtime
- Added rpiVisitorIdentityLinkSet event to notify subscribers when a LiveRamp IdentityLink has been associated with a visitor profile
- Added getCachedVisitor function to retrieve the visitor object from realtime service
- Added enablePageVisitTracking configuration option to enable/disable page visit tracking from the web client
Changed
- Migrated content and context decision logic from deprecated GET decision endpoints to POST endpoints
- Fixed bug with getDecision callback to handle multiple results returned from the realtime service
- Consolidated visitor, device and geolocation cookies into a single cookie, including new visitor profile object returned from realtime service
- Code added to migrate old cookies to new visitor cookie format
- Implemented UUID for generating visitor IDs from the web client
- Refactored flushRealtimeParameters function to reduce unnecessary calls to cache/visit endpoint
Deprecated
Removed
- Removed private functions for supporting legacy RPI content publishing features
- _renderDynamicContent
- _getDecision
- _renderDecision
- _renderMultipleDecisions