Web Changelog

This patch release fixes an issue where different versions of the SDK running in different tabs/windows could cause a loop when refreshing In-App Experience definitions.. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Ignore remote data refresh messages if the source SDK version doesn’t match

This patch release fixes an In-App Experience rendering issue when using percentage widths for some elements. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Updates to latest In-App Experience renderer

This patch release fixes an issue with on-device segmentation which could cause inaccurate audience checks. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Fixes an issue when removing tags from local device tag storage

This patch release improves the behavior of the SDK when multiple tabs/windows are open to the same site, and reduces the number of situations where a channel’s contact would change, creating conflicts. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Improves consistency of the web SDK when multiple site instances are loaded across tabs/windows
• Updates to the latest In-App Experience renderer to support upcoming features
• Improves handling of contacts to reduce the number of cases where a conflict would occur

This patch release resolves an issue with mobile Safari opt-outs. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Works around a mobile Safari issue causing unintended opt-outs in some cases

This patch release resolves an issue with mobile Safari opt-outs, and fixes a rare race condition in determining which contact a new channel belongs to. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Works around a mobile Safari issue causing unintended opt-outs in some cases
• Fixes a rare issue where multiple instances of the SDK simultaneously registering could result in two contact IDs

This patch release resolves an issue where Story indicators for previous pages were not using the correct color. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Ensure page indicators for past story pages use the filled color instead of the unfilled color

This minor release improves gesture/swipe detection in Scenes, and ensures that in-app experiences that are loaded from a previous session respect their priority ordering. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Sort schedules in priority order when rehydrating in-app experiences
• Use latest in-app experience renderer for updated gesture detection

This minor release adds SDK support for personalizing In-App Experiences using custom event data. This feature will be enabled in the platform in the near future. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Send triggering event data when performing server-side resolution of an In-App Automation payload

This patch release fixes conversion events for permission changes (such as push opt-in) when using Scenes, and improves subscription list loading for channels and contacts. This change is fully backward compatible and does not require any update to existing integrations.

Note that v2.3.2 was an internal-only release, and was never released publicly.

Changes

• Emit conversion events for permission changes (notifications, location) as a result of scene opt-ins
• Cache subscription list listings for channels and contacts

This patch release fixes issues with non-push channel registration in mobile Safari. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Check for presence of pushManager before access on channel registration, as it is not present in some mobile Safari versions unless added to the home screen

This minor release adds support for inline text formatting in In-App Experiences, and improves message priority handling in some cases. This change does not require any update to existing integrations.

Changes

• Update to the latest In-App Experience renderer for inline text formatting support
• Ensure correct message priority is used when displaying ongoing messages

This patch release improves In-App Experiences display handling and delegation to ensure frequency limits are accurately applied in all situations. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Perform rate limit incrementing later in the display process to ensure only actual views are counted against frequency limits
• Only ask display delegates for display permission prior to actual display
• Update to latest In-App Experience renderer

This patch release fixes some issues present in channel registration and In-App Experiences. This change is fully backward compatible and does not require any update to existing integrations.

Note that v2.2.19 was an internal-only release, and was never released publicly.

Changes

• Improves caching of feature flag checks for server-side audiences
• Fixes a rare issue where a user manually clearing their local browser storage could lead to multiple channels being created for a single browser
• Fixes an issue in In-App Experiences where certain types of media would fail to preload, causing the display to be suspended

Version 2 of the Airship Web SDK, which adds new features including In App Experiences for web!

For a full explanation of changes as well explanations of each feature, see Implementing Web SDK v2 as well as our migration guide.

v2.2.18 is the first public release of the Airship Web SDK version 2, all previous released under major version 2 were not public.

New Features

• In-App Experience features, including Scenes and Surveys
• Register browsers as Channels without requiring notification opt-in, allowing In-App Experiences, Named User association, event tracking, and all the features you’re accustomed to in our mobile SDKs

Removed Support

Some features were removed from the SDK; if you still rely on these features, then you will wish to stay on the v1 SDK:

• Support for HTTP setups; this is also referred to as “secure bridge”. The v2 SDK requires HTTPS on all pages.
  • The registration page plugin has been removed, as it was only needed for these setups
• Multi-domain setups are not supported; this is where a single registration was shared across multiple domains or subdomains.
• APNs Safari is no longer supported, as Apple started supporting VAPID push in Safari 16 on macOS 13 and above, which was released October 2022.

Known Issues

• APNs Safari registrations are not automatically migrated to VAPID, and must be re-registered using the sdk.register() method.
• AMP support is untested and not supported for new integrations

• Removes early access feature flag support; this feature will return in a later release

This release fixes some minor defects. It is fully backward compatible with existing installations.

• fix some issues with autogenerated docs for custom events
• introduces a workaround for chrome incorrectly reporting web push permission status in some cases
• transpile external modules for ES5, matching the rest of the SDK’s compilation target

• fixes mobile Safari “standalone” detection inadvertently including desktop Safari 17

• Fix an issue when re-evaluating a feature flag audience condition
• Support emitting feature flag interaction events

• Fixes an issue in feature flag audience evaluation where some comparisons were always done case insensitively
• Updates remote data (feature flags, preference centers) caching to align with other Airship SDKs

• Add support for Feature Flags
• Support specifying the version string of your app when configuring the web SDK, by passing appVersion when initializing

This release has no backward-incompatible changes; when new features are not used, behavior is identical to the previous release.

• Fixes a rare issue where named user identifiers could be cached indefinitely, causing some workflows to fail if the user id was disassociated by another process.

This minor release adds support for mobile Safari web push in iOS 16.4.

In mobile Safari:

• sdk.canRegister will only be true if in “standalone” mode; that is, if the app is added to the home screen. Mobile Safari only supports web push when in this mode.
• Attempts to call sdk.register() when in an unsupported context will reject with a relevant error
• SDK registration plugins, such as the HTML Prompt will not prompt for opt-in unless in a supported context.

This release is backwards compatible, and mobile Safari will automatically be supported, in supported contexts, on any VAPID-enabled integration. However your website may need updates to support these contexts; see iOS Safari docs for further details.

This minor release adds new types describing cross channel preference centers as well as scoped subscription list management for contacts.

• Add scoped subscription list management to the contact Contact.subscriptions
• Update preference center item types to represent cross-channel preference centers

This release has no backward-incompatible changes; if these features are not used, behavior is identical to the previous release.

This minor release adds new options for triggering an email double opt-in either via registration call, or opt-in form.

• Add new double opt-in options to the Contact.registerEmail interface
• Add new double opt-in options to the Opt-in Forms Plugin

This release has no backward-incompatible changes; when these options are not specified, behavior is identical to the previous release.

This release adds a number of new features, and deprecates some existing ones. No code changes will be necessary in your existing integrations, but for new or updated integrations it’s recommended that you use the new APIs.

Contact

The new Contact interface replaces the existing UaSDK.Channel.NamedUser API, providing the following benefits:

• Tags and attributes may be set at any time, before the user is given a name; the data you set will be carried over to a new named user once identified
• A more consistent experience for users of our iOS/Android SDKs
• Register and associate email/sms/open channels with the current contact

Note: you should not use the deprecated NamedUser SDK APIs and the new Contact simultaneously, or you may have unexpected behaviors.

Preference Centers

New SDK APIs allow you to implement preference centers on your website, see the topic guide for further information.

• UaSDK.preferenceCenters for retrieving preference center definitions for your application.
• PreferenceCenter for data formats
• UaSDK.Channel.subscriptions for managing and retrieving a channel’s subscription list membership

Note: Preference Centers are only available if your plan has access to this feature.

Opt-In Forms

A new plugin has been added which provides a pre-made form for registering email and SMS channels on your website. For additional information, see the plugin documentation.

Note: Opt-In Forms are only available if your plan has access to this feature.

• Add support for AMP websites

• Improvement: Allow passing query parameters in the service-worker URL

Minor release:

• add locale override support

Minor release:

• Add support for Yandex browser
• Fix a regression on Safari

Minor release including:

• Add data collection handling to match mobile SDK
• Internal changes to prevent flooding the backend (channel events capping, named user debouncing)

Patch release:

• make the unsupported-browser error catchable using UA.catch()
• fix default positioning of HTML prompt alert template to top when incorrect or not defined

Minor release for web notification button support and a bug fix for named users.

• Added support for displaying buttons in web notification
• Fixed bug where clicking a web notification could remove named user from the channel

Minor release introducing a new plugin framework, and two plugins to make user acquisition easier.

Changes

• Introduced a new plugin framework
• Added customizable HTML prompt plugin
• Added registration page plugin