feat: add renewal info for Storekit 2 (#2614)

- add renewal info (uncomment and serialize)
- change debugSerialize to serialize - there is info in this property
useful for production not only for development
- added transactionReasonIOS enum (to distinguish between type of
renewing transactions of purchase events)

see also:
[JWSTransactionDecodedPayload](https://developer.apple.com/documentation/appstoreserverapi/jwstransactiondecodedpayload)

ios/IapSerializationUtils.swift

@@ -31,6 +31,10 @@ func serializeDebug (_ d: Data) -> String? {
     #endif
 }
 
+func serialize (_ d: Data) -> String? {
+    return String( decoding: d, as: UTF8.self)
+}
+
 func serializeDebug (_ s: String) -> String? {
     #if DEBUG
     return s
@@ -75,12 +79,29 @@ func serialize(_ sp: Product.SubscriptionPeriod.Unit?) -> String? {
 @available(iOS 15.0, tvOS 15.0, *)
 func serialize(_ s: Product.SubscriptionInfo.Status?) -> [String: Any?]? {
     guard let s = s else {return nil}
-    return ["state": serialize( s.state)
-            // "renewalInfo": serialize(s.renewalInfo),
+    return ["state": serialize( s.state),
+            "renewalInfo": serialize(s.renewalInfo)
             // "transaction": serialize(s.transaction),
     ]
 }
 
+@available(iOS 15.0, tvOS 15.0, *)
+func serialize(_ vri: VerificationResult<Product.SubscriptionInfo.RenewalInfo>?) -> [String: Any?]? {
+    guard let vri = vri else {return nil}
+    do {
+        let ri = try vri.payloadValue
+        let jsonStringRepresentation = String(data: ri.jsonRepresentation, encoding: .utf8) ?? ""
+        return [
+            "jsonRepresentation": jsonStringRepresentation,
+            "willAutoRenew": ri.willAutoRenew,
+            "autoRenewPreference": ri.autoRenewPreference
+        ]
+    } catch {
+        print("Error in parsing VerificationResult<Product.SubscriptionInfo.RenewalInfo>")
+        return nil
+    }
+}
+
 @available(iOS 15.0, tvOS 15.0, *)
 func serialize(_ rs: Product.SubscriptionInfo.RenewalState?) -> String? {
     guard let rs = rs else {return nil}
@@ -158,7 +179,7 @@ func serialize(_ t: Transaction) -> [String: Any?] {
             "environment": environment,
             "id": t.id,
             "isUpgraded": t.isUpgraded,
-            "jsonRepresentation": serializeDebug(t.jsonRepresentation),
+            "jsonRepresentation": serialize(t.jsonRepresentation),
             "offerID": t.offerID,
             "offerType": serialize(t.offerType),
             "originalID": t.originalID,

src/types/appleSk2.ts

@@ -134,8 +134,22 @@ export type SubscriptionStatus =
   | 'revoked'
   | 'subscribed';
 
+/**
+* Renewal info for whole subscription group.
+* see: https://developer.apple.com/documentation/storekit/product/subscriptioninfo/status/3822294-renewalinfo
+* WARN:
+* - autoRenewPreference is serialised as autoRenewProductId in jsonRepresentation
+* - renewalDate is available in jsonRepresentation (will change with Xcode 15 https://developer.apple.com/forums/thread/738833)
+*/
+export type RenewalInfo = {
+  jsonRepresentation?: string;
+  willAutoRenew: boolean;
+  autoRenewPreference?: string;
+};
+
 export type ProductStatus = {
   state: SubscriptionStatus;
+  renewalInfo?: RenewalInfo;
 };
 
 export const transactionSk2ToPurchaseMap = ({
@@ -146,8 +160,19 @@ export const transactionSk2ToPurchaseMap = ({
   purchasedQuantity,
   originalID,
   verificationResult,
-  appAccountToken
+  appAccountToken,
+  jsonRepresentation,
 }: TransactionSk2): Purchase => {
+  let transactionReasonIOS;
+  try {
+    const transactionData = JSON.parse(jsonRepresentation);
+    transactionReasonIOS = transactionData.transactionReason;
+  } catch (e) {
+    console.log(
+      'AppleSK2.ts react-native-iap: Error parsing jsonRepresentation',
+      e,
+    );
+  }
   const purchase: Purchase = {
     productId: productID,
     transactionId: String(id),
@@ -159,6 +184,7 @@ export const transactionSk2ToPurchaseMap = ({
     originalTransactionIdentifierIOS: originalID,
     verificationResultIOS: verificationResult ?? '',
     appAccountToken: appAccountToken ?? '',
+    transactionReasonIOS: transactionReasonIOS ?? '',
   };
   return purchase;
 };

src/types/index.ts

@@ -46,6 +46,11 @@ export enum ProductType {
   iap = 'iap',
 }
 
+export enum TransactionReason {
+  PURCHASE = 'PURCHASE',
+  RENEWAL = 'RENEWAL',
+}
+
 export interface ProductCommon {
   type: 'subs' | 'sub' | 'inapp' | 'iap';
   productId: string; //iOS
@@ -102,6 +107,7 @@ export interface SubscriptionPurchase extends ProductPurchase {
   originalTransactionDateIOS?: number;
   originalTransactionIdentifierIOS?: string;
   verificationResultIOS?: string;
+  transactionReasonIOS?: TransactionReason | string;
 }
 
 export type Purchase = ProductPurchase | SubscriptionPurchase;