Migrate from address change requested to address change start (#394)

Author: kiftio

modules/@shopify/checkout-sheet-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/CustomCheckoutEventProcessor.java

@@ -36,6 +36,8 @@ of this software and associated documentation files (the "Software"), to deal
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.shopify.checkoutsheetkit.lifecycleevents.CheckoutCompleteEvent;
 import com.shopify.checkoutsheetkit.lifecycleevents.CheckoutStartEvent;
+import com.shopify.checkoutsheetkit.rpc.events.CheckoutAddressChangeStart;
+import com.shopify.checkoutsheetkit.rpc.events.CheckoutAddressChangeStartEvent;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.IOException;
 import java.util.HashMap;
@@ -142,6 +144,28 @@ public void onStart(@NonNull CheckoutStartEvent event) {
     }
   }
 
+  @Override
+  public void onAddressChangeStart(@NonNull CheckoutAddressChangeStart event) {
+    try {
+      CheckoutAddressChangeStartEvent params = event.getParams();
+      if (params == null) {
+        Log.e("ShopifyCheckoutSheetKit", "Address change event has null params");
+        return;
+      }
+
+      Map<String, Object> eventData = new HashMap<>();
+      eventData.put("id", event.getId());
+      eventData.put("type", "addressChangeStart");
+      eventData.put("addressType", params.getAddressType());
+      eventData.put("cart", params.getCart());
+
+      String data = mapper.writeValueAsString(eventData);
+      sendEventWithStringData("addressChangeStart", data);
+    } catch (IOException e) {
+      Log.e("ShopifyCheckoutSheetKit", "Error processing address change start event", e);
+    }
+  }
+
   // Private
 
   private Map<String, Object> populateErrorDetails(CheckoutException checkoutError) {

modules/@shopify/checkout-sheet-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/ShopifyCheckoutSheetKitModule.java

@@ -175,7 +175,7 @@ public void initiateGeolocationRequest(Boolean allow) {
 
   private CheckoutOptions parseCheckoutOptions(ReadableMap options) {
     if (options == null) {
-      return null;
+      return new CheckoutOptions();
     }
 
     // Parse authentication

modules/@shopify/checkout-sheet-kit/ios/RCTCheckoutWebView.swift

@@ -84,7 +84,7 @@ class RCTCheckoutWebView: UIView {
   @objc var onComplete: RCTBubblingEventBlock?
   @objc var onCancel: RCTBubblingEventBlock?
   @objc var onLinkClick: RCTBubblingEventBlock?
-  @objc var onAddressChangeIntent: RCTBubblingEventBlock?
+  @objc var onAddressChangeStart: RCTBubblingEventBlock?
   @objc var onPaymentChangeIntent: RCTBubblingEventBlock?
 
   override init(frame: CGRect) {
@@ -282,15 +282,27 @@ extension RCTCheckoutWebView: CheckoutDelegate {
     error.isRecoverable
   }
 
-  func checkoutDidRequestAddressChange(event: AddressChangeRequested) {
+  /// Called when checkout starts an address change flow.
+  ///
+  /// This event is only emitted when native address selection is enabled
+  /// for the authenticated app.
+  ///
+  /// - Parameter event: The address change start event containing:
+  ///   - id: Unique identifier for responding to the event
+  ///   - addressType: Type of address being changed ("shipping" or "billing")
+  ///   - cart: Current cart state
+  func checkoutDidStartAddressChange(event: CheckoutAddressChangeStart) {
     guard let id = event.id else { return }
 
     self.events.set(key: id, event: event)
 
-    onAddressChangeIntent?([
+    let cartJSON = ShopifyEventSerialization.encodeToJSON(from: event.params.cart)
+
+    onAddressChangeStart?([
       "id": event.id,
-      "type": "addressChangeIntent",
+      "type": "addressChangeStart",
       "addressType": event.params.addressType,
+      "cart": cartJSON,
     ])
   }
 

modules/@shopify/checkout-sheet-kit/ios/ShopifyCheckoutSheetKit+EventSerialization.swift

@@ -73,6 +73,18 @@ internal enum ShopifyEventSerialization {
         return encodeToJSON(from: event)
     }
 
+    /**
+     * Converts a CheckoutAddressChangeStart to a React Native compatible dictionary.
+     */
+    static func serialize(checkoutAddressChangeStart event: CheckoutAddressChangeStart) -> [String: Any] {
+        return [
+            "id": event.id as Any,
+            "type": "addressChangeStart",
+            "addressType": event.params.addressType,
+            "cart": encodeToJSON(from: event.params.cart)
+        ]
+    }
+
     static func serialize(clickEvent url: URL) -> [String: URL] {
         return ["url": url]
     }

modules/@shopify/checkout-sheet-kit/ios/ShopifyCheckoutSheetKit.mm

@@ -126,7 +126,7 @@ @interface RCT_EXTERN_MODULE (RCTCheckoutWebViewManager, RCTViewManager)
     /**
      * Emitted when checkout is moving to address selection screen
      */
-    RCT_EXPORT_VIEW_PROPERTY(onAddressChangeIntent, RCTBubblingEventBlock)
+    RCT_EXPORT_VIEW_PROPERTY(onAddressChangeStart, RCTBubblingEventBlock)
 
     /**
      * Emitted when checkout is moving to payment selection screen

modules/@shopify/checkout-sheet-kit/ios/ShopifyCheckoutSheetKit.swift

@@ -53,7 +53,7 @@ class RCTShopifyCheckoutSheetKit: RCTEventEmitter, CheckoutDelegate {
     }
 
     override func supportedEvents() -> [String]! {
-        return ["close", "complete", "start", "error", "addressChangeIntent"]
+        return ["close", "complete", "start", "error", "addressChangeStart"]
     }
 
     override func startObserving() {
@@ -76,6 +76,12 @@ class RCTShopifyCheckoutSheetKit: RCTEventEmitter, CheckoutDelegate {
         }
     }
 
+    func checkoutDidStartAddressChange(event: CheckoutAddressChangeStart) {
+        if hasListeners {
+            sendEvent(withName: "addressChangeStart", body: ShopifyEventSerialization.serialize(checkoutAddressChangeStart: event))
+        }
+    }
+
     func shouldRecoverFromError(error: CheckoutError) -> Bool {
         return error.isRecoverable
     }

modules/@shopify/checkout-sheet-kit/src/components/Checkout.tsx

@@ -36,7 +36,7 @@ import type {
   CheckoutException,
 } from '..';
 import {useCheckoutEvents} from '../CheckoutEventProvider';
-import type {CheckoutAddressChangeIntent, CheckoutPaymentChangeIntent, CheckoutStartEvent} from '../events';
+import type {CheckoutAddressChangeStart, CheckoutPaymentChangeIntent, CheckoutStartEvent} from '../events';
 
 export interface CheckoutProps {
   /**
@@ -80,9 +80,12 @@ export interface CheckoutProps {
   onLinkClick?: (url: string) => void;
 
   /**
-   * Called when checkout requests an address change (e.g., for native address picker)
+   * Called when checkout starts an address change flow (e.g., for native address picker).
+   *
+   * Note: This callback is only invoked when native address selection is enabled
+   * for the authenticated app.
    */
-  onAddressChangeIntent?: (event: CheckoutAddressChangeIntent) => void;
+  onAddressChangeStart?: (event: CheckoutAddressChangeStart) => void;
 
   /**
    * Called when checkout requests a payment method change (e.g., for native payment selector)
@@ -93,6 +96,11 @@ export interface CheckoutProps {
    * Style for the webview container
    */
   style?: ViewStyle;
+
+  /**
+   * Test identifier for testing
+   */
+  testID?: string;
 }
 
 export interface CheckoutRef {
@@ -106,19 +114,14 @@ interface NativeCheckoutWebViewProps {
   checkoutUrl: string;
   auth?: string;
   style?: ViewStyle;
+  testID?: string;
   onLoad?: (event: {nativeEvent: {url: string}}) => void;
   onStart?: (event: {nativeEvent: CheckoutStartEvent}) => void;
   onError?: (event: {nativeEvent: CheckoutException}) => void;
   onComplete?: (event: {nativeEvent: CheckoutCompleteEvent}) => void;
   onCancel?: () => void;
   onLinkClick?: (event: {nativeEvent: {url: string}}) => void;
-  onAddressChangeIntent?: (event: {
-    nativeEvent: {
-      id: string;
-      type: string;
-      addressType: string;
-    };
-  }) => void;
+  onAddressChangeStart?: (event: {nativeEvent: CheckoutAddressChangeStart}) => void;
   onPaymentChangeIntent?: (event: {
     nativeEvent: {
       id: string;
@@ -186,9 +189,10 @@ export const Checkout = forwardRef<CheckoutRef, CheckoutProps>(
       onComplete,
       onCancel,
       onLinkClick,
-      onAddressChangeIntent,
+      onAddressChangeStart,
       onPaymentChangeIntent,
       style,
+      testID,
     },
     ref,
   ) => {
@@ -257,16 +261,14 @@ export const Checkout = forwardRef<CheckoutRef, CheckoutProps>(
       [onLinkClick],
     );
 
-    const handleAddressChangeIntent = useCallback<
-      Required<NativeCheckoutWebViewProps>['onAddressChangeIntent']
+    const handleAddressChangeStart = useCallback<
+      Required<NativeCheckoutWebViewProps>['onAddressChangeStart']
     >(
-      (event: {
-        nativeEvent: {id: string; type: string; addressType: string};
-      }) => {
+      (event: {nativeEvent: CheckoutAddressChangeStart}) => {
         if (!event.nativeEvent) return;
-        onAddressChangeIntent?.(event.nativeEvent);
+        onAddressChangeStart?.(event.nativeEvent);
       },
-      [onAddressChangeIntent],
+      [onAddressChangeStart],
     );
 
     const handlePaymentChangeIntent = useCallback<
@@ -317,13 +319,14 @@ export const Checkout = forwardRef<CheckoutRef, CheckoutProps>(
         checkoutUrl={checkoutUrl}
         auth={auth}
         style={style}
+        testID={testID}
         onLoad={handleLoad}
         onStart={handleStart}
         onError={handleError}
         onComplete={handleComplete}
         onCancel={handleCancel}
         onLinkClick={handleLinkClick}
-        onAddressChangeIntent={handleAddressChangeIntent}
+        onAddressChangeStart={handleAddressChangeStart}
         onPaymentChangeIntent={handlePaymentChangeIntent}
       />
     );