Releases: Iterable/iterable-web-sdk
Releases · Iterable/iterable-web-sdk
v1.1.0
What's Changed
- [MOB-8539]: Embedded GA by @mprew97 in #381
- This release brings GA support for Embedded Messaging to Iterable's Web SDK, including support for out-of-the-box views (cards, notifications, and banners), along with an
IterableEmbeddedSessionManager
class that can be used to track sessions and impressions. - Documentation for this release is coming soon.
- There are various breaking changes between the beta and GA releases. If you're updating from the beta version of Iterable's Web SDK that supports Embedded Messaging, update and test thoroughly to make sure that messages display, events are tracked, and all behavior works as expected.
- Updates to the
EmbeddedManager
class, which is now calledIterableEmbeddedManager
:- When instantiating this class, pass in your app's package name.
trackEmbeddedClick
is now a standalone import (no longer on the embedded manager):export const trackEmbeddedClick = (payload: IterableEmbeddedClickRequestPayload)
- The signature for
syncMessages
has changed to:syncMessages(packageName: string, callback: () => void, placementIds?: number[]): Promise<void>
- The signature for
getMessages()
has changed to:getMessages(): IterableEmbeddedMessage[]
- The signature for
getMessagesForPlacement()
has changed to:getMessagesForPlacement(placementId: number): IterableEmbeddedMessage[]
- The signature for
addUpdateListener
has changed to:addUpdateListener(updateListener: IterableEmbeddedMessageUpdateHandler): void
- The signature for
getUpdateHandlers
has changed to:getUpdateHandlers(): IterableEmbeddedMessageUpdateHandler[]
handleEmbeddedMessageClick
has been changed toclick
:click(clickedUrl: string | null): void
- Call this method to pass click to your URL and custom action handlers, as defined on
IterableConfig
- Various types have been renamed.
- For example (not an exhaustive list):
EmbeddedManager
is nowIterableEmbeddedManager
IEmbeddedMessage
is nowIterableEmbeddedMessage
EmbeddedMessageUpdateHandler
is nowIterableEmbeddedMessageUpdateHandler
- For more details, see #365.
- For example (not an exhaustive list):
- Updates to the
- This release brings GA support for Embedded Messaging to Iterable's Web SDK, including support for out-of-the-box views (cards, notifications, and banners), along with an
initializeWithConfig
README updates by @mprew97 in #401- Updates the README to more accurately document
initializeWithConfig
.
- Updates the README to more accurately document
- [QAE-1182] Initial Playwright install by @jyu115 in #396
- Adds the Playwright testing framework as a dev dependency.
Full Changelog: v1.0.11...v1.1.0
v1.0.11
What's Changed
Updates
- [MOB-8649]: New SDK configuration options:
isEuIterableService
,dangerouslyAllowJsPopupsSDK
by @mprew97 in #398dangerouslyAllowJsPopupsSDK
replaces environment variableDANGEROUSLY_ALLOW_JS_POPUP_EXECUTION
. The SDK no longer supports the environment variable.isEuIterableService
is an alternative to environment variableIS_EU_ITERABLE_SERVICE
, which is still available.
Full Changelog: v1.0.10...v1.0.11
v1.0.10
What's Changed
Fixes
- tech: Update EXAMPLE_APP & Typescript fixes by @hectorleiva in #375
- Resolves some TypeScript errors
- [MOB-8515]: allow-popups-to-escape-sandbox by @mprew97 in #380
- Provides a way for Safari to open in-app message link clicks in a clean browsing context, so JavaScript can run as necessary. For more information, see the SDK README.
- [MOB-8397] replace with commit hash and update to latest releases by @jyu115 in #366
- [MOB-8552]: Release 1.0.10 by @mprew97 in #389
Updates
- Dependency version bumps
- Bump follow-redirects from 1.14.8 to 1.15.6 in /example by @dependabot in #322
- Bump follow-redirects from 1.14.9 to 1.15.6 in /react-example by @dependabot in #324
- Bump follow-redirects from 1.14.9 to 1.15.6 by @dependabot in #325
- Bump webpack-dev-middleware from 5.3.0 to 5.3.4 in /example by @dependabot in #336
- Bump webpack-dev-middleware from 5.3.0 to 5.3.4 by @dependabot in #337
- Bump webpack-dev-middleware from 5.3.0 to 5.3.4 in /react-example by @dependabot in #338
- Bump express from 4.18.2 to 4.19.2 in /example by @dependabot in #347
- Bump express from 4.18.2 to 4.19.2 by @dependabot in #348
- Bump express from 4.18.2 to 4.19.2 in /react-example by @dependabot in #349
- Bump ip from 1.1.5 to 1.1.9 in /react-example by @dependabot in #352
Full Changelog: v1.0.9...v1.0.10
v1.1.1-beta
What's Changed
Fixes
- [MOB-8430]: Add /messages to interceptor routes for userId by @mprew97 in #370
- Fixes a problem that prevented the SDK from fetching embedded messages for users identified by userId
Full Changelog: v1.0.9...v1.1.1-beta
v1.0.9
v1.1.0-beta
What's Changed
Added
This beta release of Iterable's Web SDK includes support for Embedded Messages. Embedded Messages are eligibility-based messages sent from Iterable to your mobile apps and websites. You can display them inline, using whatever interface you like — no pop-ups or overlays necessary!
If you'd like to try using Embedded Messages with Iterable's Web SDK, talk to your Iterable customer success manager.
Full Changelog: v1.0.8...v1.1.0-beta
v1.0.8
What's Changed
Fixes
- [MOB-7682] README update: iOS browser handling by @ts-nguyen in #300
- [MOB-7613][MOB-7390] Fix iframe height setter and update vulnerable dependencies by @pauljung14 in #303
- [MOB-7921] Bump version to 1.0.8 by @jyu115 in #313
New Contributors
Full Changelog: v1.0.7...v1.0.8
v1.0.7
v1.0.6
v1.0.5
What's Changed
Fixes
- update read me for close button by @mprew97 in #209
- [MOB-6374]: import docs discrepancy by @mprew97 in #211
- [MOB-5933]: EU Domain Configuration by @mprew97 in #199
- EUDC instructions by @bradumbaugh in #224
- [MOB-6617]: EUDC Release Cut by @mprew97 in #225
Full Changelog: v1.0.4...v1.0.5