Experimental nested expanded fields idea

lib/messages.dart

@@ -1,7 +1,6 @@
 import 'package:json_annotation/json_annotation.dart';
 import 'package:stripe/src/messages/converters.dart';
 import 'package:stripe/src/messages/enums.dart';
-import 'package:stripe/src/messages/enums/pause_collection_behavior.dart';
 
 export 'package:stripe/src/messages/enums.dart';
 
@@ -19,8 +18,8 @@ part 'src/messages/data_list.dart';
 part 'src/messages/discount.dart';
 part 'src/messages/event.dart';
 part 'src/messages/invoice.dart';
-part 'src/messages/payment_intent.dart';
 part 'src/messages/pause_collection.dart';
+part 'src/messages/payment_intent.dart';
 part 'src/messages/payment_method.dart';
 part 'src/messages/portal_session.dart';
 part 'src/messages/price.dart';

lib/src/expanded/customer_expanded.dart

@@ -0,0 +1,9 @@
+import 'package:stripe/messages.dart';
+
+class CustomerExpanded {
+  final Customer customer;
+
+  CustomerExpanded({
+    required this.customer,
+  });
+}

lib/src/expanded/discount_expanded.dart

@@ -0,0 +1,9 @@
+import 'package:stripe/messages.dart';
+
+class DiscountExpanded {
+  final Discount discount;
+
+  DiscountExpanded({
+    required this.discount,
+  });
+}

lib/src/expanded/invoice_expanded.dart

@@ -1,36 +1,14 @@
 import 'package:stripe/messages.dart';
-import 'package:stripe/src/utils/expandable_fields/discounts_expandable_field.dart';
-import 'package:stripe/src/utils/expandable_fields/payment_intent_expandable_field.dart';
+import 'package:stripe/src/expanded/discount_expanded.dart';
 
 class InvoiceExpanded {
   final Invoice invoice;
   final PaymentIntent? paymentIntent;
-  final List<Discount>? discounts;
+  final List<DiscountExpanded>? discounts;
 
   InvoiceExpanded({
     required this.invoice,
     this.paymentIntent,
     this.discounts,
   });
-
-  factory InvoiceExpanded.fromJson(
-    Map<String, dynamic> json,
-    Set<InvoiceExpandableField> expand,
-  ) {
-    PaymentIntent? paymentIntent;
-    if (expand.contains(InvoiceExpandableField.paymentIntent)) {
-      paymentIntent = PaymentIntentExpandableField().extract(json);
-    }
-
-    List<Discount>? discounts;
-    if (expand.contains(InvoiceExpandableField.discounts)) {
-      discounts = DiscountsExpandableField().extract(json);
-    }
-
-    return InvoiceExpanded(
-      invoice: Invoice.fromJson(json),
-      paymentIntent: paymentIntent,
-      discounts: discounts,
-    );
-  }
 }

lib/src/expanded/subscription_expanded.dart

@@ -1,48 +1,18 @@
 import 'package:stripe/messages.dart';
 import 'package:stripe/src/expanded.dart';
-import 'package:stripe/src/utils/expandable_fields/customer_expandable_field.dart';
-import 'package:stripe/src/utils/expandable_fields/discounts_expandable_field.dart';
-import 'package:stripe/src/utils/expandable_fields/latest_invoice_expanded_expandable_field.dart';
+import 'package:stripe/src/expanded/customer_expanded.dart';
+import 'package:stripe/src/expanded/discount_expanded.dart';
 
 class SubscriptionExpanded {
   final Subscription subscription;
-  final List<Discount>? discounts;
+  final List<DiscountExpanded>? discounts;
   final InvoiceExpanded? latestInvoice;
-  final Customer? customer;
+  final CustomerExpanded? customer;
 
   SubscriptionExpanded({
     required this.subscription,
     this.discounts,
     this.latestInvoice,
     this.customer,
   });
-
-  factory SubscriptionExpanded.fromJson(
-    Map<String, dynamic> json,
-    Set<SubscriptionExpandableField> expand,
-  ) {
-    List<Discount>? discounts;
-    if (expand.contains(SubscriptionExpandableField.discounts)) {
-      discounts = const DiscountsExpandableField().extract(json);
-    }
-
-    InvoiceExpanded? latestInvoice;
-    if (expand.contains(SubscriptionExpandableField.latestInvoice)) {
-      latestInvoice = const LatestInvoiceExpandedExpandableField(
-        expand: {InvoiceExpandableField.paymentIntent},
-      ).extract(json);
-    }
-
-    Customer? customer;
-    if (expand.contains(SubscriptionExpandableField.customer)) {
-      customer = const CustomerExpandableField().extract(json);
-    }
-
-    return SubscriptionExpanded(
-      subscription: Subscription.fromJson(json),
-      discounts: discounts,
-      latestInvoice: latestInvoice,
-      customer: customer,
-    );
-  }
 }

lib/src/messages/enums.dart

@@ -1,5 +1,3 @@
-export 'enums/expandable_fields/invoice_expandable_field.dart';
-export 'enums/expandable_fields/subscription_expandable_field.dart';
 export 'enums/payment_behavior.dart';
 export 'enums/proration_behavior.dart';
 export 'enums/stripe_api_error_type.dart';

lib/src/resources/invoice.dart

@@ -2,9 +2,7 @@ import 'dart:async';
 
 import 'package:stripe/messages.dart';
 import 'package:stripe/src/expanded.dart';
-import 'package:stripe/src/utils/expandable_field.dart';
-import 'package:stripe/src/utils/expandable_fields/discounts_expandable_field.dart';
-import 'package:stripe/src/utils/expandable_fields/payment_intent_expandable_field.dart';
+import 'package:stripe/src/utils/expandable_fields/invoice_expandable_field.dart';
 
 import '../client.dart';
 import '_resource.dart';
@@ -23,36 +21,16 @@ class InvoiceResource extends Resource<Invoice> {
 
   Future<InvoiceExpanded> createPreviewExpanded(
     CreatePreviewInvoiceRequest request, {
-    required Set<InvoiceExpandableField> expand,
+    required InvoiceExpandableField expand,
   }) async {
-    final expandableFields = _expandableFields(expand);
     final response = await post(
       '$_resourceName/create_preview',
       data: {
         ...request.toJson(),
-        'expand': expandableFields.map((e) => e.field).toList(),
+        'expand': expand.innerNestedFields.toList(),
       },
     );
 
-    return InvoiceExpanded.fromJson(response, expand);
-  }
-
-  Iterable<ExpandableField> _expandableFields(
-    Set<InvoiceExpandableField> fields,
-  ) {
-    return fields.map(
-      (field) => _expandableField(field),
-    );
-  }
-
-  ExpandableField _expandableField(
-    InvoiceExpandableField field,
-  ) {
-    switch (field) {
-      case InvoiceExpandableField.paymentIntent:
-        return PaymentIntentExpandableField();
-      case InvoiceExpandableField.discounts:
-        return DiscountsExpandableField();
-    }
+    return expand.parse(response);
   }
 }

lib/src/resources/subscription.dart

@@ -2,10 +2,9 @@ import 'dart:async';
 
 import 'package:stripe/messages.dart';
 import 'package:stripe/src/expanded.dart';
-import 'package:stripe/src/utils/expandable_field.dart';
-import 'package:stripe/src/utils/expandable_fields/customer_expandable_field.dart';
 import 'package:stripe/src/utils/expandable_fields/discounts_expandable_field.dart';
-import 'package:stripe/src/utils/expandable_fields/latest_invoice_expanded_expandable_field.dart';
+import 'package:stripe/src/utils/expandable_fields/latest_invoice_expandable_field.dart';
+import 'package:stripe/src/utils/expandable_fields/subscription_expandable_field.dart';
 
 import '../client.dart';
 import '_resource.dart';
@@ -19,10 +18,10 @@ class SubscriptionResource extends Resource<Subscription> {
   Future<SubscriptionExpanded> create(CreateSubscriptionRequest request) async {
     final response = await post(_resourceName, data: request.toJson());
 
-    return SubscriptionExpanded.fromJson(response, {
-      SubscriptionExpandableField.discounts,
-      SubscriptionExpandableField.latestInvoice,
-    });
+    return SubscriptionExpandableField(
+      discountsExpansion: DiscountsExpandableField(),
+      latestInvoiceExpansion: LatestInvoiceExpandableField(),
+    ).extract(response)!;
   }
 
   Future<Subscription> retrieve(String id) async {
@@ -32,40 +31,17 @@ class SubscriptionResource extends Resource<Subscription> {
 
   Future<SubscriptionExpanded> retrieveExpanded(
     String id, {
-    required Set<SubscriptionExpandableField> expand,
+    required SubscriptionExpandableField expand,
   }) async {
-    final expandableFields = _expandableFields(expand);
     final response = await get(
       '$_resourceName/$id',
       queryParameters: {
-        'expand': expandableFields.map((e) => e.field).toList(),
+        for (int i = 0; i < expand.innerNestedFields.length; i++)
+          'expand[$i]': expand.innerNestedFields.elementAt(i),
       },
     );
 
-    return SubscriptionExpanded.fromJson(response, expand);
-  }
-
-  Iterable<ExpandableField> _expandableFields(
-    Set<SubscriptionExpandableField> fields,
-  ) {
-    return fields.map(
-      (field) => _expandableField(field),
-    );
-  }
-
-  ExpandableField _expandableField(
-    SubscriptionExpandableField field,
-  ) {
-    switch (field) {
-      case SubscriptionExpandableField.discounts:
-        return DiscountsExpandableField();
-      case SubscriptionExpandableField.latestInvoice:
-        return LatestInvoiceExpandedExpandableField(
-          expand: {InvoiceExpandableField.paymentIntent},
-        );
-      case SubscriptionExpandableField.customer:
-        return CustomerExpandableField();
-    }
+    return expand.parse(response);
   }
 
   Future<DataList<Subscription>> list(
@@ -76,25 +52,20 @@ class SubscriptionResource extends Resource<Subscription> {
   }
 
   Future<DataList<SubscriptionExpanded>> listExpanded({
-    required Set<SubscriptionExpandableField> expand,
+    required SubscriptionExpandableField expand,
     ListSubscriptionsRequest? request,
   }) async {
-    final expandableFields = _expandableFields(expand);
-
     final response = await get(
       _resourceName,
       queryParameters: {
         ...?request?.toJson(),
-        'expand': expandableFields.map((e) => 'data.${e.field}').toList(),
+        'expand': expand.nestedFields.toList(),
       },
     );
 
     return DataList<SubscriptionExpanded>.fromJson(
       response,
-      (value) => SubscriptionExpanded.fromJson(
-        value as Map<String, dynamic>,
-        expand,
-      ),
+      (value) => expand.extract(value as Map<String, Object?>)!,
     );
   }
 

lib/src/utils/expandable_field.dart

@@ -1,6 +1,14 @@
 abstract class ExpandableField<T> {
   String get field;
 
+  Iterable<String> get innerNestedFields => [];
+
+  Iterable<String> get nestedFields {
+    if (innerNestedFields.isEmpty) return [field];
+
+    return innerNestedFields.map((nestedField) => '$field.$nestedField');
+  }
+
   const ExpandableField();
 
   T extract(Map<String, dynamic> json);

lib/src/utils/expandable_fields/customer_expandable_field.dart

@@ -1,15 +1,17 @@
 import 'package:stripe/messages.dart';
+import 'package:stripe/src/expanded/customer_expanded.dart';
 import 'package:stripe/src/utils/expandable_object_field.dart';
 
-class CustomerExpandableField extends ExpandableObjectField<Customer> {
+class CustomerExpandableField extends ExpandableObjectField<CustomerExpanded> {
   @override
   String get field => 'customer';
 
   const CustomerExpandableField();
 
   @override
-  Customer parse(Map<String, dynamic> object) => Customer.fromJson(object);
+  CustomerExpanded parse(Map<String, dynamic> object) =>
+      CustomerExpanded(customer: Customer.fromJson(object));
 
   @override
-  String replacement(Customer parsedValue) => parsedValue.id;
+  String replacement(CustomerExpanded parsedValue) => parsedValue.customer.id;
 }

lib/src/utils/expandable_fields/discounts_expandable_field.dart

@@ -1,16 +1,19 @@
 import 'package:stripe/messages.dart';
+import 'package:stripe/src/expanded/discount_expanded.dart';
 import 'package:stripe/src/utils/expandable_list_field.dart';
 
-class DiscountsExpandableField extends ExpandableListField<Discount> {
+class DiscountsExpandableField extends ExpandableListField<DiscountExpanded> {
   @override
   String get field => 'discounts';
 
   const DiscountsExpandableField();
 
   @override
-  String elementReplacement(Discount element) => element.id;
+  String elementReplacement(DiscountExpanded element) => element.discount.id;
 
   @override
-  Discount parseElement(Map<String, dynamic> element) =>
-      Discount.fromJson(element);
+  DiscountExpanded parseElement(Map<String, dynamic> element) =>
+      DiscountExpanded(
+        discount: Discount.fromJson(element),
+      );
 }