Skip to content

v1.1.0

Compare
Choose a tag to compare
@mprew97 mprew97 released this 12 Jun 21:33
· 35 commits to main since this release
63ce723

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 called IterableEmbeddedManager:
        • 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 to click:
          • 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 now IterableEmbeddedManager
          • IEmbeddedMessage is now IterableEmbeddedMessage
          • EmbeddedMessageUpdateHandler is now IterableEmbeddedMessageUpdateHandler
        • For more details, see #365.
  • initializeWithConfig README updates by @mprew97 in #401
    • Updates the README to more accurately document initializeWithConfig.
  • [QAE-1182] Initial Playwright install by @jyu115 in #396
    • Adds the Playwright testing framework as a dev dependency.
  • [MOB-8854]: Prepublish checks and fixes by @mprew97 in #408

Full Changelog: v1.0.11...v1.1.0