Partilhar via

Clarity Packages Changelog

  • Artigo

Android SDK Changelog

3.0.1 (December 15, 2024)

  • [Enhancement] Custom screen names specified through setCurrentScreenName() API fully replace displayed screen name.
  • [BugFix] Addressed various minor bugs.

3.0.0 (November 24, 2024)

  • [Breaking] The allowMeteredNetworkUsage, enableWebViewCapture, disableOnLowEndDevices, allowedActivities, disallowedActivities, maximumDailyNetworkUsageInMB and allowedDomains configuration options in ClarityConfig are moved to the Settings page on the Clarity dashboard.
  • [Breaking] setOnNewSessionStartedCallback is renamed to setOnSessionStartedCallback to better represent its functionality as the callback can be invoked not only when a new Clarity session starts but also when an existing session resumes at app startup.
  • [Feature] Introduced the startNewSession API to initiate new sessions.
  • [Feature] Enabled setting custom screen name tags using setCurrentScreenName API.
  • [Feature] Added the ability to send custom events to use with the new Smart Events feature.
  • [Enhancement] Added support for keyboard visualization for composables.
  • [BugFix] Addressed various minor bugs.

2.5.2 (September 29, 2024)

  • [BugFix] Fixed minor bug related to java utils.

2.5.1 (August 28, 2024)

  • [BugFix] Fixed a bug related to web views.

2.5.0 (July 15, 2024)

  • [Feature] Support Jetpack Compose in clarity-compose package.

2.4.0 (July 1, 2024)

  • [Enhancement] Significant optimizations for network consumption.
  • [Enhancement] Significant reduction in number of network calls.
  • [BugFix] Fixed a bug that caused incorrect visualization of some frames.
  • [BugFix] Fixed a bug that caused some frames to be dropped due to an internal exception.
  • [BugFix] Fixed a bug that caused some sections of session recordings to repeat within a recording.

2.3.0 (May 9, 2024)

  • [Enhancement] Optimizations for capturing logic CPU consumption.
  • [Feature] Supporting keyboard capturing.
  • [Feature] Supporting back gesture capturing.
  • [Feature] Added pause API to allow pausing Clarity capturing.
  • [Feature] Added resume API to allow resuming Clarity capturing.
  • [Feature] Added isPaused API to check whether clarity capturing is paused or not.

2.2.0 (March 18, 2024)

  • [Enhancement] Significant optimization for capturing logic CPU consumption.
  • [Feature] Supporting dialogues capturing.
  • [Feature] Expose a configuration to set a daily network usage limit for Clarity.
  • [Feature] Expose a different initialization function Clarity.initialize(activity, config) that enables late initialization (for example, after the activity is created and resumed). This allows the developers to initialize Clarity after their key application components loaded.

2.1.1 (December 21, 2023)

  • [BugFix] Fixed a minor bug that prevented Clarity from starting in a certain scenario.

2.1.0 (December 19, 2023)

  • [Feature] Support Android 14 (API 34).
  • [Enhancement] Added necessary logic to prevent OOM errors.
  • [Enhancement] Optimized for the application startup time.
  • [Feature] Exposing setOnNewSessionStartedCallback API to set an onSessionStarted callback.
  • [Feature] Exposing getCurrentSessionUrl API to retrieve the current active session URL.

2.0.0 (October 25, 2023)

  • [Feature] Added the setCustomSessionId API to set a custom session ID.
  • [Feature] Added the ability to limit capturing to certain screens through the configuration lists allowedActivities and disallowedActivities.
  • [Feature] Added the configuration flag disableOnLowEndDevices to allow disabling Clarity on low-end devices.
  • [Enhancement] Updated the capturing approach to enhance its efficiency and resiliency.
  • [Breaking] Jetpack Compose screens aren't captured anymore. Expect an upcoming release with better support for Jetpack Compose.

1.3.3 (September 4, 2023)

  • [Feature] Support sessions filtering on Device cores and memory.
  • [Feature] Added the setCustomTag API to support tagging sessions with custom tags.
  • [Enhancement] Enhanced memory management.
  • [Enhancement] Enhanced web view styles capturing.

1.3.1 (June 22, 2023)

  • [Enhancement] Improved SDK performance and efficiency.
  • [Enhancement] Enhanced recording speed for apps with large fonts.
  • [Enhancement] Updated heatmaps logic for a more accurate experience.
  • [BugFix] Fixed a bug that affected the capture of Ionic/Cordova apps assets.
  • [BugFix] Fixed a bug that caused frames to be dropped due to an internal exception.
  • [Feature] Switched to Protobuf instead of moshi for better compatibility.

1.3.0 (May 22, 2023)

  • [Enhancement] Improved web views capture component for better performance and reliability.
  • [Enhancement] Added resilience to capture failures.
  • [Feature] Added a new dashboard feature to filter by device specifications (cores & memory).
  • [BugFix] Fixed a bug that affected the movement of input text boxes.
  • [BugFix] Fixed a bug that caused a StackOverFlow exception in some apps.
  • [BugFix] Fixed minor capture errors that stopped the SDK.
  • [BugFix] Fixed a bug that prevented some events from being captured.
  • [BugFix] Fixed a bug that caused the SDK to crash due to some hardware bitmap exceptions.

1.2.4 (May 09, 2023)

  • [Enhancement] Invalid UserID is set as CustomUserID and UserID is set to a random value instead of throwing an exception.
  • [Enhancement] Delayed SDK setup until dashboard configuration is retrieved.
  • [Feature] Improved SDK initialization for offline device scenarios.

iOS SDK Changelog

3.0.2 (December 15, 2024)

  • [Enhancement] Custom screen names specified through setCurrentScreenName() API fully replace displayed screen name.

3.0.1 (December 4, 2024)

  • [BugFix] Fixed an issue that caused crashes on earlier versions of iOS 16 when using WebViews.
  • [BugFix] Fixed a crash that occurred during the orientation transition of third-party video player implementations (for example, Brightcove).

3.0.0 (November 24, 2024)

  • [Breaking] Removed the experimental feature flag for SwiftUI support, making it enabled by default.
  • [Breaking] The allowMeteredNetworkUsage, enableWebViewCapture, anddisableOnLowEndDevices configuration options in ClarityConfig are moved to the Settings page on the Clarity dashboard.
  • [Breaking] setOnNewSessionStartedCallback is renamed to setOnSessionStartedCallback to better reflect its functionality, as the callback can be invoked not only when a new Clarity session starts but also when an existing session is resumed at app startup.
  • [Feature] Introduced the startNewSession API to initiate new sessions.
  • [Feature] Enabled setting custom screen name tags using setCurrentScreenName API.
  • [Feature] Added the ability to allow or disallow capturing WebViews based on URL patterns defined on the Clarity dashboard.
  • [Feature] Added the ability to send custom events to use with the new Smart Events feature.
  • [Enhancement] Implemented the capturing of text content from tapped view elements.
  • [Enhancement] Enhanced dead tap detection for SwiftUI views.
  • [Enhancement] Added initial support for keyboard visualization.
  • [BugFix] Addressed various minor bugs.

2.2.3 (December 4, 2024)

  • [BugFix] Fixed an issue that caused crashes on earlier versions of iOS 16 when using WebViews.

2.2.2 (November 17, 2024)

  • [BugFix] Fixed a bug which caused crashes when AVPlayer was present on the screen.
  • [BugFix] Fixed a bug which caused taps to appear in incorrect locations during session playback.

2.2.1 (October 30, 2024)

  • [BugFix] Fixed a bug related to font data uploading.

2.2.0 (October 30, 2024)

  • [Feature] Supporting iOS 18.

2.1.2 (September 12, 2024)

  • [BugFix] Fixed a bug that caused UIGraphicsBeginImageContext() to crash in some apps.
  • [BugFix] Fixed a bug that caused app layout changes when CarbonTabSwipeSegmentedControl component from CarbonKit library is used.

2.1.1 (September 10, 2024)

  • [BugFix] Fixed a bug that caused crashes in React Native apps that use react-native-svg.

2.1.0 (August 21, 2024)

  • [Feature] Implemented support for custom callbacks that triggers at the beginning of new Clarity sessions.
  • [Enhancement] Optimized screen capturing by pausing during periods of inactivity.
  • [Enhancement] Included privacy manifest.
  • [BugFix] Fixed a bug that caused UIGraphicsBeginImageContext() to crash in some apps.
  • [BugFix] Fixed a bug that caused app layout changes when CarbonTabSwipeSegmentedControl component from CarbonKit library is used.

2.0.0 (July 29, 2024)

  • [Breaking] Dropped the optional fields from the Objective-C interface of ClarityConfig initializer in favor of field setter approach to maintain backwards compatibility for future releases.
  • [Feature] Introducing experimental support for SwiftUI apps through the enableSwiftUI_Experimental flag.

1.0.2 (August 28, 2024)

  • [BugFix] Fixed a bug related to web views.

1.0.1 (July 22, 2024)

  • [BugFix] Minor bug fixes.

1.0.0 (July 1, 2024)

  • [Initial Release] This is the first public release of the iOS SDK.

React Native SDK Changelog

4.0.4 (December 15, 2024)

  • [Enhancement] Custom screen names specified through setCurrentScreenName() API fully replace displayed screen name.
  • [Enhancement] Upgrade native Android SDK to version 3.0.1.
  • [Enhancement] Upgrade native iOS SDK to version 3.0.2.
  • [BugFix] Addressed various minor bugs.

4.0.3 (December 4, 2024)

  • [BugFix] Fixed an issue that caused crashes on earlier versions of iOS 16 when using WebViews.
  • [BugFix] Fixed a crash that occurred during the orientation transition of third-party video player implementations (for example, Brightcove).
  • [Enhancement] Upgrade native iOS SDK to version 3.0.1.

4.0.2 (December 1, 2024)

  • [BugFix] This release only addresses an npm registry issue that prevented the installation of version 4.0.1. Both versions, 4.0.1 and 4.0.2, offer the same feature set and improvements.

4.0.1 (November 24, 2024)

  • [Breaking] npm package is renamed to @microsoft/react-native-clarity.
  • [Breaking] Removed the experimental feature flag for iOS support, making it enabled by default.
  • [Breaking] The allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains, disableOnLowEndDevices, and maximumDailyNetworkUsageInMB configuration options in ClarityConfig are moved to the Settings page on the Clarity dashboard.
  • [Feature] Introduced the startNewSession API to initiate new sessions.
  • [Feature] Enabled setting custom screen name tags using setCurrentScreenName API.
  • [Feature] Added the ability to allow or disallow capturing WebViews based on URL patterns defined on the Clarity dashboard.
  • [Feature] Added the ability to send custom events to use with the new Smart Events feature.
  • [Enhancement] Upgrade native iOS SDK to version 3.0.0.
  • [Enhancement] Upgrade native Android SDK to version 3.0.0.
  • [BugFix] Addressed various minor bugs.

3.1.1 (October 30, 2024)

  • [Enhancement] Upgrade native iOS SDK to version 2.2.1.

3.1.0 (October 30, 2024)

  • [Feature] Supporting iOS 18.
  • [Enhancement] Upgrade native iOS SDK to version 2.2.0.

3.0.5 (October 24, 2024)

  • [BugFix] Resolved a build issue with the new React Native architecture on iOS.

3.0.4 (September 12, 2024)

  • [Enhancement] Upgrade native iOS SDK to version 2.1.2.

3.0.3 (September 10, 2024)

  • [Enhancement] Upgrade native iOS SDK to version 2.1.1.

3.0.2 (September 9, 2024)

  • [Enhancement] Upgrade native iOS SDK to version 2.1.0.

3.0.1 (July 22, 2024)

  • [Enhancement] Upgrade native Android SDK to version 2.4.0.

3.0.0 (July 1, 2024)

  • [Breaking] Installing Clarity alongside old versions of react-native-svg (< 14.x) is no longer allowed due to incompatibility issues.
  • [Feature] Introducing experimental support for iOS (enableIOS_experimental flag).
  • [Enhancement] Significant optimizations for network consumption.
  • [Enhancement] Significant reduction in number of network calls.
  • [BugFix] Fixed a bug that caused incorrect visualization of some frames.
  • [BugFix] Fixed a bug that caused some frames to be dropped due to an internal exception.
  • [BugFix] Fixed a bug that caused some sections of session recordings to repeat within a recording.

2.3.0 (May 9, 2024)

  • [Enhancement] Optimizations for capturing logic CPU consumption.
  • [Feature] Supporting keyboard capturing.
  • [Feature] Supporting back gesture capturing.
  • [Feature] Added the pause API to allow pausing Clarity capturing.
  • [Feature] Added the resume API to allow resuming Clarity capturing.
  • [Feature] Added the isPaused API to check whether clarity capturing is paused or not.

2.2.1 (March 19, 2024)

  • [Enhancement] Significant optimization for capturing logic CPU consumption.
  • [Feature] Supporting dialogues capturing.
  • [Feature] Expose a configuration to set a daily network usage limit for Clarity.

2.1.0 (December 22, 2023)

  • [Feature] Support Android 14 (API 34).
  • [Enhancement] Added necessary logic to prevent OOM errors.
  • [Enhancement] Optimized for the application startup time.
  • [Feature] Exposing an API to retrieve the current active session URL.
  • [BugFix] Accept null as a legitimate value for the setCurrentScreenName function to clear the current screen name.

2.0.0 (November 6, 2023)

  • [Breaking] Updated the initialize() API arguments to take configurations in an object instead of taking them separately.
  • [Feature] Added the setCustomSessionId API to set a custom session ID.
  • [Feature] Added the configuration flag disableOnLowEndDevices to allow disabling Clarity on low-end devices.
  • [BugFix] Updated the capturing approach to fix issues faced by some customers related to edit text fields.
  • [BugFix] Fixed issues relating to setCustomUserId not working consistently.

1.0.1 (September 6, 2023)

  • [Feature] Added the setCustomTag API to support tagging sessions with custom tags.
  • [Feature] Added the setCurrentScreenName API to support setting current screen name, which enables filtering on a certain screen on the dashboard.

Cordova/Ionic SDK Changelog

2.4.0 (July 1, 2024)

  • [Enhancement] Significant optimizations for network consumption.
  • [Enhancement] Significant reduction in number of network calls.
  • [BugFix] Fixed a bug that caused incorrect visualization of some frames.
  • [BugFix] Fixed a bug that caused some frames to be dropped due to an internal exception.
  • [BugFix] Fixed a bug that caused some sections of session recordings to repeat within a recording.

2.3.0 (May 9, 2024)

  • [Enhancement] Optimizations for capturing logic CPU consumption.
  • [Feature] Supporting keyboard capturing.
  • [Feature] Supporting back gesture capturing.
  • [Feature] Added the pause API to allow pausing Clarity capturing.
  • [Feature] Added the resume API to allow resuming Clarity capturing.
  • [Feature] Added the isPaused API to check whether clarity capturing is paused or not.

2.2.0 (March 18, 2024)

  • [Enhancement] Significant optimization for capturing logic CPU consumption.
  • [Feature] Supporting dialogues capturing.
  • [Feature] Expose a configuration to set a daily network usage limit for Clarity.

2.1.0 (December 22, 2023)

  • [Feature] Support Android 14 (API 34).
  • [Enhancement] Added necessary logic to prevent OOM errors.
  • [Enhancement] Optimized for the application startup time.
  • [Feature] Exposing an API to retrieve the current active session URL.

2.0.0 (November 8, 2023)

  • [Breaking] Updated the initialize() API arguments to take configurations in an object instead of taking them separately.
  • [Feature] Added the setCustomSessionId API to set a custom session ID.
  • [Feature] Added the configuration flag disableOnLowEndDevices to allow disabling Clarity on low-end devices.
  • [BugFix] Fixed issues relating to setCustomUserId not working consistently.

1.0.1 (September 7, 2023)

  • [Feature] Added the setCustomTag API to support tagging sessions with custom tags.