Support promotional offers

Author: mvanbeusekom

packages/in_app_purchase/in_app_purchase_ios/example/ios/RunnerTests/TranslatorTests.m

@@ -14,6 +14,7 @@ @interface TranslatorTest : XCTestCase
 @property(strong, nonatomic) NSMutableDictionary *productMap;
 @property(strong, nonatomic) NSDictionary *productResponseMap;
 @property(strong, nonatomic) NSDictionary *paymentMap;
+@property(strong, nonatomic) NSDictionary *paymentDiscountMap;
 @property(strong, nonatomic) NSDictionary *transactionMap;
 @property(strong, nonatomic) NSDictionary *errorMap;
 @property(strong, nonatomic) NSDictionary *localeMap;
@@ -50,6 +51,10 @@ - (void)setUp {
  self.productMap[@"subscriptionGroupIdentifier"] = @"com.group";
  }
 
+ if (@available(iOS 11.2, *)) {
+ self.productMap[@"discounts"] = @[ self.discountMap ];
+ }
+ 
  self.productResponseMap =
  @{@"products" : @[ self.productMap ], @"invalidProductIdentifiers" : @[]};
  self.paymentMap = @{

packages/in_app_purchase/in_app_purchase_ios/ios/Classes/FIAObjectTranslator.h

@@ -47,6 +47,9 @@ NS_ASSUME_NONNULL_BEGIN
  andSKPaymentTransaction:(SKPaymentTransaction *)transaction
  API_AVAILABLE(ios(13), macos(10.15), watchos(6.2));
 
+// Creates an instance of the SKPaymentDiscount class based on the supplied disctionary.
++ (SKPaymentDiscount *)getSKPaymentDiscountFromMap:(NSDictionary *)map API_AVAILABLE(ios(12.2));
+
 @end
 ;
 

packages/in_app_purchase/in_app_purchase_ios/ios/Classes/FIAObjectTranslator.m

@@ -193,4 +193,24 @@ + (NSDictionary *)getMapFromSKStorefront:(SKStorefront *)storefront
  return map;
 }
 
++ (SKPaymentDiscount *)getSKPaymentDiscountFromMap:(NSDictionary *)map {
+ if (!map) {
+ return nil;
+ }
+ 
+ NSString *identifier = map[@"identifier"];
+ NSString *keyIdentifier = map[@"keyIdentifier"];
+ NSUUID *nonce = [[NSUUID alloc] initWithUUIDString:map[@"nonce"]];
+ NSString *signature = map[@"signature"];
+ NSNumber *timestamp = map[@"timestamp"];
+ 
+ SKPaymentDiscount *discount = [[SKPaymentDiscount alloc] initWithIdentifier:identifier
+ keyIdentifier:keyIdentifier
+ nonce:nonce
+ signature:signature
+ timestamp:timestamp];
+ 
+ return discount;
+}
+
 @end

packages/in_app_purchase/in_app_purchase_ios/lib/src/store_kit_wrappers/sk_payment_queue_wrapper.dart

@@ -378,12 +378,14 @@ class SKError {
 @JsonSerializable(createToJson: true)
 class SKPaymentWrapper {
  /// Creates a new [SKPaymentWrapper] with the provided information.
- const SKPaymentWrapper(
- {required this.productIdentifier,
- this.applicationUsername,
- this.requestData,
- this.quantity = 1,
- this.simulatesAskToBuyInSandbox = false});
+ const SKPaymentWrapper({
+ required this.productIdentifier,
+ this.applicationUsername,
+ this.requestData,
+ this.quantity = 1,
+ this.simulatesAskToBuyInSandbox = false,
+ this.paymentDiscount,
+ });
 
  /// Constructs an instance of this from a key value map of data.
  ///
@@ -450,6 +452,13 @@ class SKPaymentWrapper {
  /// testing.
  final bool simulatesAskToBuyInSandbox;
 
+ /// The details of optional discount that should be applied to the payment.
+ ///
+ /// See [Setting Up Promotional Offers](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/subscriptions_and_offers/setting_up_promotional_offers?language=objc)
+ /// for more information on generating keys and creating offers for
+ /// auto-renewable subscriptions.
+ final SKPaymentDiscountWrapper? paymentDiscount;
+
  @override
  bool operator ==(Object other) {
  if (identical(other, this)) {
@@ -473,3 +482,99 @@ class SKPaymentWrapper {
  @override
  String toString() => _$SKPaymentWrapperToJson(this).toString();
 }
+
+/// Dart wrapper around StoreKit's
+/// [SKPaymentDiscount](https://developer.apple.com/documentation/storekit/skpaymentdiscount?language=objc).
+///
+/// Used to indicate a discount is applicable to a payment. The
+/// [SKPaymentDiscountWrapper] instance should be assigned to the
+/// [SKPaymentWrapper] object to which the discount should be applied.
+/// Discount offers are set up in App Store Connect.
+@immutable
+@JsonSerializable(createToJson: true)
+class SKPaymentDiscountWrapper {
+ /// Creates a new [SKPaymentDiscountWrapper] with the provided information.
+ const SKPaymentDiscountWrapper({
+ required this.identifier,
+ required this.keyIdentifier,
+ required this.nonce,
+ required this.signature,
+ required this.timestamp,
+ });
+
+ /// Constructs an instance of this from a key value map of data.
+ ///
+ /// The map needs to have named string keys with values matching the names and
+ /// types of all of the members on this class. The `map` parameter must not be
+ /// null.
+ factory SKPaymentDiscountWrapper.fromJson(Map<String, dynamic> map) {
+ assert(map != null);
+ return _$SKPaymentDiscountWrapperFromJson(map);
+ }
+
+ /// Creates a Map object describes the payment object.
+ Map<String, dynamic> toMap() {
+ return <String, dynamic>{
+ 'identifier': identifier,
+ 'keyIdentifier': keyIdentifier,
+ 'nonce': nonce,
+ 'signature': signature,
+ 'timestamp': timestamp,
+ };
+ }
+
+ /// The identifier of the discount offer.
+ ///
+ /// The identifier must match one of the offers set up in App Store Connect.
+ final String identifier;
+
+ /// A string identifying the key that is used to generate the signature.
+ ///
+ /// Keys are generated and downloaded from App Store Connect. See the "KEY ID"
+ /// column in the App Store Promotions section in App Store Connect to use as
+ /// the keyIdentifier.
+ final String keyIdentifier;
+
+ /// A universal unique identifier created together with the signature.
+ ///
+ /// The unique nonce should be generated on your server when it creates the
+ /// `signature` for the payment discount. The nonce can be used once, a new
+ /// nonce should be created for each payment request.
+ /// The string representation of the nonce must be lowercase.
+ final String nonce;
+
+ /// A cryptographically signed string representing the to properties of the
+ /// promotional offer.
+ ///
+ /// The signature is string signed with a private key and contains all the
+ /// properties of the promotional offer. To keep you private key secure the
+ /// signature should be created on a server. See [Generating a Signature for Promotional Offers](https://developer.apple.com/documentation/storekit/original_api_for_in-app_purchase/subscriptions_and_offers/generating_a_signature_for_promotional_offers?language=objc)
+ /// for more information.
+ final String signature;
+
+ /// The date and time the signature was created.
+ ///
+ /// The timestamp should be formatted in Unix epoch time.
+ final int timestamp;
+
+ @override
+ bool operator ==(Object other) {
+ if (identical(other, this)) {
+ return true;
+ }
+ if (other.runtimeType != runtimeType) {
+ return false;
+ }
+ final SKPaymentDiscountWrapper typedOther =
+ other as SKPaymentDiscountWrapper;
+ return typedOther.identifier == identifier &&
+ typedOther.keyIdentifier == keyIdentifier &&
+ typedOther.nonce == nonce &&
+ typedOther.signature == signature &&
+ typedOther.timestamp == timestamp;
+ }
+
+ @override
+ int get hashCode =>
+ hashValues(identifier, keyIdentifier, nonce, signature, timestamp);
+}

packages/in_app_purchase/in_app_purchase_ios/lib/src/store_kit_wrappers/sk_payment_queue_wrapper.g.dart

@@ -241,7 +241,8 @@ class SKProductWrapper {
  required this.price,
  this.subscriptionPeriod,
  this.introductoryPrice,
- });
+ List<SKProductDiscountWrapper>? discounts,
+ }) : this.discounts = discounts ?? <SKProductDiscountWrapper>[];
 
  /// Constructing an instance from a map from the Objective-C layer.
  ///
@@ -295,6 +296,16 @@ class SKProductWrapper {
  /// and their units and duration do not have to be matched.
  final SKProductDiscountWrapper? introductoryPrice;
 
+ /// An array of subscription offers available for the auto-renewable subscription (available on iOS 12.2 and higher).
+ /// 
+ /// This property lists all promotional offers set up in App Store Connect. If 
+ /// no promotional offers have been set up this field returns an empty list.
+ /// Each [subscriptionPeriod] of individual discounts are independent of the
+ /// product's [subscriptionPeriod] and their units and duration do not have to
+ /// be matched. 
+ @JsonKey(defaultValue: <SKProductDiscountWrapper>[])
+ final List<SKProductDiscountWrapper> discounts;
+
  @override
  bool operator ==(Object other) {
  if (identical(other, this)) {
@@ -311,7 +322,8 @@ class SKProductWrapper {
  typedOther.subscriptionGroupIdentifier == subscriptionGroupIdentifier &&
  typedOther.price == price &&
  typedOther.subscriptionPeriod == subscriptionPeriod &&
- typedOther.introductoryPrice == introductoryPrice;
+ typedOther.introductoryPrice == introductoryPrice &&
+ DeepCollectionEquality().equals(typedOther.discounts, discounts);
  }
 
  @override
@@ -323,7 +335,8 @@ class SKProductWrapper {
  this.subscriptionGroupIdentifier,
  this.price,
  this.subscriptionPeriod,
- this.introductoryPrice);
+ this.introductoryPrice,
+ this.discounts);
 }
 
 /// Object that indicates the locale of the price

packages/in_app_purchase/in_app_purchase_ios/lib/src/store_kit_wrappers/sk_product_wrapper.dart

@@ -84,6 +84,7 @@ void main() {
  expect(wrapper.subscriptionGroupIdentifier, null);
  expect(wrapper.price, '');
  expect(wrapper.subscriptionPeriod, null);
+ expect(wrapper.discounts, <SKProductDiscountWrapper>[]);
  });
 
  test('toProductDetails() should return correct Product object', () {

packages/in_app_purchase/in_app_purchase_ios/lib/src/store_kit_wrappers/sk_product_wrapper.g.dart

@@ -68,6 +68,7 @@ final SKProductWrapper dummyProductWrapper = SKProductWrapper(
  price: '1.0',
  subscriptionPeriod: dummySubscription,
  introductoryPrice: dummyDiscount,
+ discounts: [dummyDiscount],
 );
 
 final SkProductResponseWrapper dummyProductResponseWrapper =
@@ -118,6 +119,7 @@ Map<String, dynamic> buildProductMap(SKProductWrapper product) {
  'subscriptionPeriod':
  buildSubscriptionPeriodMap(product.subscriptionPeriod),
  'introductoryPrice': buildDiscountMap(product.introductoryPrice!),
+ 'discounts': [buildDiscountMap(product.introductoryPrice!)],
  };
 }