feat: add event sending

Sources/SuperwallKit/Analytics/Internal Tracking/Trackable Events/TrackableSuperwallEvent.swift

@@ -468,6 +468,43 @@ enum InternalSuperwallEvent {
     }
   }
 
+  struct PaywallPageView: TrackableSuperwallEvent {
+    var superwallEvent: SuperwallEvent {
+      return .paywallPageView(paywallInfo: paywallInfo)
+    }
+    let paywallInfo: PaywallInfo
+    let pageNodeId: String
+    let flowPosition: Int
+    let pageName: String
+    let navigationNodeId: String
+    let previousPageNodeId: String?
+    let previousFlowPosition: Int?
+    let navigationType: String
+    let timeOnPreviousPageMs: Int?
+
+    func getSuperwallParameters() async -> [String: Any] {
+      var params = await paywallInfo.placementParams()
+      params["page_node_id"] = pageNodeId
+      params["flow_position"] = flowPosition
+      params["page_name"] = pageName
+      params["navigation_node_id"] = navigationNodeId
+      params["navigation_type"] = navigationType
+      if let previousPageNodeId = previousPageNodeId {
+        params["previous_page_node_id"] = previousPageNodeId
+      }
+      if let previousFlowPosition = previousFlowPosition {
+        params["previous_flow_position"] = previousFlowPosition
+      }
+      if let timeOnPreviousPageMs = timeOnPreviousPageMs {
+        params["time_on_previous_page_ms"] = timeOnPreviousPageMs
+      }
+      return params
+    }
+    var audienceFilterParams: [String: Any] {
+      return paywallInfo.audienceFilterParams()
+    }
+  }
+
   struct PaywallClose: TrackableSuperwallEvent {
     var superwallEvent: SuperwallEvent {
       return .paywallClose(paywallInfo: paywallInfo)

Sources/SuperwallKit/Analytics/Superwall Placement/SuperwallEvent.swift

@@ -281,6 +281,9 @@ public enum SuperwallEvent {
   /// When the test mode modal is closed.
   case testModeModalClose
 
+  /// When a user navigates to a page in a multi-page paywall.
+  case paywallPageView(paywallInfo: PaywallInfo)
+
   var canImplicitlyTriggerPaywall: Bool {
     switch self {
     case .appInstall,
@@ -478,6 +481,8 @@ extension SuperwallEvent {
       return .init(objcEvent: .testModeModalOpen)
     case .testModeModalClose:
       return .init(objcEvent: .testModeModalClose)
+    case .paywallPageView:
+      return .init(objcEvent: .paywallPageView)
     }
   }
 }

Sources/SuperwallKit/Analytics/Superwall Placement/SuperwallEventObjc.swift

@@ -257,6 +257,9 @@ public enum SuperwallEventObjc: Int, CaseIterable {
   /// When the test mode modal is closed.
   case testModeModalClose
 
+  /// When a user navigates to a page in a multi-page paywall.
+  case paywallPageView
+
   public init(event: SuperwallEvent) {
     self = event.backingData.objcEvent
   }
@@ -419,6 +422,8 @@ public enum SuperwallEventObjc: Int, CaseIterable {
       return "testModeModal_open"
     case .testModeModalClose:
       return "testModeModal_close"
+    case .paywallPageView:
+      return "paywall_page_view"
     }
   }
 }

Sources/SuperwallKit/Models/Paywall/Paywall.swift

@@ -82,6 +82,10 @@ struct Paywall: Codable {
 
   // MARK: - Added by client
 
+  /// A unique identifier for this paywall presentation, used to correlate all events
+  /// within a single presentation lifecycle.
+  var presentationId: String?
+
   var responseLoadingInfo: LoadingInfo
   var webviewLoadingInfo: LoadingInfo
   var shimmerLoadingInfo: LoadingInfo
@@ -424,6 +428,7 @@ struct Paywall: Codable {
       url: url,
       products: products,
       productIds: productIds,
+      presentationId: presentationId,
       fromPlacementData: fromPlacement,
       responseLoadStartTime: responseLoadingInfo.startAt,
       responseLoadCompleteTime: responseLoadingInfo.endAt,
@@ -460,6 +465,7 @@ struct Paywall: Codable {
     presentationSourceType = paywall.presentationSourceType
     experiment = paywall.experiment
     featureGating = paywall.featureGating
+    presentationId = paywall.presentationId
   }
 }
 

Sources/SuperwallKit/Paywall/Presentation/PaywallInfo.swift

@@ -135,6 +135,10 @@ public final class PaywallInfo: NSObject {
   /// `.automatic`.
   public let introOfferEligibility: IntroOfferEligibility
 
+  /// A unique identifier for this paywall presentation, used to correlate all events
+  /// within a single presentation lifecycle.
+  public let presentationId: String?
+
   init(
     databaseId: String,
     identifier: String,
@@ -144,6 +148,7 @@ public final class PaywallInfo: NSObject {
     url: URL,
     products: [Product],
     productIds: [String],
+    presentationId: String?,
     fromPlacementData placementData: PlacementData?,
     responseLoadStartTime: Date?,
     responseLoadCompleteTime: Date?,
@@ -182,6 +187,7 @@ public final class PaywallInfo: NSObject {
     self.presentationSourceType = presentationSourceType
     self.experiment = experiment
     self.paywalljsVersion = paywalljsVersion
+    self.presentationId = presentationId
     self.products = products
     self.productIds = productIds
     self.isFreeTrialAvailable = isFreeTrialAvailable
@@ -271,7 +277,8 @@ public final class PaywallInfo: NSObject {
       "close_reason": closeReason.description,
       "is_scroll_enabled": isScrollEnabled as Any,
       "intro_offer_eligibility": introOfferEligibility.description,
-      "app_transaction_id": ReceiptManager.appTransactionId as Any
+      "app_transaction_id": ReceiptManager.appTransactionId as Any,
+      "presentation_id": presentationId as Any
     ]
 
     var loadingVars: [String: Any] = [:]
@@ -356,6 +363,7 @@ extension PaywallInfo: Stubbable {
       url: URL(string: "https://superwall.com")!,
       products: [],
       productIds: [],
+      presentationId: nil,
       fromPlacementData: nil,
       responseLoadStartTime: nil,
       responseLoadCompleteTime: nil,
@@ -398,6 +406,7 @@ extension PaywallInfo: Stubbable {
       url: URL(string: "https://superwall.com")!,
       products: [],
       productIds: [],
+      presentationId: nil,
       fromPlacementData: nil,
       responseLoadStartTime: nil,
       responseLoadCompleteTime: nil,

Sources/SuperwallKit/Paywall/Request/Operators/RawPaywallResponse.swift

@@ -15,7 +15,8 @@ extension PaywallRequestManager {
       paywallId: request.responseIdentifiers.paywallId,
       placement: request.placementData
     )
-    let paywall = try await getPaywallResponse(from: request)
+    var paywall = try await getPaywallResponse(from: request)
+    paywall.presentationId = UUID().uuidString
 
     let paywallInfo = paywall.getInfo(fromPlacement: request.placementData)
     await trackResponseLoaded(

Sources/SuperwallKit/Paywall/View Controller/Web View/Message Handling/PaywallMessage.swift

@@ -74,6 +74,17 @@ enum PaywallMessage: Decodable, Equatable {
     variables: JSON?
   )
   case hapticFeedback(hapticType: String)
+  // swiftlint:disable:next enum_case_associated_values_count
+  case pageView(
+    pageNodeId: String,
+    flowPosition: Int,
+    pageName: String,
+    navigationNodeId: String,
+    previousPageNodeId: String?,
+    previousFlowPosition: Int?,
+    type: String,
+    timeOnPreviousPageMs: Int?
+  )
 
   // All cases below here are sent from device to paywall
   case paywallClose
@@ -121,6 +132,7 @@ enum PaywallMessage: Decodable, Equatable {
     case requestPermission = "request_permission"
     case requestCallback = "request_callback"
     case hapticFeedback = "haptic_feedback"
+    case pageView = "page_view"
   }
 
   // Everyone write to eventName, other may use the remaining keys
@@ -149,6 +161,13 @@ enum PaywallMessage: Decodable, Equatable {
     case behavior
     case variables
     case hapticType
+    case pageNodeId
+    case flowPosition
+    case pageName
+    case navigationNodeId
+    case previousPageNodeId
+    case previousFlowPosition
+    case timeOnPreviousPageMs
   }
 
   enum PaywallMessageError: Error {
@@ -310,6 +329,26 @@ enum PaywallMessage: Decodable, Equatable {
           self = .hapticFeedback(hapticType: hapticType)
           return
         }
+      case .pageView:
+        let pageNodeId = try values.decode(String.self, forKey: .pageNodeId)
+        let flowPosition = try values.decode(Int.self, forKey: .flowPosition)
+        let pageName = try values.decode(String.self, forKey: .pageName)
+        let navigationNodeId = try values.decode(String.self, forKey: .navigationNodeId)
+        let previousPageNodeId = try? values.decode(String.self, forKey: .previousPageNodeId)
+        let previousFlowPosition = try? values.decode(Int.self, forKey: .previousFlowPosition)
+        let type = try values.decode(String.self, forKey: .type)
+        let timeOnPreviousPageMs = try? values.decode(Int.self, forKey: .timeOnPreviousPageMs)
+        self = .pageView(
+          pageNodeId: pageNodeId,
+          flowPosition: flowPosition,
+          pageName: pageName,
+          navigationNodeId: navigationNodeId,
+          previousPageNodeId: previousPageNodeId,
+          previousFlowPosition: previousFlowPosition,
+          type: type,
+          timeOnPreviousPageMs: timeOnPreviousPageMs
+        )
+        return
       }
     }
 

Sources/SuperwallKit/Paywall/View Controller/Web View/Message Handling/PaywallMessageHandler.swift

@@ -255,6 +255,23 @@
       )
     case .hapticFeedback(let hapticType):
       triggerHapticFeedback(hapticType)
+    case let .pageView(pageNodeId, flowPosition, pageName, navigationNodeId, previousPageNodeId, previousFlowPosition, type, timeOnPreviousPageMs):
+      guard let delegate = delegate else { return }
+      let paywallInfo = delegate.info
+      Task {
+        let event = InternalSuperwallEvent.PaywallPageView(
+          paywallInfo: paywallInfo,
+          pageNodeId: pageNodeId,
+          flowPosition: flowPosition,
+          pageName: pageName,
+          navigationNodeId: navigationNodeId,
+          previousPageNodeId: previousPageNodeId,
+          previousFlowPosition: previousFlowPosition,
+          navigationType: type,
+          timeOnPreviousPageMs: timeOnPreviousPageMs
+        )
+        await Superwall.shared.track(event)
+      }
     }
   }
 
@@ -414,7 +431,7 @@
       // block selection
       let selectionString =
         // swiftlint:disable:next line_length
         "var css = '*{-webkit-touch-callout:none;-webkit-user-select:none} .w-webflow-badge { display: none !important; }'; "
         + "var head = document.head || document.getElementsByTagName('head')[0]; "
         + "var style = document.createElement('style'); style.type = 'text/css'; "
         + "style.appendChild(document.createTextNode(css)); head.appendChild(style); "