-
Notifications
You must be signed in to change notification settings - Fork 22
/
Paywall.swift
391 lines (337 loc) · 12.8 KB
/
Paywall.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
//
// Paywall.swift
// Superwall
//
// Created by Yusuf Tör on 28/02/2022.
//
// swiftlint:disable function_body_length type_body_length
import UIKit
struct Paywalls: Decodable {
var paywalls: [Paywall]
}
struct Paywall: Decodable {
/// The id of the paywall in the database.
var databaseId: String
/// The identifier of the paywall
var identifier: String
/// The name of the paywall
let name: String
/// The URL of the paywall webpage
let url: URL
/// Contains the website modifications that are made on the paywall editor to be accepted
/// by the webview.
let htmlSubstitutions: String
struct Presentation {
var style: PaywallPresentationStyle = .modal
let condition: PresentationCondition
let delay: Int
init(
style: PaywallPresentationStyle,
condition: PresentationCondition,
delay: Int
) {
self.style = style
self.condition = condition
self.delay = delay
}
}
let presentation: Presentation
let backgroundColorHex: String
let backgroundColor: UIColor
let computedPropertyRequests: [ComputedPropertyRequest]
/// Indicates whether the caching of the paywall is enabled or not.
let onDeviceCache: OnDeviceCaching
/// A surveys to potentially show when an action happens in the paywall.
var surveys: [Survey]
/// The products associated with the paywall.
var products: [Product]
/// An ordered list of products associated with the paywall.
var productItems: [ProductItem] {
didSet {
productIds = productItems.map { $0.id }
products = Self.makeProducts(from: productItems)
}
}
var responseLoadingInfo: LoadingInfo
var webviewLoadingInfo: LoadingInfo
var productsLoadingInfo: LoadingInfo
// MARK: - Added by client
/// An array of the ids of paywall products.
///
/// This is set on init and whenever products are updated.
var productIds: [String]
/// The experiment associated with the paywall.
var experiment: Experiment?
/// The trigger session ID associated with the paywall.
var triggerSessionId: String?
/// A list of SWProducts that this paywall uses. This is accessed by the trigger session.
var swProducts: [SWProduct]? = []
/// An list of product attributes associated with the paywall.
///
/// Each contains a product type and their attributes.
var productVariables: [ProductVariable]? = []
/// The paywall.js version being used. Added when the website fires `onReady`.
var paywalljsVersion: String?
/// Determines whether a free trial is available or not.
var isFreeTrialAvailable = false
/// The source of the presentation request. Either 'implicit', 'getPaywall', 'register'.
var presentationSourceType: String?
/// The reason for closing the paywall.
var closeReason: PaywallCloseReason = .none
/// Determines whether a paywall executes the
/// ``Superwall/register(event:params:handler:feature:)`` feature block if the
/// user does not purchase.
var featureGating: FeatureGatingBehavior
/// The local notifications for the paywall, e.g. to notify the user of free trial expiry.
var localNotifications: [LocalNotification]
// A listing of all the filtes referenced in a paywall
// to be able to preload the whole paywall into a web archive
var manifest: ArchivalManifest?
enum CodingKeys: String, CodingKey {
case id
case identifier
case name
case url
case htmlSubstitutions = "paywalljsEvent"
case presentationStyle = "presentationStyleV2"
case presentationCondition
case presentationDelay
case backgroundColorHex
case productItems = "productsV2"
case featureGating
case onDeviceCache
case localNotifications
case computedPropertyRequests = "computedProperties"
case surveys
case manifest
case responseLoadStartTime
case responseLoadCompleteTime
case responseLoadFailTime
case webViewLoadStartTime
case webViewLoadCompleteTime
case webViewLoadFailTime
case productsLoadStartTime
case productsLoadCompleteTime
case productsLoadFailTime
}
init(from decoder: Decoder) throws {
let values = try decoder.container(keyedBy: CodingKeys.self)
databaseId = try values.decode(String.self, forKey: .id)
identifier = try values.decode(String.self, forKey: .identifier)
name = try values.decode(String.self, forKey: .name)
url = try values.decode(URL.self, forKey: .url)
htmlSubstitutions = try values.decode(String.self, forKey: .htmlSubstitutions)
let throwableSurveys = try values.decodeIfPresent(
[Throwable<Survey>].self,
forKey: .surveys
) ?? []
surveys = throwableSurveys.compactMap { try? $0.result.get() }
let presentationStyle = try values.decode(PaywallPresentationStyle.self, forKey: .presentationStyle)
let presentationCondition = try values.decode(PresentationCondition.self, forKey: .presentationCondition)
let presentationDelay = try values.decode(Int.self, forKey: .presentationDelay)
presentation = Presentation(
style: presentationStyle,
condition: presentationCondition,
delay: presentationDelay
)
backgroundColorHex = try values.decode(String.self, forKey: .backgroundColorHex)
let backgroundColor = UIColor(hexString: backgroundColorHex)
self.backgroundColor = backgroundColor
let appStoreProductItems = try values.decodeIfPresent(
[Throwable<ProductItem>].self,
forKey: .productItems
) ?? []
productItems = appStoreProductItems.compactMap { try? $0.result.get() }
productIds = productItems.map { $0.id }
products = Self.makeProducts(from: productItems)
let responseLoadStartTime = try values.decodeIfPresent(Date.self, forKey: .responseLoadStartTime)
let responseLoadCompleteTime = try values.decodeIfPresent(Date.self, forKey: .responseLoadCompleteTime)
let responseLoadFailTime = try values.decodeIfPresent(Date.self, forKey: .responseLoadFailTime)
responseLoadingInfo = LoadingInfo(
startAt: responseLoadStartTime,
endAt: responseLoadCompleteTime,
failAt: responseLoadFailTime
)
let webviewLoadStartTime = try values.decodeIfPresent(Date.self, forKey: .webViewLoadStartTime)
let webviewLoadCompleteTime = try values.decodeIfPresent(Date.self, forKey: .webViewLoadCompleteTime)
let webviewLoadFailTime = try values.decodeIfPresent(Date.self, forKey: .webViewLoadFailTime)
webviewLoadingInfo = LoadingInfo(
startAt: webviewLoadStartTime,
endAt: webviewLoadCompleteTime,
failAt: webviewLoadFailTime
)
let productsLoadStartTime = try values.decodeIfPresent(Date.self, forKey: .productsLoadStartTime)
let productsLoadCompleteTime = try values.decodeIfPresent(Date.self, forKey: .productsLoadCompleteTime)
let productsLoadFailTime = try values.decodeIfPresent(Date.self, forKey: .productsLoadFailTime)
productsLoadingInfo = LoadingInfo(
startAt: productsLoadStartTime,
endAt: productsLoadCompleteTime,
failAt: productsLoadFailTime
)
featureGating = try values.decodeIfPresent(FeatureGatingBehavior.self, forKey: .featureGating) ?? .nonGated
onDeviceCache = try values.decodeIfPresent(OnDeviceCaching.self, forKey: .onDeviceCache) ?? .disabled
let throwableNotifications = try values.decodeIfPresent(
[Throwable<LocalNotification>].self,
forKey: .localNotifications
) ?? []
localNotifications = throwableNotifications.compactMap { try? $0.result.get() }
let throwableComputedPropertyRequests = try values.decodeIfPresent(
[Throwable<ComputedPropertyRequest>].self,
forKey: .computedPropertyRequests
) ?? []
computedPropertyRequests = throwableComputedPropertyRequests.compactMap { try? $0.result.get() }
manifest = try? values.decodeIfPresent(ArchivalManifest.self, forKey: .manifest)
}
private static func makeProducts(from productItems: [ProductItem]) -> [Product] {
var output: [Product] = []
for productItem in productItems {
if productItem.name == "primary" {
output.append(
Product(type: .primary, id: productItem.id)
)
} else if productItem.name == "secondary" {
output.append(
Product(type: .secondary, id: productItem.id)
)
} else if productItem.name == "tertiary" {
output.append(
Product(type: .tertiary, id: productItem.id)
)
}
}
return output
}
// Only used in stub
private init(
databaseId: String,
identifier: String,
name: String,
experiment: Experiment? = nil,
triggerSessionId: String? = nil,
url: URL,
htmlSubstitutions: String,
presentation: Paywall.Presentation,
backgroundColorHex: String,
backgroundColor: UIColor,
productItems: [ProductItem],
productIds: [String],
responseLoadingInfo: LoadingInfo,
webviewLoadingInfo: LoadingInfo,
productsLoadingInfo: LoadingInfo,
paywalljsVersion: String,
swProducts: [SWProduct]? = [],
productVariables: [ProductVariable]? = [],
isFreeTrialAvailable: Bool = false,
presentationSourceType: String? = nil,
featureGating: FeatureGatingBehavior = .nonGated,
onDeviceCache: OnDeviceCaching = .disabled,
localNotifications: [LocalNotification] = [],
computedPropertyRequests: [ComputedPropertyRequest] = [],
surveys: [Survey] = [],
manifest: ArchivalManifest? = nil
) {
self.databaseId = databaseId
self.identifier = identifier
self.name = name
self.experiment = experiment
self.triggerSessionId = triggerSessionId
self.url = url
self.htmlSubstitutions = htmlSubstitutions
self.presentation = presentation
self.backgroundColor = backgroundColor
self.backgroundColorHex = backgroundColorHex
self.productItems = productItems
self.productIds = productIds
self.responseLoadingInfo = responseLoadingInfo
self.webviewLoadingInfo = webviewLoadingInfo
self.productsLoadingInfo = productsLoadingInfo
self.paywalljsVersion = paywalljsVersion
self.swProducts = swProducts
self.productVariables = productVariables
self.isFreeTrialAvailable = isFreeTrialAvailable
self.presentationSourceType = presentationSourceType
self.featureGating = featureGating
self.onDeviceCache = onDeviceCache
self.localNotifications = localNotifications
self.computedPropertyRequests = computedPropertyRequests
self.surveys = surveys
self.products = Self.makeProducts(from: productItems)
self.manifest = manifest
}
func getInfo(
fromEvent: EventData?,
factory: TriggerSessionManagerFactory
) -> PaywallInfo {
return PaywallInfo(
databaseId: databaseId,
identifier: identifier,
name: name,
url: url,
products: products,
productItems: productItems,
productIds: productIds,
fromEventData: fromEvent,
responseLoadStartTime: responseLoadingInfo.startAt,
responseLoadCompleteTime: responseLoadingInfo.endAt,
responseLoadFailTime: responseLoadingInfo.failAt,
webViewLoadStartTime: webviewLoadingInfo.startAt,
webViewLoadCompleteTime: webviewLoadingInfo.endAt,
webViewLoadFailTime: webviewLoadingInfo.failAt,
productsLoadStartTime: productsLoadingInfo.startAt,
productsLoadFailTime: productsLoadingInfo.failAt,
productsLoadCompleteTime: productsLoadingInfo.endAt,
experiment: experiment,
triggerSessionId: triggerSessionId,
paywalljsVersion: paywalljsVersion,
isFreeTrialAvailable: isFreeTrialAvailable,
presentationSourceType: presentationSourceType,
factory: factory,
featureGatingBehavior: featureGating,
closeReason: closeReason,
localNotifications: localNotifications,
computedPropertyRequests: computedPropertyRequests,
surveys: surveys
)
}
mutating func update(from paywall: Paywall) {
productItems = paywall.productItems
swProducts = paywall.swProducts
productVariables = paywall.productVariables
isFreeTrialAvailable = paywall.isFreeTrialAvailable
productsLoadingInfo = paywall.productsLoadingInfo
presentationSourceType = paywall.presentationSourceType
experiment = paywall.experiment
}
}
// MARK: - Equatable
extension Paywall: Equatable {
static func == (lhs: Paywall, rhs: Paywall) -> Bool {
return lhs.databaseId == rhs.databaseId
}
}
// swiftlint:disable force_unwrapping
// MARK: - Stubbable
extension Paywall: Stubbable {
static func stub() -> Paywall {
return Paywall(
databaseId: "id",
identifier: "identifier",
name: "abc",
url: URL(string: "https://google.com")!,
htmlSubstitutions: "",
presentation: Presentation(
style: .modal,
condition: .checkUserSubscription,
delay: 0
),
backgroundColorHex: "",
backgroundColor: .black,
productItems: [],
productIds: [],
responseLoadingInfo: .init(),
webviewLoadingInfo: .init(),
productsLoadingInfo: .init(),
paywalljsVersion: ""
)
}
}