Adds params to PaywallInfo

Author: yusuftor

CHANGELOG.md

@@ -7,6 +7,7 @@ The changelog for `SuperwallKit`. Also see the [releases](https://github.com/sup
 ### Enhancements
 
 - Updates Superscript to 0.2.4.
+- Adds the `params` passed in when presenting the paywall to `PaywallInfo`.
 
 ## 4.0.6
 

Sources/SuperwallKit/Models/Paywall/Paywall.swift

@@ -101,6 +101,9 @@ struct Paywall: Codable {
   /// user does not purchase.
   var featureGating: FeatureGatingBehavior
 
+  /// The parameters passed to present the paywall.
+  var params: JSON
+
   /// The local notifications for the paywall, e.g. to notify the user of free trial expiry.
   var localNotifications: [LocalNotification]
 
@@ -141,6 +144,7 @@ struct Paywall: Codable {
     case surveys
     case manifest
     case isScrollEnabled
+    case params
 
     case responseLoadStartTime
     case responseLoadCompleteTime
@@ -255,6 +259,9 @@ struct Paywall: Codable {
 
     manifest = try values.decodeIfPresent(ArchiveManifest.self, forKey: .manifest)
     isScrollEnabled = try values.decodeIfPresent(Bool.self, forKey: .isScrollEnabled) ?? true
+
+    // Not encoding/decoding because this can change whenever the paywall is presented.
+    params = [:]
   }
 
   func encode(to encoder: Encoder) throws {
@@ -345,7 +352,8 @@ struct Paywall: Codable {
     computedPropertyRequests: [ComputedPropertyRequest] = [],
     surveys: [Survey] = [],
     manifest: ArchiveManifest? = nil,
-    isScrollEnabled: Bool
+    isScrollEnabled: Bool,
+    params: JSON
   ) {
     self.databaseId = databaseId
     self.identifier = identifier
@@ -378,6 +386,7 @@ struct Paywall: Codable {
     self.surveys = surveys
     self.manifest = manifest
     self.isScrollEnabled = isScrollEnabled
+    self.params = params
   }
 
   func getInfo(fromPlacement: PlacementData?) -> PaywallInfo {
@@ -412,7 +421,8 @@ struct Paywall: Codable {
       computedPropertyRequests: computedPropertyRequests,
       surveys: surveys,
       presentation: presentation,
-      isScrollEnabled: isScrollEnabled
+      isScrollEnabled: isScrollEnabled,
+      params: params.dictionaryValue
     )
   }
 
@@ -424,6 +434,7 @@ struct Paywall: Codable {
     presentationSourceType = paywall.presentationSourceType
     experiment = paywall.experiment
     featureGating = paywall.featureGating
+    params = paywall.params
   }
 }
 
@@ -463,7 +474,8 @@ extension Paywall: Stubbable {
       productsLoadingInfo: .init(),
       shimmerLoadingInfo: .init(),
       paywalljsVersion: "",
-      isScrollEnabled: true
+      isScrollEnabled: true,
+      params: [:]
     )
   }
 }

Sources/SuperwallKit/Paywall/Presentation/PaywallInfo.swift

@@ -128,6 +128,11 @@ public final class PaywallInfo: NSObject {
   /// Indicates whether scrolling of the webview is enabled.
   public let isScrollEnabled: Bool
 
+  /// The parameters passed to ``Superwall/register(event:params:)`` or
+  /// ``Superwall/getPaywall(forEvent:params:paywallOverrides:delegate:)``
+  /// when presenting the paywall.
+  public let params: [String: Any]
+
   init(
     databaseId: String,
     identifier: String,
@@ -159,7 +164,8 @@ public final class PaywallInfo: NSObject {
     computedPropertyRequests: [ComputedPropertyRequest],
     surveys: [Survey],
     presentation: PaywallPresentationInfo,
-    isScrollEnabled: Bool
+    isScrollEnabled: Bool,
+    params: [String: Any]
   ) {
     self.databaseId = databaseId
     self.identifier = identifier
@@ -181,6 +187,7 @@ public final class PaywallInfo: NSObject {
     self.computedPropertyRequests = computedPropertyRequests
     self.surveys = surveys
     self.presentation = presentation
+    self.params = params
 
     if placementData != nil {
       self.presentedBy = "placement"
@@ -261,6 +268,10 @@ public final class PaywallInfo: NSObject {
       "is_scroll_enabled": isScrollEnabled as Any
     ]
 
+    for (key, value) in params {
+      output["params_\(key)"] = value
+    }
+
     var loadingVars: [String: Any] = [:]
     for key in output.keys {
       if key.contains("_load_"),
@@ -368,7 +379,8 @@ extension PaywallInfo: Stubbable {
         style: .none,
         delay: 0
       ),
-      isScrollEnabled: true
+      isScrollEnabled: true,
+      params: [:]
     )
   }
 
@@ -416,7 +428,8 @@ extension PaywallInfo: Stubbable {
         style: .none,
         delay: 0
       ),
-      isScrollEnabled: true
+      isScrollEnabled: true,
+      params: [:]
     )
   }
 }

Sources/SuperwallKit/Paywall/Request/PaywallRequestManager.swift

@@ -105,6 +105,7 @@ actor PaywallRequestManager {
     if let featureGating = request.overrides.featureGatingBehavior {
       paywall.featureGating = featureGating
     }
+    paywall.params = request.placementData?.parameters ?? [:]
     return paywall
   }