Last modified September 17, 2024 by Shelly Wolfe

Smart TV SDK release notes

Swrve has an open source SDK repository. There are two options for downloading the latest public Swrve SmartTV SDK:

  • Install the SDK using npm (node package manager).
    Run the following command: npm install @swrve/smarttv-sdk.
  • Download the SDK from the GitHub public repository.

For upgrade instructions, see the Smart TV upgrade guide.

Release 3.0.1

Release date: Dec 18, 2024

Fixes

  • Fixed an issue affecting new API SwrveSDK.onIAMShown() where the callback did not execute from event triggered In-app messages.

Release 3.0.0

Release date: Dec 5, 2024

Feature

  • Added support for multiple pages within an in-app message campaign.
  • Added support for sending an event or user property update when a user engages with an in-app message. For more information, see In-App Messages.
  • Added OR and CONTAINS conditions support to in-app message triggering logic.
  • Added accessibility text support for in-app messages.
  • Added new config APIs to override certain properties. For more information, see the Smart TV Upgrade guide.
  • Added new API SwrveSDK.onIAMShown() to receive callback when an in-app message is initially shown on screen.
  • Added new API SwrveSDK.isMessageShowing() which returns true if in-app message is currently showing on screen.
  • In-app messages now support displaying animated GIFs as the background or button image format.

Release 2.1.0

Release date: Jun 11, 2024

Feature

  • Added new config APIs customKeyMappingBase to allow setting custom key mappings. For more information, see the Smart TV integration guide.

Fixes

  • Updated Identify API to include a success callback when loaded from cache.
  • Prevent campaigns been reset in memory for new users.
  • Fixed an issue where 2 impressions events were been sent for an in-app Message.

Release 2.0.0

Release date: May 20, 2024

Feature

  • Added new config APIs customKeyMappginTizenand customKeyMappginWebOS to allow setting custom key mappings. For more information, see the Smart TV integration guide.
  • Added new config API customMapping to allow for full override for custom platform implementations. For more information, see the Smart TV integration guide.
  • Updated existing Identify API to include a success callback.  For more information, see the Smart TV Upgrade guide.
  • Updated existing onCampaignLoaded API to callback when assets have finished loading.

Fixes

  • Adjusted in-app message container settings to use window.innerHeight and window.innerWidth to allow for more screen resolutions.
  • Removed Etag reset logic on session end.

Release 1.3.0

Release date: April 4, 2024

Fixes

  • Updated our third-party dependencies to mitigate potential security vulnerabilities.
  • Added a restriction on api keys that start with secret-
  • Added support for setting message centre campaigns status to seen or deleted.

Release 1.2.1

Release date: February 14, 2024

Fixes

  • Removed space and length restrictions on event names for consistency across our SDKs.

Release 1.2.0

Release date: January 16, 2024

Features

Release 1.1.8

Release date: May 18, 2023

Fixes

  • Fixed an issue with campaign click events reporting incorrect message IDs, which displayed 0 in the engaged event reports for all campaigns.

Release 1.1.7

Release date: April 27, 2023

Fixes

  • Fixed an issue with campaign throttling due to an incorrect UTC DateTime format check.

Release 1.1.6

Release date: March 22, 2023

Fixes

  • Fixed an issue with deeplink handling. If a custom button callback is defined, the SDK will not attempt to open URL-based deeplinks.

Release 1.1.5

Release date: March 8, 2023

Fixes

  • Fixed an issue where campaigns set to trigger on app launch were not displaying correctly if an app-level display rule was set.
  • Fixed issue with QA User campaign state not resetting on App reload.
  • Fixed DateTime formats to include milliseconds.
  • Adjusted lifecycle listeners to use onbeforeunload to improve performance.
  • Adjusted session restore logic to accurately determine when a new session is started.

Previous releases summary

Date Version Features and Fixes
May 11, 2022 1.1.4 Resolved an issue affecting Tizen variants where device resolution information was not being returned correctly.
April 20, 2022 1.1.3 Added the inAppMessageStyleOverride configuration option that allows you to override the in-app message container CSS style. Various bug fixes.
December 8, 2021 1.1.2 Resolved an issue where campaign state was not storing correctly for in-app messages.
September 3, 2021 1.1.1 Added support for Universal Module Definition (UMD) and handle key up event when closing an in-app message.
October 22, 2020 1.1.0 Updated tracking of device OS and type for platform-specific delivery of in-app messages. Fixed package.json dependencies to resolve Dependabot alerts.
February 26, 2019 1.0.3 Fixed an issue where the User Identity URL endpoint was not correct for apps using our EU stack.
December 6, 2018 1.0.2 Various bug fixes.
October 25, 2018 1.0.1 Various bug fixes.