ChangeLog

BlazeStoryCtaStyle

Added

• Property: layoutPositioning

  • Description: Defines the layout positioning style of the CTA (Call to Action).
  • Type: CTAPositioning
  • Default Value: .ctaNextToShare (if not specified)

• Enum: CTAPositioning

  • Description: Enumeration to specify the positioning of the CTA button.
  • Values:
    • ctaNextToShare: Indicates the CTA is positioned next to the Share button.
    • ctaBellowShare: Indicates the CTA is positioned below the Share button.

BlazeMomentsAppearance Gradient Structures - Breaking changes

Modified

• Properties in BlazeMomentsAppearance
  • Change: Updated types of headerGradient and footerGradient properties.
  • Old Types: BlazeMomentsGradient
  • New Types:
    • headerGradient: BlazeMomentsHeaderGradient
    • footerGradient: BlazeMomentsFooterGradient

Removed

• Structure: BlazeMomentsGradient
  • Description: This struct represented the gradient configuration for moments view. It is now replaced by two specific structures for header and footer.

Added

• Structure: BlazeMomentsHeaderGradient

  • Description: Represents the gradient configuration for the moments view header.
  • Properties:
    • isVisible: Bool
    • startColor: UIColor
    • endColor: UIColor
  • Initializer: Same as in the old BlazeMomentsGradient struct.
  • Extension Function: static func headerGradient() -> BlazeMomentsHeaderGradient

• Structure: BlazeMomentsFooterGradient

  • Description: Represents the gradient configuration for the moments view footer.
  • Properties:
    • isVisible: Bool
    • startColor: UIColor
    • endColor: UIColor
    • endPositioning: EndPositioning
  • New Property: endPositioning
    • Description: Defines the end positioning of the gradient.
    • Type: EndPositioning enum
  • Initializer: Extended to include endPositioning.
  • Enum: EndPositioning
    • Values:
      • bottomToContainer: Gradient's bottom starts from the bottom of the container.
      • bottomToPlayer: Gradient's bottom starts from the bottom of the player.

BlazeStoryAppearance structure - Breaking changes

Modified

• Property in BlazeStoryAppearance
  • Change: Updated the type of lastUpdate property.
  • Old Type: BlazeStoryText
  • New Type: BlazeStoryLastUpdateText

Added

• Structure: BlazeStoryLastUpdateText

  • Description: Represents the style and appearance of last update text used in a story player.
  • Properties:
    • font: UIFont
    • textColor: UIColor
    • textCase: BlazeTextCase
  • Default Value: .lowercase for textCase

• Enum: BlazeTextCase

  • Description: Represents the various text case styles.
  • Values:
    • uppercase: All letters are capitalized.
    • lowercase: All letters are in small form.

BlazeSDKDelegate - Breaking changes

Modified

• Change in Method: onEventTriggered
  • Old Signature:
    • func onEventTriggered(eventType: BlazeAnalytics.EventType, eventData: BlazeAnalytics.EventData)
    • Parameters:
      • eventType: Type of the event from BlazeAnalytics.EventType.
      • eventData: Data of the event from BlazeAnalytics.EventData.
  • New Signature:
    • func onEventTriggered(eventData: BlazeAnalytics)
    • Parameter:
      • eventData: Consolidated event data from BlazeAnalytics.

Contextual Notes

• This modification simplifies the event triggering mechanism within the SDK.
• The new method signature consolidates the event type and data into a single BlazeAnalytics parameter, streamlining the interface.
• This change may affect all implementations of the BlazeSDKDelegate protocol, requiring updates to conform to the new method signature.

BlazeAnalytics Struct - Breaking changes

Overview

• Significant updates have been made to the BlazeAnalytics struct. These changes include modifications to properties, methods, and overall structure.

Key Changes

• Properties: Several properties have been added, removed, or modified to better align with the analytics requirements.
• Structural Changes: Adjustments in the overall structure for more efficient data handling and integration with other components.

Detailed Documentation

For a complete and detailed overview of all the changes, enhancements, and their implications, please refer to the updated documentation:

• README

Important Notes

• Due to the extensive nature of these changes, it is recommended to review the documentation thoroughly to understand the impact on existing implementations.

Renaming of Enums, Structs, and Protocols - Breaking changes

Overview

• As part of the ongoing improvements and standardization in the SDK, several enums, structs, and protocols have been renamed. These changes are intended to bring more clarity and consistency to the SDK's naming conventions.

Renamed Components

Enums

• Old Name: CachePolicyLevel

  • New Name: BlazeCachePolicyLevel
  • Impact: Update references to this enum throughout your codebase to use the new name.

• Old Name: ProgressType

  • New Name: BlazeProgressType
  • Impact: Update references to this enum throughout your codebase to use the new name.

• Old Name: OrderType

  • New Name: BlazeOrderType
  • Impact: Update references to this enum throughout your codebase to use the new name.

Struct

• Old Name: CTAAction
  • New Name: BlazeCTAAction
  • Impact: Update references to this struct throughout your codebase to use the new name.

Protocol

• Old Name: WidgetDelegate
  • New Name: BlazeWidgetDelegate
  • Impact: Update references to this protocol throughout your codebase to use the new name.

Important Notes

• These renamings are part of a broader effort to standardize naming across the SDK.
• It's crucial to update your code to reflect these changes to ensure compatibility with the latest version of the SDK.
• No functional changes have been made to these components, only their names have been updated.