4.1.0 Release | Badge Count | New API revision

Examples/KlaviyoSwiftExamples/CocoapodsExample/CocoapodsExample/Info.plist

@@ -2,6 +2,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>klaviyo_app_group</key>
+	<string>group.$(PRODUCT_BUNDLE_IDENTIFIER).shared</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 </dict>

Examples/KlaviyoSwiftExamples/CocoapodsExample/NotificationServiceExtension/Info.plist

@@ -2,6 +2,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>klaviyo_app_group</key>
+	<string>group.$(PRODUCT_BUNDLE_IDENTIFIER).shared</string>
 	<key>NSExtension</key>
 	<dict>
 		<key>NSExtensionPointIdentifier</key>

Examples/KlaviyoSwiftExamples/SPMExample/NotificationServiceExtension/Info.plist

@@ -2,6 +2,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>klaviyo_app_group</key>
+	<string>group.$(PRODUCT_BUNDLE_IDENTIFIER).shared</string>
 	<key>NSExtension</key>
 	<dict>
 		<key>NSExtensionPointIdentifier</key>

Examples/KlaviyoSwiftExamples/SPMExample/SPMExample/Info.plist

@@ -2,6 +2,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>klaviyo_app_group</key>
+	<string>group.$(PRODUCT_BUNDLE_IDENTIFIER).shared</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleURLTypes</key>

Examples/KlaviyoSwiftExamples/Shared/Info.plist

@@ -2,6 +2,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>klaviyo_app_group</key>
+	<string>group.$(PRODUCT_BUNDLE_IDENTIFIER).shared</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>

KlaviyoCore.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "KlaviyoCore"
-  s.version          = "0.1.0"
+  s.version          = "4.1.0-alpha.1"
   s.summary          = "Core functionalities for the Klaviyo SDK"
   s.description      = <<-DESC
                         Core functionalities and utilities for the Klaviyo SDK.

KlaviyoSwift.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "KlaviyoSwift"
-  s.version          = "4.0.0"
+  s.version          = "4.1.0-alpha.1"
   s.summary          = "Incorporate Klaviyo's event and person tracking and push notifications functionality into iOS applications"
 
   s.description      = <<-DESC
@@ -16,6 +16,6 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = '13.0'
   s.source_files = 'Sources/KlaviyoSwift/**/*.swift'
   s.resource_bundles = {"KlaviyoSwift" => ["Sources/KlaviyoSwift/PrivacyInfo.xcprivacy"]}
-  s.dependency     'KlaviyoCore', '~> 0.1.0'
+  s.dependency     'KlaviyoCore', '~> 4.1.0-alpha.1'
   s.dependency     'AnyCodable-FlightSchool'
 end

KlaviyoSwiftExtension.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "KlaviyoSwiftExtension"
-  s.version          = "4.0.0"
+  s.version          = "4.1.0-alpha.1"
   s.summary          = "Incorporate Klaviyo's rich push notifications functionality into your iOS applications"
 
   s.description      = <<-DESC

README.md

@@ -22,9 +22,12 @@
   - [Receiving Push Notifications](#receiving-push-notifications)
     - [Tracking Open Events](#tracking-open-events)
     - [Deep Linking](#deep-linking)
-      - [Option 1: URL Schemes](#option-1-URL-schemes)
+      - [Option 1: URL Schemes](#option-1-url-schemes)
       - [Option 2: Universal Links](#option-2-universal-links)
     - [Rich Push](#rich-push)
+    - [Badge Count](#badge-count)
+         - [Autoclearing](#autoclearing)
+      - [Handling Other Badging Sources](#handling-other-badging-sources)
 - [Additional Details](#additional-details)
   - [Sandbox Support](#sandbox-support)
   - [SDK Data Transfer](#sdk-data-transfer)
@@ -43,7 +46,7 @@ Once integrated, your marketing team will be able to better understand your app
 ## Installation
 
 1. Enable push notification capabilities in your Xcode project. The section "Enable the push notification capability" in this [Apple developer guide](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns#2980170) provides detailed instructions.
-2. [Optional but recommended] If you intend to use [rich push notifications](#rich-push) add a [Notification service extension](https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension) to your xcode project. A notification service app extension ships as a separate bundle inside your iOS app. To add this extension to your app:
+2. If you intend to use [rich push notifications](#rich-push) or [custom badge counts](#custom-badge-count) add a [Notification Service Extension](https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension) to your Xcode project. A Notification Service Extension ships as a separate bundle inside your iOS app. To add this extension to your app:
    - Select File > New > Target in Xcode.
    - Select the Notification Service Extension target from the iOS > Application extension section.
    - Click Next.
@@ -54,6 +57,15 @@ Once integrated, your marketing team will be able to better understand your app
              If this exceeds your app's minimum supported iOS version, push notifications may not display attached media on older devices.
              To avoid this, ensure the extension's minimum deployment target matches that of your app. ⚠️
 
+    Set up an App Group between your main app target and your Notification Service Extension.
+    - Select your main app target > Signing & Capabilities
+    - Select + Capability (make sure it is set to All not Debug or Release) > App Groups
+    - Create a new App Group based on the recommended naming scheme `group.com.[MainTargetBundleId].[descriptor]`
+    - In your app's `Info.plist`, add a new entry for `klaviyo_app_group` as a String with the App Group name
+    - Select your Notification Service Extension target > Signing & Capabilities
+    - Add an App Group with the same name as the main target's App Group
+    - In your Notification Service Extension's `Info.plist`, add a new entry for `klaviyo_app_group` as a String with the App Group name
+
 3. Based on which dependency manager you use, follow the instructions below to install the Klaviyo's dependencies.
 
       <details>
@@ -91,7 +103,7 @@ Once integrated, your marketing team will be able to better understand your app
       </details>
 
 4. Finally, in the `NotificationService.swift` file add the code for the two required delegates from [this](Examples/KlaviyoSwiftExamples/SPMExample/NotificationServiceExtension/NotificationService.swift) file.
-  This sample covers calling into Klaviyo so that we can download and attach the media to the push notification.
+  This sample covers calling into Klaviyo so that we can download and attach the media to the push notification as well as handle custom badge counts.
 
 ## Initialization
 The SDK must be initialized with the short alphanumeric [public API key](https://help.klaviyo.com/hc/en-us/articles/115005062267#difference-between-public-and-private-api-keys1)
@@ -249,24 +261,24 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
     UIApplication.shared.registerForRemoteNotifications()
 
     let center = UNUserNotificationCenter.current()
-	center.delegate = self as? UNUserNotificationCenterDelegate // the type casting can be removed once the delegate has been implemented
-	let options: UNAuthorizationOptions = [.alert, .sound, .badge]
-	// use the below options if you are interested in using provisional push notifications. Note that using this will not
-	// show the push notifications prompt to the user.
-	// let options: UNAuthorizationOptions = [.alert, .sound, .badge, .provisional]
-	center.requestAuthorization(options: options) { granted, error in
-	    if let error = error {
-	        // Handle the error here.
-	        print("error = ", error)
-	    }
-
-	    // Irrespective of the authorization status call `registerForRemoteNotifications` here so that
-	    // the `didRegisterForRemoteNotificationsWithDeviceToken` delegate is called. Doing this
-	    // will make sure that Klaviyo always has the latest push authorization status.
+    center.delegate = self as? UNUserNotificationCenterDelegate // the type casting can be removed once the delegate has been implemented
+    let options: UNAuthorizationOptions = [.alert, .sound, .badge]
+    // use the below options if you are interested in using provisional push notifications. Note that using this will not
+    // show the push notifications prompt to the user.
+    // let options: UNAuthorizationOptions = [.alert, .sound, .badge, .provisional]
+    center.requestAuthorization(options: options) { granted, error in
+        if let error = error {
+            // Handle the error here.
+            print("error = ", error)
+        }
+
+        // Irrespective of the authorization status call `registerForRemoteNotifications` here so that
+        // the `didRegisterForRemoteNotificationsWithDeviceToken` delegate is called. Doing this
+        // will make sure that Klaviyo always has the latest push authorization status.
             DispatchQueue.main.async {
                 UIApplication.shared.registerForRemoteNotifications()
             }
-	}
+    }
 
     return true
 }
@@ -310,44 +322,6 @@ extension AppDelegate: UNUserNotificationCenterDelegate {
     }
 }
 ```
-When tracking opened push notification, you can also decrement the badge count on the app icon by adding the following code to the `userNotificationCenter:didReceive:withCompletionHandler` method:
-
-```swift
-    func userNotificationCenter(
-        _ center: UNUserNotificationCenter,
-        didReceive response: UNNotificationResponse,
-        withCompletionHandler completionHandler: @escaping () -> Void) {
-        // decrement the badge count on the app icon
-        if #available(iOS 16.0, *) {
-            UNUserNotificationCenter.current().setBadgeCount(UIApplication.shared.applicationIconBadgeNumber - 1)
-        } else {
-            UIApplication.shared.applicationIconBadgeNumber -= 1
-        }
-
-        // If this notification is Klaviyo's notification we'll handle it
-        // else pass it on to the next push notification service to which it may belong
-        let handled = KlaviyoSDK().handle(notificationResponse: response, withCompletionHandler: completionHandler)
-        if !handled {
-            completionHandler()
-        }
-    }
-```
-
-Additionally, if you just want to reset the badge count to zero when the app is opened(note that this could be from
-the user just opening the app independent of the push message), you can add the following code to
-the `applicationDidBecomeActive` method in the app delegate:
-
-```swift
-
-func applicationDidBecomeActive(_ application: UIApplication) {
-    // reset the badge count on the app icon
-    if #available(iOS 16.0, *) {
-        UNUserNotificationCenter.current().setBadgeCount(0)
-    } else {
-        UIApplication.shared.applicationIconBadgeNumber = 0
-    }
-}
-```
 
 Once your first push notifications are sent and opened, you should start to see _Opened Push_ metrics within your Klaviyo dashboard.
 
@@ -384,16 +358,16 @@ In order to edit the Info.plist directly, just fill in your app specific details
 ```xml
 <key>CFBundleURLTypes</key>
 <array>
-	<dict>
-		<key>CFBundleTypeRole</key>
-		<string>Editor</string>
-		<key>CFBundleURLName</key>
-		<string>{your_unique_identifier}</string>
-		<key>CFBundleURLSchemes</key>
-		<array>
-			<string>{your_URL_scheme}</string>
-		</array>
-	</dict>
+    <dict>
+        <key>CFBundleTypeRole</key>
+        <string>Editor</string>
+        <key>CFBundleURLName</key>
+        <string>{your_unique_identifier}</string>
+        <key>CFBundleURLSchemes</key>
+        <array>
+            <string>{your_URL_scheme}</string>
+        </array>
+    </dict>
 </array>
 ```
 
@@ -406,7 +380,7 @@ This needs to be done in the Info.plist directly:
 ```xml
 <key>LSApplicationQueriesSchemes</key>
 <array>
-	<string>{your custom URL scheme}</string>
+    <string>{your custom URL scheme}</string>
 </array>
 ```
 
@@ -516,11 +490,24 @@ project setup with the code from the `KlaviyoSwiftExtension`. Below are instruct
 
 Once you have these three things, you can then use the push notifications tester and send a local push notification to make sure that everything was set up correctly.
 
+#### Badge Count
+>  ℹ️ Setting or incrementing the badge count is available in SDK version [4.1.0](https://github.com/klaviyo/klaviyo-swift-sdk/releases/tag/4.1.0) and higher
+
+Klaviyo supports setting or incrementing the badge count when you send a push notification. For this functionality to work, you must set up the Notification Service Extension and an App Group as outlined under the [Installation](#installation) section.
+
+##### Autoclearing
+
+By default, the Klaviyo SDK automatically clears the badge count on app open. If you want to disable this behavior, add a new entry for `klaviyo_badge_autoclearing` as a Boolean set to `NO` in your app's `Info.plist`. You can re-enable automatically clearing badges by setting this value to `YES`.
+
+##### Handling Other Badging Sources
+
+Klaviyo SDK will automatically handle the badge count associated with Klaviyo pushes. If you need to manually update the badge count to account for other notification sources, use the `KlaviyoSDK().setBadgeCount(:)` method, which will update the badge count and keep it in sync with the Klaviyo SDK. This method should be used instead of (rather than in addition to) setting the badge count using `UNUserNotificationCenter` and/or `UIApplication` methods.
+
 ## Additional Details
 
 ### Sandbox Support
 
-> ℹ️ Sandbox support is available in SDK version 2.2.0 and higher
+> ℹ️ Sandbox support is available in SDK version [2.2.0](https://github.com/klaviyo/klaviyo-swift-sdk/releases/tag/2.2.0) and higher
 
 Apple has two environments with push notification support - Production and Sandbox.
 The Production environment supports sending push notifications to real users when an app is published in the App Store or TestFlight.

Sources/KlaviyoCore/KlaviyoEnvironment.swift

@@ -22,6 +22,7 @@ public struct KlaviyoEnvironment {
         notificationCenterPublisher: @escaping (NSNotification.Name) -> AnyPublisher<Notification, Never>,
         getNotificationSettings: @escaping () async -> PushEnablement,
         getBackgroundSetting: @escaping () -> PushBackground,
+        getBadgeAutoClearingSetting: @escaping () async -> Bool,
         startReachability: @escaping () throws -> Void,
         stopReachability: @escaping () -> Void,
         reachabilityStatus: @escaping () -> Reachability.NetworkStatus?,
@@ -48,6 +49,7 @@ public struct KlaviyoEnvironment {
         self.notificationCenterPublisher = notificationCenterPublisher
         self.getNotificationSettings = getNotificationSettings
         self.getBackgroundSetting = getBackgroundSetting
+        self.getBadgeAutoClearingSetting = getBadgeAutoClearingSetting
         self.startReachability = startReachability
         self.stopReachability = stopReachability
         self.reachabilityStatus = reachabilityStatus
@@ -94,6 +96,7 @@ public struct KlaviyoEnvironment {
     public var notificationCenterPublisher: (NSNotification.Name) -> AnyPublisher<Notification, Never>
     public var getNotificationSettings: () async -> PushEnablement
     public var getBackgroundSetting: () -> PushBackground
+    public var getBadgeAutoClearingSetting: () async -> Bool
 
     public var startReachability: () throws -> Void
     public var stopReachability: () -> Void
@@ -118,9 +121,7 @@ public struct KlaviyoEnvironment {
     public var sdkName: () -> String
     public var sdkVersion: () -> String
 
-    private static let rnSDKConfig: [String: AnyObject] = {
-        loadPlist(named: "klaviyo-react-native-sdk-configuration") ?? [:]
-    }()
+    private static let rnSDKConfig: [String: AnyObject] = loadPlist(named: "klaviyo-sdk-configuration") ?? [:]
 
     private static func getSDKName() -> String {
         if let sdkName = KlaviyoEnvironment.rnSDKConfig["react_native_sdk_name"] as? String {
@@ -150,7 +151,12 @@ public struct KlaviyoEnvironment {
             let notificationSettings = await UNUserNotificationCenter.current().notificationSettings()
             return PushEnablement.create(from: notificationSettings.authorizationStatus)
         },
-        getBackgroundSetting: { .create(from: UIApplication.shared.backgroundRefreshStatus) },
+        getBackgroundSetting: {
+            .create(from: UIApplication.shared.backgroundRefreshStatus)
+        },
+        getBadgeAutoClearingSetting: {
+            Bundle.main.object(forInfoDictionaryKey: "klaviyo_badge_autoclearing") as? Bool ?? true
+        },
         startReachability: {
             try reachabilityService?.startNotifier()
         },

Sources/KlaviyoCore/Networking/NetworkSession.swift

@@ -28,14 +28,14 @@ public struct NetworkSession {
         self.data = data
     }
 
-    fileprivate static let currentApiRevision = "2023-07-15"
+    fileprivate static let currentApiRevision = "2024-10-15"
     fileprivate static let applicationJson = "application/json"
     fileprivate static let acceptedEncodings = ["br", "gzip", "deflate"]
     fileprivate static let mobileHeader = "1"
 
     public static let defaultUserAgent = { () -> String in
         let appContext = environment.appContextInfo()
-        let klaivyoSDKVersion = "klaviyo-ios/\(environment.sdkVersion())"
+        let klaivyoSDKVersion = "klaviyo-\(environment.sdkName())/\(environment.sdkVersion())"
         return "\(appContext.executable)/\(appContext.appVersion) (\(appContext.bundleId); build:\(appContext.appBuild); \(appContext.osVersionName)) \(klaivyoSDKVersion)"
     }()
 

Sources/KlaviyoCore/Utils/Version.swift

@@ -8,4 +8,4 @@
 import Foundation
 
 public let __klaviyoSwiftName = "swift"
-public let __klaviyoSwiftVersion = "4.0.0"
+public let __klaviyoSwiftVersion = "4.1.0-alpha.1"

Sources/KlaviyoSwift/Klaviyo.swift

@@ -83,6 +83,13 @@ public struct KlaviyoSDK {
         dispatchOnMainThread(action: .resetProfile)
     }
 
+    /// Sets the badge number on the application icon. Syncs with the persisted count
+    /// stored in the User Defaults suite set up with the App Group. Used to set the badge count
+    /// to 0 when autoclearing is turned on (in the plist). Can be called otherwise as well.
+    public func setBadgeCount(_ count: Int) {
+        dispatchOnMainThread(action: .setBadgeCount(count))
+    }
+
     /// Set the current user's email.
     /// - Parameter email: a string contining the users email.
     /// - Returns: a KlaviyoSDK instance
@@ -171,9 +178,9 @@ public struct KlaviyoSDK {
                     completionHandler()
                 }
             }
-
             return true
         }
+        dispatchOnMainThread(action: .syncBadgeCount)
         return false
     }
 }