DIA-2030 add support to USNat

.github/workflows/swift.yml

@@ -92,7 +92,7 @@ jobs:
           if: failure()
           name: Upload NativePMExampleApp tests results
           with:
-            path: /Users/runner/Library/Developer/Xcode/DerivedData/**/*.xcresult 
+            path: /Users/runner/Library/Developer/Xcode/DerivedData/**/*.xcresult
   # MetaApp:
   #     runs-on: macos-12
   #     steps:
@@ -105,4 +105,4 @@ jobs:
   #         if: failure()
   #         name: Upload SourcePointMetaApp tests results
   #         with:
-  #           path: /Users/runner/Library/Developer/Xcode/DerivedData/**/*.xcresult         
+  #           path: /Users/runner/Library/Developer/Xcode/DerivedData/**/*.xcresult

ConsentViewController/Assets/javascript/SPJSReceiver.js

@@ -42,7 +42,7 @@ var getActionFromMessage = function (eventData) {
     return {
         id: String(choiceData.choice_id),
         type: choiceData.type,
-        pm_url: choiceData.iframe_url,
+        pmUrl: choiceData.pmUrl || choiceData.iframe_url,
         consentLanguage: eventData.consentLanguage,
         customActionId: choiceData.customAction
     };
@@ -66,7 +66,8 @@ var handleMessageEvent = function(SDK) {
                         type: eventData.actionType,
                         payload: eventData.payload,
                         consentLanguage: eventData.consentLanguage,
-                        customActionId: eventData.customAction
+                        customActionId: eventData.customAction,
+                        pmUrl: eventData.pmUrl
                     }) :
                     SDK.onAction(getActionFromMessage(eventData));
                 break;
@@ -107,7 +108,8 @@ var handleMessageOrPMEvent = function (SDK) {
                 actionType: data.actionType,
                 payload: data.payload || data.actions || {},
                 consentLanguage: data.consentLanguage,
-                customAction: data.customAction
+                customAction: data.customAction,
+                pmUrl: data.iframe_url
             });
         } catch (error) {
             SDK.onError(error);

ConsentViewController/Classes/Consents/CampaignConsent.swift

@@ -0,0 +1,14 @@
+//
+//  CampaignConsent.swift
+//  Pods
+//
+//  Created by Andre Herculano on 06.11.23.
+//
+
+import Foundation
+
+protocol CampaignConsent {
+    var uuid: String? { get set }
+    var applies: Bool { get set }
+    var dateCreated: SPDate { get set }
+}

ConsentViewController/Classes/Consents/ConsentStatus.swift

@@ -10,12 +10,14 @@ import Foundation
 public struct ConsentStatus: Codable, Equatable {
     struct GranularStatus: Codable, Equatable {
         var vendorConsent, vendorLegInt, purposeConsent, purposeLegInt: String?
-        var previousOptInAll, defaultConsent: Bool?
+        var previousOptInAll, defaultConsent, sellStatus,
+            shareStatus, sensitiveDataStatus, gpcStatus: Bool?
     }
 
     var granularStatus: GranularStatus? = GranularStatus()
-    public var rejectedAny, rejectedLI, consentedAll, consentedToAny, rejectedAll, vendorListAdditions, legalBasisChanges: Bool?
+    public var rejectedAny, rejectedLI, consentedAll, consentedToAll,
+               consentedToAny, rejectedAll, vendorListAdditions, legalBasisChanges: Bool?
     var hasConsentData: Bool? = false
-    var rejectedVendors: [String?]? = []
-    var rejectedCategories: [String?]? = []
+    var rejectedVendors: [String?]?
+    var rejectedCategories: [String?]?
 }

ConsentViewController/Classes/Consents/LastMessageData.swift

@@ -0,0 +1,24 @@
+//
+//  LastMessageData.swift
+//  Pods
+//
+//  Created by Andre Herculano on 06.11.23.
+//
+
+import Foundation
+
+struct LastMessageData: Codable {
+    var id, categoryId, subCategoryId: Int
+    var partitionUUID: String
+}
+
+extension LastMessageData {
+    init?(from metadata: MessageMetaData?) {
+        guard let metadata = metadata else { return nil }
+
+        id = Int(metadata.messageId) ?? 0
+        categoryId = metadata.categoryId.rawValue
+        subCategoryId = metadata.subCategoryId.rawValue
+        partitionUUID = metadata.messagePartitionUUID ?? ""
+    }
+}

ConsentViewController/Classes/Consents/SPCCPAConsent.swift

@@ -88,12 +88,6 @@ extension SPUSPString {
     }
 }
 
-protocol CampaignConsent {
-    var uuid: String? { get set }
-    var applies: Bool { get set }
-    var dateCreated: SPDate { get set }
-}
-
 /**
  The UserConsent class encapsulates the consent status, rejected vendor ids and rejected categories (purposes) ids.
  - Important: The `rejectedVendors` and `rejectedCategories` arrays will only be populated if the `status` is `.Some`.
@@ -150,7 +144,7 @@ protocol CampaignConsent {
 
     override open var description: String {
         """
-        UserConsent(
+        SPCCPAConsent(
             - uuid: \(uuid ?? "")
             - status: \(status.rawValue)
             - rejectedVendors: \(rejectedVendors)

ConsentViewController/Classes/Consents/SPGDPRConsent.swift

@@ -7,20 +7,6 @@
 
 import Foundation
 
-struct LastMessageData: Codable {
-    var id, categoryId, subCategoryId: Int
-    var partitionUUID: String
-}
-
-extension LastMessageData {
-    init(from metadata: MessageMetaData) {
-        id = Int(metadata.messageId) ?? 0
-        categoryId = metadata.categoryId.rawValue
-        subCategoryId = metadata.subCategoryId.rawValue
-        partitionUUID = metadata.messagePartitionUUID ?? ""
-    }
-}
-
 /// A dictionary in which the keys represent the Vendor Id
 public typealias SPGDPRVendorGrants = [GDPRVendorId: SPGDPRVendorGrant]
 public typealias GDPRVendorId = String
@@ -183,7 +169,7 @@ public typealias SPGDPRPurposeId = String
         uuid: String? = nil,
         vendorGrants: SPGDPRVendorGrants,
         euconsent: String,
-        tcfData: SPJson,
+        tcfData: SPJson?,
         childPmId: String? = nil,
         dateCreated: SPDate,
         expirationDate: SPDate,

ConsentViewController/Classes/Consents/SPUSNatConsent.swift

@@ -0,0 +1,122 @@
+//
+//  SPUSNatConsent.swift
+//  Pods
+//
+//  Created by Andre Herculano on 02.11.23.
+//
+
+import Foundation
+
+@objcMembers public class SPUSNatConsent: NSObject, Codable, CampaignConsent, NSCopying {
+    public struct ConsentString: Codable, Equatable {
+        let sectionId: Int
+        let sectionName, consentString: String
+    }
+
+    public var uuid: String?
+
+    public var applies: Bool
+
+    public let consentStrings: [ConsentString]
+
+    /// A dictionary with all GPP related data
+    public var GPPData: SPJson?
+
+    let categories: [String]
+
+    var dateCreated, expirationDate: SPDate
+
+    /// Required by SP endpoints
+    var lastMessage: LastMessageData?
+
+    /// Used by the rendering app
+    let webConsentPayload: SPWebConsentPayload?
+
+    var consentStatus: ConsentStatus
+
+    override open var description: String {
+        """
+        SPUSNatConsent(
+            - uuid: \(uuid ?? "")
+            - applies: \(applies)
+            - consentStrings: \(consentStrings)
+            - categories: \(categories)
+            - dateCreated: \(dateCreated)
+            - expirationDate: \(expirationDate)
+        )
+        """
+    }
+
+    init(
+        uuid: String? = nil,
+        applies: Bool,
+        dateCreated: SPDate,
+        expirationDate: SPDate,
+        consentStrings: [ConsentString],
+        webConsentPayload: SPWebConsentPayload? = nil,
+        lastMessage: LastMessageData? = nil,
+        categories: [String],
+        consentStatus: ConsentStatus,
+        GPPData: SPJson? = nil
+    ) {
+        self.uuid = uuid
+        self.applies = applies
+        self.dateCreated = dateCreated
+        self.expirationDate = expirationDate
+        self.consentStrings = consentStrings
+        self.webConsentPayload = webConsentPayload
+        self.lastMessage = lastMessage
+        self.categories = []
+        self.consentStatus = consentStatus
+        self.GPPData = GPPData
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        uuid = try container.decodeIfPresent(String.self, forKey: .uuid)
+        applies = try container.decodeIfPresent(Bool.self, forKey: .applies) ?? false
+        dateCreated = try container.decode(SPDate.self, forKey: .dateCreated)
+        expirationDate = try container.decode(SPDate.self, forKey: .expirationDate)
+        consentStrings = try container.decode([ConsentString].self, forKey: .consentStrings)
+        webConsentPayload = try container.decodeIfPresent(SPWebConsentPayload.self, forKey: .webConsentPayload)
+        lastMessage = try container.decodeIfPresent(LastMessageData.self, forKey: .lastMessage)
+        categories = try container.decode([String].self, forKey: .categories)
+        consentStatus = try container.decode(ConsentStatus.self, forKey: .consentStatus)
+        GPPData = try container.decodeIfPresent(SPJson.self, forKey: .GPPData)
+    }
+
+    public static func empty() -> SPUSNatConsent { SPUSNatConsent(
+        applies: false,
+        dateCreated: .now(),
+        expirationDate: .distantFuture(),
+        consentStrings: [],
+        categories: [],
+        consentStatus: ConsentStatus()
+    )}
+
+    override public func isEqual(_ object: Any?) -> Bool {
+        if let other = object as? SPUSNatConsent {
+            return other.uuid == uuid &&
+                other.applies == applies &&
+                other.consentStrings.count == consentStrings.count &&
+                other.consentStrings.sorted(by: { $0.sectionId > $1.sectionId }) ==
+                    other.consentStrings.sorted(by: { $0.sectionId > $1.sectionId }) &&
+                other.categories == categories
+        } else {
+            return false
+        }
+    }
+
+    public func copy(with zone: NSZone? = nil) -> Any { SPUSNatConsent(
+        uuid: uuid,
+        applies: applies,
+        dateCreated: dateCreated,
+        expirationDate: expirationDate,
+        consentStrings: consentStrings,
+        webConsentPayload: webConsentPayload,
+        lastMessage: lastMessage,
+        categories: categories,
+        consentStatus: consentStatus,
+        GPPData: GPPData
+    )}
+}

ConsentViewController/Classes/Consents/SPUserData.swift

@@ -20,17 +20,17 @@ public struct SPWebConsents: Codable, Equatable {
         }
     }
 
-    let gdpr: SPWebConsent?
-    let ccpa: SPWebConsent?
+    let gdpr, ccpa, usnat: SPWebConsent?
 
-    public init(gdpr: SPWebConsent? = nil, ccpa: SPWebConsent? = nil) {
+    public init(gdpr: SPWebConsent? = nil, ccpa: SPWebConsent? = nil, usnat: SPWebConsent? = nil) {
         self.gdpr = gdpr
         self.ccpa = ccpa
+        self.usnat = usnat
     }
 }
 
 public class SPConsent<ConsentType: Codable & Equatable & NSCopying>: NSObject, Codable, NSCopying {
-    /// The consents data. See: `SPGDPRConsent`, `SPCCPAConsent`
+    /// The consents data. See: `SPGDPRConsent`, `SPCCPAConsent`, `SPUSNatConsent`
     public let consents: ConsentType?
 
     // swiftlint:disable:next todo
@@ -66,27 +66,35 @@ public class SPConsent<ConsentType: Codable & Equatable & NSCopying>: NSObject,
     /// - SeeAlso: `SPCCPAConsent`
     public let ccpa: SPConsent<SPCCPAConsent>?
 
+    /// Consent data for USNat. This attribute will be nil if your setup doesn't include a CCPA campaign
+    /// - SeeAlso: `SPUSNatConsent`
+    public let usnat: SPConsent<SPUSNatConsent>?
+
     var webConsents: SPWebConsents { SPWebConsents(
         gdpr: .init(uuid: gdpr?.consents?.uuid, webConsentPayload: gdpr?.consents?.webConsentPayload),
-        ccpa: .init(uuid: ccpa?.consents?.uuid, webConsentPayload: ccpa?.consents?.webConsentPayload)
+        ccpa: .init(uuid: ccpa?.consents?.uuid, webConsentPayload: ccpa?.consents?.webConsentPayload),
+        usnat: .init(uuid: usnat?.consents?.uuid, webConsentPayload: usnat?.consents?.webConsentPayload)
     )}
 
     override public var description: String {
-        "gdpr: \(String(describing: gdpr)), ccpa: \(String(describing: ccpa))"
+        "gdpr: \(String(describing: gdpr)), ccpa: \(String(describing: ccpa)), usnat: \(String(describing: usnat))"
     }
 
     public init(
         gdpr: SPConsent<SPGDPRConsent>? = nil,
-        ccpa: SPConsent<SPCCPAConsent>? = nil
+        ccpa: SPConsent<SPCCPAConsent>? = nil,
+        usnat: SPConsent<SPUSNatConsent>? = nil
     ) {
         self.gdpr = gdpr
         self.ccpa = ccpa
+        self.usnat = usnat
     }
 
     public func copy(with zone: NSZone? = nil) -> Any {
         SPUserData(
             gdpr: gdpr?.copy() as? SPConsent<SPGDPRConsent>,
-            ccpa: ccpa?.copy() as? SPConsent<SPCCPAConsent>
+            ccpa: ccpa?.copy() as? SPConsent<SPCCPAConsent>,
+            usnat: usnat?.copy() as? SPConsent<SPUSNatConsent>
         )
     }
 
@@ -95,7 +103,9 @@ public class SPConsent<ConsentType: Codable & Equatable & NSCopying>: NSObject,
             return  gdpr?.applies == object.gdpr?.applies &&
                     gdpr?.consents == object.gdpr?.consents &&
                     ccpa?.applies == object.ccpa?.applies &&
-                    ccpa?.consents == object.ccpa?.consents
+                    ccpa?.consents == object.ccpa?.consents &&
+                    usnat?.applies == object.usnat?.applies &&
+                    usnat?.consents == object.usnat?.consents
         } else {
             return false
         }
@@ -107,6 +117,8 @@ public protocol SPObjcUserData {
     func objcGDPRApplies() -> Bool
     func objcCCPAConsents() -> SPCCPAConsent?
     func objcCCPAApplies() -> Bool
+    func objcUSNatConsents() -> SPUSNatConsent?
+    func objcUSNatApplies() -> Bool
 }
 
 @objc extension SPUserData: SPObjcUserData {
@@ -121,14 +133,25 @@ public protocol SPObjcUserData {
         gdpr?.applies ?? false
     }
 
-    /// Returns GDPR consent data if any available.
+    /// Returns CCPA consent data if any available.
     /// - SeeAlso: `SPCCPAConsent`
     public func objcCCPAConsents() -> SPCCPAConsent? {
         ccpa?.consents
     }
 
-    /// Indicates whether GDPR applies based on the VendorList configuration.
+    /// Indicates whether CCPA applies based on the VendorList configuration.
     public func objcCCPAApplies() -> Bool {
         ccpa?.applies ?? false
     }
+
+    /// Returns USNat consent data if any available.
+    /// - SeeAlso: `SPUSNatConsent`
+    public func objcUSNatConsents() -> SPUSNatConsent? {
+        usnat?.consents
+    }
+
+    /// Indicates whether USNat applies based on the VendorList configuration.
+    public func objcUSNatApplies() -> Bool {
+        usnat?.applies ?? false
+    }
 }