Version 7.1.0

braze-inc · Oct 23, 2023 · d2b2407 · d2b2407
1 parent f36aac0
commit d2b2407
Show file tree

Hide file tree

Showing 25 changed files with 178 additions and 62 deletions.
diff --git a/BrazeKit.podspec b/BrazeKit.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name              = 'BrazeKit'
-  s.version           = '7.0.0'
+  s.version           = '7.1.0'
   s.summary           = 'Braze Main SDK library providing support for analytics and push notifications.'
 
   s.homepage          = 'https://braze.com'
@@ -9,8 +9,8 @@ Pod::Spec.new do |s|
   s.authors           = 'Braze, Inc.'
 
   s.source            = {
-    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazeKit.zip',
-    :sha256 => 'ae890a450e889ad57399b36835af98699defc02da2fff9bd1756b8963d545eb5'
+    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazeKit.zip',
+    :sha256 => '195f3f728352a8fb507256042be3cb4efc9bd46afb76d57353e5951ed501d267'
   }
 
   s.swift_version           = '5.0'

diff --git a/BrazeKitCompat.podspec b/BrazeKitCompat.podspec
@@ -1,14 +1,14 @@
 Pod::Spec.new do |s|
   s.name              = 'BrazeKitCompat'
-  s.version           = '7.0.0'
+  s.version           = '7.1.0'
   s.summary           = 'Compatibility library for users migrating from AppboyKit.'
 
   s.homepage          = 'https://braze.com'
   s.documentation_url = 'https://braze-inc.github.io/braze-swift-sdk/documentation/brazekitcompat/'
   s.license           = { :type => 'Commercial' }
   s.authors           = 'Braze, Inc.'
 
-  s.source            = { :git => 'https://github.com/braze-inc/braze-swift-sdk.git', :tag => '7.0.0' }
+  s.source            = { :git => 'https://github.com/braze-inc/braze-swift-sdk.git', :tag => '7.1.0' }
 
   s.swift_version           = '5.0'
   s.ios.deployment_target   = '11.0'
@@ -18,8 +18,8 @@ Pod::Spec.new do |s|
   s.source_files            = 'Sources/BrazeKitCompat/**/*.{h,m}'
   s.public_header_files     = 'Sources/BrazeKitCompat/include/*.h'
 
-  s.dependency 'BrazeKit', '7.0.0'
-  s.dependency 'BrazeLocation', '7.0.0'
+  s.dependency 'BrazeKit', '7.1.0'
+  s.dependency 'BrazeLocation', '7.1.0'
 
   s.pod_target_xcconfig     = { 'DEFINES_MODULE' => 'YES' }
 end
diff --git a/BrazeLocation.podspec b/BrazeLocation.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name              = 'BrazeLocation'
-  s.version           = '7.0.0'
+  s.version           = '7.1.0'
   s.summary           = 'Braze location library providing support for location analytics and geofence monitoring.'
 
   s.homepage          = 'https://braze.com'
@@ -9,8 +9,8 @@ Pod::Spec.new do |s|
   s.authors           = 'Braze, Inc.'
 
   s.source            = {
-    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazeLocation.zip',
-    :sha256 => 'eb32a3834e0dc09df3c069647b6ac1e1fbce5cb1fed49050325277e12c7773cd'
+    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazeLocation.zip',
+    :sha256 => '9ce1f72d725cb37b4c509fc84766e6eaf07429bce4e7164481833843003c2987'
   }
 
   s.swift_version           = '5.0'
@@ -21,7 +21,7 @@ Pod::Spec.new do |s|
 
   # Depends on BrazeKit because BrazeKit includes the internal _BrazeLocationClient symbols required
   # for linking against BrazeLocation.
-  s.dependency 'BrazeKit', '7.0.0'
+  s.dependency 'BrazeKit', '7.1.0'
 
   s.pod_target_xcconfig     = { 'DEFINES_MODULE' => 'YES' }
 end
diff --git a/BrazeNotificationService.podspec b/BrazeNotificationService.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name              = 'BrazeNotificationService'
-  s.version           = '7.0.0'
+  s.version           = '7.1.0'
   s.summary           = 'Braze notification service extension library providing support for Rich Push notifications.'
 
   s.homepage          = 'https://braze.com'
@@ -9,8 +9,8 @@ Pod::Spec.new do |s|
   s.authors           = 'Braze, Inc.'
 
   s.source            = {
-    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazeNotificationService.zip',
-    :sha256 => 'ebf1ca2501212501853662a3853b498063a3f2b46ae2de072262666c4f731e24'
+    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazeNotificationService.zip',
+    :sha256 => 'e80f97bb21bc9f661471205c18f8f873f274bc3cad73b2eb44e4f1f66f05dd10'
   }
 
   s.swift_version           = '5.0'

diff --git a/BrazePushStory.podspec b/BrazePushStory.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name              = 'BrazePushStory'
-  s.version           = '7.0.0'
+  s.version           = '7.1.0'
   s.summary           = 'Braze notification content extension library providing support for Push Stories.'
 
   s.homepage          = 'https://braze.com'
@@ -9,8 +9,8 @@ Pod::Spec.new do |s|
   s.authors           = 'Braze, Inc.'
 
   s.source            = {
-    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazePushStory.zip',
-    :sha256 => '26e3ff1284d14a2d2c7c9d02ee08745bc0babd662ed5067b306ff8aa90d4bb3d'
+    :http => 'https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazePushStory.zip',
+    :sha256 => '4ad33d8106c285b3e33c274cfee112542a489abf8284eff330dab12c49766c16'
   }
 
   s.swift_version           = '5.0'

diff --git a/BrazeUI.podspec b/BrazeUI.podspec
@@ -1,14 +1,14 @@
 Pod::Spec.new do |s|
   s.name              = 'BrazeUI'
-  s.version           = '7.0.0'
+  s.version           = '7.1.0'
   s.summary           = 'Braze-provided user interface library for In-App Messages and Content Cards.'
 
   s.homepage          = 'https://braze.com'
   s.documentation_url = 'https://braze-inc.github.io/braze-swift-sdk/documentation/brazeui/'
   s.license           = { :type => 'Commercial' }
   s.authors           = 'Braze, Inc.'
 
-  s.source            = { :git => 'https://github.com/braze-inc/braze-swift-sdk.git', :tag => '7.0.0' }
+  s.source            = { :git => 'https://github.com/braze-inc/braze-swift-sdk.git', :tag => '7.1.0' }
 
   s.swift_version           = '5.0'
   s.ios.deployment_target   = '11.0'
@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
   s.source_files            = 'Sources/BrazeUI/**/*.swift'
   s.resource_bundles        = { 'BrazeUI' => ['Sources/BrazeUI/Resources/**/*'] }
 
-  s.dependency 'BrazeKit', '7.0.0'
+  s.dependency 'BrazeKit', '7.1.0'
 
   s.pod_target_xcconfig     = { 'DEFINES_MODULE' => 'YES' }
 end
diff --git a/BrazeUICompat.podspec b/BrazeUICompat.podspec
@@ -1,14 +1,14 @@
 Pod::Spec.new do |s|
   s.name              = 'BrazeUICompat'
-  s.version           = '7.0.0'
+  s.version           = '7.1.0'
   s.summary           = 'Compatibility UI library for users migrating from AppboyUI.'
 
   s.homepage          = 'https://braze.com'
   s.documentation_url = 'https://braze-inc.github.io/braze-swift-sdk/documentation/brazeui/'
   s.license           = { :type => 'Commercial' }
   s.authors           = 'Braze, Inc.'
 
-  s.source            = { :git => 'https://github.com/braze-inc/braze-swift-sdk.git', :tag => '7.0.0' }
+  s.source            = { :git => 'https://github.com/braze-inc/braze-swift-sdk.git', :tag => '7.1.0' }
 
   s.swift_version           = '5.0'
   s.ios.deployment_target   = '11.0'
@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
   s.public_header_files     = 'Sources/BrazeUICompat/ABK*/**/*.h'
   s.resource_bundles        = { 'BrazeUICompat' => 'Sources/BrazeUICompat/*/Resources/**/*.*' }
 
-  s.dependency 'BrazeKitCompat', '7.0.0'
+  s.dependency 'BrazeKitCompat', '7.1.0'
   s.dependency 'SDWebImage', '>= 5.8.2', '< 6'
 
   s.user_target_xcconfig    = { 'CLANG_ALLOW_NON_MODULAR_INCLUDES_IN_FRAMEWORK_MODULES' => 'YES' }

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,21 +1,34 @@
+## 7.1.0
+
+##### Fixed
+- Resolves an issue preventing templated in-app messages from triggering if a previous attempt to display the message failed within the same session.
+- Fixes an issue that prevented custom events and nested custom attributes from logging if had a property with a value that was prefixed with a `$`.
+- Fixes a bug in the Content Cards feed UI where the empty feed message would not display when the user only had control cards in their feed.
+- Adds additional safeguards when reading the device model.
+
+##### Added
+- Adds a code signature to all XCFrameworks in the Braze Swift SDK, signed by `Braze, Inc.`.
+- `BrazeInAppMessageUI.DisplayChoice.later` has been deprecated in favor of `BrazeInAppMessageUI.DisplayChoice.reenqueue`.
+
 ## 7.0.0
 
 ##### Breaking
 - The `useUUIDAsDeviceId` configuration is now enabled by default.
-  - For more details on the impacts, refer to this [Collecting IDFV - Swift](https://www.braze.com/docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/other_sdk_customizations/swift_idfv/).
+  - For more details on the impacts, refer to this [Collecting IDFV - Swift](https://www.braze.com/docs/developer_guide/platform_integration_guides/swift/analytics/swift_idfv/).
 - The `Banner` Content Card type and corresponding UI elements have been renamed to `ImageOnly`. All member methods and properties remain the same.
   - `Braze.ContentCard.Banner` → `Braze.ContentCard.ImageOnly`
   - `BrazeContentCardUI.BannerCell` → `BrazeContentCardUI.ImageOnlyCell`
 - Refactors some text layout logic in BrazeUI into a new `Braze.ModalTextView` class.
 - Updates the behavior for Feature Flags methods.
   - `FeatureFlags.featureFlag(id:)` now returns `nil` for an ID that does not exist.
   - `FeatureFlags.subscribeToUpdates(:)` will trigger the callback when any refresh request completes with a success or failure.
-    - The callback will also trigger immediately upon initial subscription if previously cached data exists.
+    - The callback will also trigger immediately upon initial subscription if previously cached data exists from the current session.
 
 ##### Fixed
 - Fixes compiler warnings about Swift 6 when compiling `BrazeUI` while using Xcode 15.
 - Exposes public imports for `ABKClassicImageContentCardCell.h` and `ABKControlTableViewCell.h` for use in the BrazeUICompat layer.
-- Adds additional safeguards around invalid constraint values for `BrazeInAppMessageUI.SlideupView`
+- Adds additional safeguards around invalid constraint values for `BrazeInAppMessageUI.SlideupView`.
+- Resolves a Content Cards feed UI issue displaying a placeholder image in Classic cards without an attached image.
 
 ##### Added
 - Adds the `enableDarkTheme` property to `BrazeContentCardUI.ViewController.Attributes`.

diff --git a/Examples/ObjC/Sources/PushNotifications/Info.plist b/Examples/ObjC/Sources/PushNotifications/Info.plist
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleDisplayName</key>
+	<string>PushNotifications</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>UIBackgroundModes</key>
+	<array>
+		<string>remote-notification</string>
+	</array>
+	<key>UILaunchStoryboardName</key>
+	<string>LaunchScreen</string>
+</dict>
+</plist>
diff --git a/Examples/ObjC/Sources/PushNotifications/PushNotifications.entitlements b/Examples/ObjC/Sources/PushNotifications/PushNotifications.entitlements
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>aps-environment</key>
+	<string>development</string>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>group.com.braze.PushNotifications.PushStories</string>
+	</array>
+</dict>
+</plist>
diff --git a/Examples/ObjC/manual-integration-setup.sh b/Examples/ObjC/manual-integration-setup.sh
@@ -20,7 +20,7 @@ if [ ! -f "manual-integration-setup.sh" ]; then
 fi
 
 # Constants
-url="https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/braze-swift-sdk-prebuilt.zip"
+url="https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/braze-swift-sdk-prebuilt.zip"
 
 echo "→" "Cleaning up"
 rm -rf braze-swift-sdk-prebuilt

diff --git a/Examples/Swift/Sources/PushNotifications/Info.plist b/Examples/Swift/Sources/PushNotifications/Info.plist
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleDisplayName</key>
+	<string>PushNotifications</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>UIBackgroundModes</key>
+	<array>
+		<string>remote-notification</string>
+	</array>
+	<key>UILaunchStoryboardName</key>
+	<string>LaunchScreen</string>
+</dict>
+</plist>
diff --git a/Examples/Swift/Sources/PushNotifications/PushNotifications.entitlements b/Examples/Swift/Sources/PushNotifications/PushNotifications.entitlements
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>aps-environment</key>
+	<string>development</string>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>group.com.braze.PushNotifications.PushStories</string>
+	</array>
+</dict>
+</plist>
diff --git a/Examples/Swift/manual-integration-setup.sh b/Examples/Swift/manual-integration-setup.sh
@@ -20,7 +20,7 @@ if [ ! -f "manual-integration-setup.sh" ]; then
 fi
 
 # Constants
-url="https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/braze-swift-sdk-prebuilt.zip"
+url="https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/braze-swift-sdk-prebuilt.zip"
 
 echo "→" "Cleaning up"
 rm -rf braze-swift-sdk-prebuilt

diff --git a/Package.swift b/Package.swift
@@ -47,8 +47,8 @@ let package = Package(
   targets: [
     .binaryTarget(
       name: "BrazeKit",
-      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazeKit.zip",
-      checksum: "ae890a450e889ad57399b36835af98699defc02da2fff9bd1756b8963d545eb5"
+      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazeKit.zip",
+      checksum: "195f3f728352a8fb507256042be3cb4efc9bd46afb76d57353e5951ed501d267"
     ),
     .target(
       name: "BrazeKitResources",
@@ -65,18 +65,18 @@ let package = Package(
     ),
     .binaryTarget(
       name: "BrazeLocation",
-      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazeLocation.zip",
-      checksum: "eb32a3834e0dc09df3c069647b6ac1e1fbce5cb1fed49050325277e12c7773cd"
+      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazeLocation.zip",
+      checksum: "9ce1f72d725cb37b4c509fc84766e6eaf07429bce4e7164481833843003c2987"
     ),
     .binaryTarget(
       name: "BrazeNotificationService",
-      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazeNotificationService.zip",
-      checksum: "ebf1ca2501212501853662a3853b498063a3f2b46ae2de072262666c4f731e24"
+      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazeNotificationService.zip",
+      checksum: "e80f97bb21bc9f661471205c18f8f873f274bc3cad73b2eb44e4f1f66f05dd10"
     ),
     .binaryTarget(
       name: "BrazePushStory",
-      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.0.0/BrazePushStory.zip",
-      checksum: "26e3ff1284d14a2d2c7c9d02ee08745bc0babd662ed5067b306ff8aa90d4bb3d"
+      url: "https://github.com/braze-inc/braze-swift-sdk/releases/download/7.1.0/BrazePushStory.zip",
+      checksum: "4ad33d8106c285b3e33c274cfee112542a489abf8284eff330dab12c49766c16"
     ),
     .target(
       name: "BrazeKitCompat",

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 <p align="center">
   <a href="https://github.com/braze-inc/braze-swift-sdk/releases">
-    <img src="https://badgen.net/badge/version/7.0.0/blue" alt="Version: 7.0.0">
+    <img src="https://badgen.net/badge/version/7.1.0/blue" alt="Version: 7.1.0">
   </a>
   <a href="#">
     <img src="https://badgen.net/badge/platforms/iOS%20%7C%20tvOS%20%7C%20Mac%20Catalyst/orange"

diff --git a/Sources/BrazeKitCompat/AppboyKit/ABKInAppMessageController.m b/Sources/BrazeKitCompat/AppboyKit/ABKInAppMessageController.m
@@ -182,7 +182,7 @@ - (NSNumber *)_compat_beforeInAppMessageDisplayed:
   switch (displayChoice) {
   case ABKDisplayInAppMessageNow:
     return @YES;
-  case ABKDisplayInAppMessageLater:
+  case ABKReenqueueInAppMessage:
     [self tryPushOnStack:message];
     return @NO;
   case ABKDiscardInAppMessage:

diff --git a/Sources/BrazeKitCompat/include/ABKInAppMessageController.h b/Sources/BrazeKitCompat/include/ABKInAppMessageController.h
@@ -62,7 +62,7 @@ BRZ_DEPRECATED("renamed to 'BrazeInAppMessageUI' (BrazeUI module)")
  * displayNextInAppMessageWithDelegate: at to display it. If an in-app message is currently being displayed, it will not be included
  * in the count.
  *
- * Note: Returning ABKDisplayInAppMessageLater in the beforeInAppMessageDisplayed: delegate method will put the in-app message back onto
+ * Note: Returning ABKReenqueueInAppMessage in the beforeInAppMessageDisplayed: delegate method will put the in-app message back onto
  * the stack and this will be reflected in inAppMessagesRemainingOnStack.
  */
 - (NSInteger)inAppMessagesRemainingOnStack;