wip: adding more fields to LocalTransactionMetadata

Author: rickvdl

Sources/Purchasing/ProductRequestData.swift

@@ -66,7 +66,7 @@ struct ProductRequestData {
 
 }
 
-extension ProductRequestData: Encodable {
+extension ProductRequestData: Codable {
 
     enum CodingKeys: String, CodingKey {
 
@@ -116,4 +116,24 @@ extension ProductRequestData: Encodable {
         }
     }
 
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        self.productIdentifier = try container.decode(String.self, forKey: .productIdentifier)
+        
+        self.paymentMode = try container.decodeIfPresent(StoreProductDiscount.PaymentMode.self, forKey: .paymentMode)
+        self.currencyCode = try container.decodeIfPresent(String.self, forKey: .currencyCode)
+
+        // TODO: check the following types. They can't be as easily decoded into their original types as they are encoded
+        self.storefront = nil
+        self.price = 0
+        self.discounts = nil
+        self.introPrice = nil
+        self.introDuration = nil
+        self.introDurationType = nil
+
+        self.normalDuration = try container.decodeIfPresent(String.self, forKey: .normalDuration)
+        self.subscriptionGroup = try container.decodeIfPresent(String.self, forKey: .subscriptionGroup)
+    }
+
 }

Sources/Purchasing/Purchases/LocalTransactionMetadataCache.swift

@@ -38,24 +38,46 @@ internal struct LocalTransactionMetadata: Equatable, Codable, Sendable {
     /// Whether purchases are completed by RevenueCat or the app (observer mode equivalent).
     let observerMode: Bool
 
+    /// Apple Ad Services attribution token.
+    let aadAttributionToken: String?
+
+    /// The encoded receipt data.
+    let receipt: EncodedAppleReceipt?
+
+    /// Product request data (product info, pricing, discounts, etc.).
+//    let productData: ProductRequestData?
+    // TODO: does not conform to Codable and Equatable (yet)
+
+    /// AppTransaction JWS string (StoreKit 2).
+    let appTransactionJWS: String?
+
     init(
         appUserID: String,
         productIdentifier: String,
         presentedOfferingContext: PresentedOfferingContext?,
         paywallPostReceiptData: PaywallPostReceiptData?,
-        observerMode: Bool
+        observerMode: Bool,
+        aadAttributionToken: String? = nil,
+        receipt: EncodedAppleReceipt? = nil,
+        productData: ProductRequestData? = nil,
+        appTransactionJWS: String? = nil
     ) {
         self.schemaVersion = 1
         self.appUserID = appUserID
         self.productIdentifier = productIdentifier
         self.presentedOfferingContext = presentedOfferingContext
         self.paywallPostReceiptData = paywallPostReceiptData
         self.observerMode = observerMode
+        self.aadAttributionToken = aadAttributionToken
+        self.receipt = receipt
+//        self.productData = productData
+        self.appTransactionJWS = appTransactionJWS
     }
 
     enum CodingKeys: String, CodingKey {
         case schemaVersion, productIdentifier, presentedOfferingContext, paywallPostReceiptData, observerMode
         case appUserID = "appUserId"
+        case aadAttributionToken, receipt, /*productData,*/ appTransactionJWS
     }
 }
 

Sources/Purchasing/StoreKitAbstractions/EncodedAppleReceipt.swift

@@ -24,6 +24,64 @@ enum EncodedAppleReceipt: Equatable {
 
 }
 
+extension EncodedAppleReceipt: Codable {
+    enum CodingKeys: String, CodingKey {
+        case type
+        case value
+    }
+
+    enum ReceiptType: String, Codable {
+        case jws
+        case receipt
+        case sk2receipt
+        case empty
+    }
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        let type = try container.decode(ReceiptType.self, forKey: .type)
+
+        switch type {
+        case .jws:
+            let value = try container.decode(String.self, forKey: .value)
+            self = .jws(value)
+        case .receipt:
+            let base64String = try container.decode(String.self, forKey: .value)
+            guard let data = Data(base64Encoded: base64String) else {
+                throw DecodingError.dataCorruptedError(
+                    forKey: .value,
+                    in: container,
+                    debugDescription: "Invalid base64 string for receipt data"
+                )
+            }
+            self = .receipt(data)
+        case .sk2receipt:
+            let value = try container.decode(StoreKit2Receipt.self, forKey: .value)
+            self = .sk2receipt(value)
+        case .empty:
+            self = .empty
+        }
+    }
+
+    func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        switch self {
+        case .jws(let jws):
+            try container.encode(ReceiptType.jws, forKey: .type)
+            try container.encode(jws, forKey: .value)
+        case .receipt(let data):
+            try container.encode(ReceiptType.receipt, forKey: .type)
+            try container.encode(data.base64EncodedString(), forKey: .value)
+        case .sk2receipt(let receipt):
+            try container.encode(ReceiptType.sk2receipt, forKey: .type)
+            try container.encode(receipt, forKey: .value)
+        case .empty:
+            try container.encode(ReceiptType.empty, forKey: .type)
+        }
+    }
+}
+
 extension EncodedAppleReceipt {
 
     func serialized() -> String? {

Sources/Purchasing/StoreKitAbstractions/StoreProductDiscount.swift

@@ -308,7 +308,7 @@ extension StoreProductDiscount.DiscountType {
 
 }
 
-extension StoreProductDiscount.PaymentMode: Encodable {}
+extension StoreProductDiscount.PaymentMode: Codable {}
 
 extension StoreProductDiscount: Identifiable {
 

Tests/UnitTests/Purchasing/Purchases/LocalTransactionMetadataCacheTests.swift

@@ -426,6 +426,8 @@ class LocalTransactionMetadataCacheTests: TestCase {
         expect(self.localTransactionMetadataCache.retrieve(forTransactionID: transactionID)) == transactionMetadata
         expect(self.localTransactionMetadataCache.retrieve(for: storeTransaction)) == transactionMetadata
     }
+
+    // TODO: expand tests to add new codable fields + add minimal + maximum example of all fields comparing against serialized JSON string
 }
 
 extension LocalTransactionMetadataCacheTests {