Change result of purchase methods to PurchaseResult (#1408)

This changes the result type of the purchase methods. Instead of
returning just a `CustomerInfo`, now we will return a `PurchaseResult`,
which includes a `CustomerInfo` and a `StoreTransaction`

Author: tonidero

api_tester/lib/api_tests/models/purchase_result_api_test.dart

@@ -0,0 +1,22 @@
+import 'package:purchases_flutter/object_wrappers.dart';
+
+// ignore_for_file: unused_element
+// ignore_for_file: unused_local_variable
+// ignore_for_file: deprecated_member_use
+class _PurchaseResultApiTest {
+  void _checkFromJsonFactory(Map<String, dynamic> json) {
+    PurchaseResult transaction = PurchaseResult.fromJson(json);
+  }
+
+  void _checkConstructor(
+      CustomerInfo customerInfo,
+      StoreTransaction storeTransaction) {
+    PurchaseResult purchaseResult =
+    PurchaseResult(customerInfo, storeTransaction);
+  }
+
+  void _checkProperties(PurchaseResult purchaseResult) {
+    CustomerInfo customerInfo = purchaseResult.customerInfo;
+    StoreTransaction storeTransaction = purchaseResult.storeTransaction;
+  }
+}

api_tester/lib/api_tests/purchases_flutter_api_test.dart

@@ -93,67 +93,67 @@ class _PurchasesFlutterApiTest {
     GoogleProductChangeInfo? googleProductChangeInfo;
     PurchaseType purchaseType = PurchaseType.subs;
     ProductCategory productType = ProductCategory.subscription;
-    CustomerInfo customerInfo = await Purchases.purchaseProduct(
+    PurchaseResult purchaseResult = await Purchases.purchaseProduct(
         productIdentifier,
         type: purchaseType,
         upgradeInfo: upgradeInfo);
-    customerInfo = await Purchases.purchaseProduct(productIdentifier,
+    purchaseResult = await Purchases.purchaseProduct(productIdentifier,
         upgradeInfo: upgradeInfo);
-    customerInfo = await Purchases.purchaseProduct(productIdentifier);
+    purchaseResult = await Purchases.purchaseProduct(productIdentifier);
   }
 
   void _checkPurchaseStoreProduct(StoreProduct storeProduct) async {
     GoogleProductChangeInfo? googleProductChangeInfo;
-    CustomerInfo customerInfo = await Purchases.purchaseStoreProduct(
+    PurchaseResult purchaseResult = await Purchases.purchaseStoreProduct(
         storeProduct,
         googleProductChangeInfo: googleProductChangeInfo,
         googleIsPersonalizedPrice: true);
-    customerInfo = await Purchases.purchaseStoreProduct(storeProduct,
+    purchaseResult = await Purchases.purchaseStoreProduct(storeProduct,
         googleIsPersonalizedPrice: true);
-    customerInfo = await Purchases.purchaseStoreProduct(storeProduct,
+    purchaseResult = await Purchases.purchaseStoreProduct(storeProduct,
         googleProductChangeInfo: googleProductChangeInfo);
-    customerInfo = await Purchases.purchaseStoreProduct(storeProduct);
+    purchaseResult = await Purchases.purchaseStoreProduct(storeProduct);
   }
 
   void _checkPurchasePackage(Package package) async {
     UpgradeInfo? upgradeInfo;
     GoogleProductChangeInfo? googleProductChangeInfo;
-    CustomerInfo customerInfo =
+    PurchaseResult purchaseResult =
         await Purchases.purchasePackage(package, upgradeInfo: upgradeInfo);
-    customerInfo = await Purchases.purchasePackage(package,
+    purchaseResult = await Purchases.purchasePackage(package,
         googleProductChangeInfo: googleProductChangeInfo,
         googleIsPersonalizedPrice: true);
-    customerInfo = await Purchases.purchasePackage(package,
+    purchaseResult = await Purchases.purchasePackage(package,
         upgradeInfo: upgradeInfo, googleIsPersonalizedPrice: true);
-    customerInfo = await Purchases.purchasePackage(package,
+    purchaseResult = await Purchases.purchasePackage(package,
         googleIsPersonalizedPrice: true);
   }
 
   void _checkPurchaseSubscriptionOption(SubscriptionOption subscriptionOption,
       GoogleProductChangeInfo? googleProductChangeInfo) async {
-    CustomerInfo customerInfo = await Purchases.purchaseSubscriptionOption(
+    PurchaseResult purchaseResult = await Purchases.purchaseSubscriptionOption(
         subscriptionOption,
         googleProductChangeInfo: googleProductChangeInfo);
-    customerInfo = await Purchases.purchaseSubscriptionOption(
+    purchaseResult = await Purchases.purchaseSubscriptionOption(
         subscriptionOption,
         googleProductChangeInfo: googleProductChangeInfo,
         googleIsPersonalizedPrice: true);
-    customerInfo = await Purchases.purchaseSubscriptionOption(
+    purchaseResult = await Purchases.purchaseSubscriptionOption(
         subscriptionOption,
         googleIsPersonalizedPrice: true);
-    customerInfo =
+    purchaseResult =
         await Purchases.purchaseSubscriptionOption(subscriptionOption);
   }
 
   void _checkPurchaseDiscountedProduct(
       StoreProduct product, PromotionalOffer offer) async {
-    CustomerInfo customerInfo =
+    PurchaseResult purchaseResult =
         await Purchases.purchaseDiscountedProduct(product, offer);
   }
 
   void _checkPurchaseDiscountedPackage(
       Package package, PromotionalOffer offer) async {
-    CustomerInfo customerInfo =
+    PurchaseResult purchaseResult =
         await Purchases.purchaseDiscountedPackage(package, offer);
   }
 
@@ -568,15 +568,15 @@ class _PurchasesFlutterApiTest {
   }
 }
 
-Future<CustomerInfo> _checkFetchAndPurchaseWinBackOffersForProduct(
+Future<PurchaseResult> _checkFetchAndPurchaseWinBackOffersForProduct(
     StoreProduct product) async {
   List<WinBackOffer>? offers =
       await Purchases.getEligibleWinBackOffersForProduct(product);
 
   return await Purchases.purchaseProductWithWinBackOffer(product, offers[0]);
 }
 
-Future<CustomerInfo> _checkFetchAndPurchaseWinBackOffersForPackage(
+Future<PurchaseResult> _checkFetchAndPurchaseWinBackOffersForPackage(
     Package package) async {
   List<WinBackOffer>? offers =
       await Purchases.getEligibleWinBackOffersForPackage(package);

api_tester/lib/api_tests_import.dart

@@ -17,6 +17,7 @@ import 'package:api_tester/api_tests/models/price_wrapper_api_test.dart';
 import 'package:api_tester/api_tests/models/pricing_phase_wrapper_api_test.dart';
 import 'package:api_tester/api_tests/models/promotional_offer_api_test.dart';
 import 'package:api_tester/api_tests/models/purchase_configuration_api_test.dart';
+import 'package:api_tester/api_tests/models/purchase_result_api_test.dart';
 import 'package:api_tester/api_tests/models/purchases_error_api_test.dart';
 import 'package:api_tester/api_tests/models/store_api_test.dart';
 import 'package:api_tester/api_tests/models/store_product_discount_api_test.dart';

lib/models/purchase_result.dart

@@ -0,0 +1,29 @@
+import 'package:equatable/equatable.dart';
+
+import 'customer_info_wrapper.dart';
+import 'store_transaction.dart';
+
+/// Represents the successful result of a purchase operation.
+class PurchaseResult extends Equatable {
+  /// The updated [CustomerInfo] after the purchase has been synced with
+  /// RevenueCat's servers.
+  final CustomerInfo customerInfo;
+  /// The [StoreTransaction] for this purchase.
+  final StoreTransaction storeTransaction;
+
+  const PurchaseResult(
+    this.customerInfo,
+    this.storeTransaction,
+  );
+
+  factory PurchaseResult.fromJson(Map<String, dynamic> json) => PurchaseResult(
+    CustomerInfo.fromJson(Map<String, dynamic>.from(json['customerInfo'])),
+    StoreTransaction.fromJson(Map<String, dynamic>.from(json['transaction'])),
+  );
+
+  @override
+  List<Object> get props => [
+    customerInfo,
+    storeTransaction,
+  ];
+}

lib/object_wrappers.dart

@@ -17,6 +17,7 @@ export 'models/price_wrapper.dart';
 export 'models/pricing_phase_wrapper.dart';
 export 'models/product_category.dart';
 export 'models/promotional_offer.dart';
+export 'models/purchase_result.dart';
 export 'models/purchases_completed_by.dart';
 export 'models/purchases_configuration.dart';
 export 'models/purchases_error.dart';