feature(payment): GooglePay-3307 Add requireShippingAddress prop to initialize call

Author: twm-jamieb

docs/interfaces/GooglePayCustomerInitializeOptions.md

@@ -9,6 +9,7 @@
 - [buttonColor](GooglePayCustomerInitializeOptions.md#buttoncolor)
 - [buttonType](GooglePayCustomerInitializeOptions.md#buttontype)
 - [container](GooglePayCustomerInitializeOptions.md#container)
+- [requireShippingAddress](GooglePayCustomerInitializeOptions.md#requireshippingaddress)
 
 ### Methods
 

packages/google-pay-integration/src/gateways/google-pay-adyenv2-gateway.ts

@@ -37,10 +37,16 @@ export default class GooglePayAdyenV2 extends GooglePayGateway {
 
     async initialize(
         getPaymentMethod: () => PaymentMethod<GooglePayInitializationData>,
+        requireShippingAddress?: boolean,
         isBuyNowFlow?: boolean,
         currencyCode?: string,
     ): Promise<void> {
-        await super.initialize(getPaymentMethod, isBuyNowFlow, currencyCode);
+        await super.initialize(
+            getPaymentMethod,
+            requireShippingAddress,
+            isBuyNowFlow,
+            currencyCode,
+        );
 
         const paymentMethod = super.getPaymentMethod();
         const state = this._service.getState();

packages/google-pay-integration/src/gateways/google-pay-adyenv3-gateway.ts

@@ -37,10 +37,16 @@ export default class GooglePayAdyenV3 extends GooglePayGateway {
 
     async initialize(
         getPaymentMethod: () => PaymentMethod<GooglePayInitializationData>,
+        requireShippingAddress?: boolean,
         isBuyNowFlow?: boolean,
         currencyCode?: string,
     ): Promise<void> {
-        await super.initialize(getPaymentMethod, isBuyNowFlow, currencyCode);
+        await super.initialize(
+            getPaymentMethod,
+            requireShippingAddress,
+            isBuyNowFlow,
+            currencyCode,
+        );
 
         const paymentMethod = super.getPaymentMethod();
         const state = this._service.getState();

packages/google-pay-integration/src/gateways/google-pay-braintree-gateway.ts

@@ -36,10 +36,16 @@ export default class GooglePayBraintreeGateway extends GooglePayGateway {
 
     async initialize(
         getPaymentMethod: () => PaymentMethod<GooglePayInitializationData>,
+        requireShippingAddress?: boolean,
         isBuyNowFlow?: boolean,
         currencyCode?: string,
     ): Promise<void> {
-        await super.initialize(getPaymentMethod, isBuyNowFlow, currencyCode);
+        await super.initialize(
+            getPaymentMethod,
+            requireShippingAddress,
+            isBuyNowFlow,
+            currencyCode,
+        );
 
         let paymentMethod = super.getPaymentMethod();
 

packages/google-pay-integration/src/gateways/google-pay-gateway.spec.ts

@@ -149,7 +149,7 @@ describe('GooglePayGateway', () => {
                 totalPrice: '0',
             };
 
-            await gateway.initialize(getGeneric, true, 'USD');
+            await gateway.initialize(getGeneric, false, true, 'USD');
 
             expect(gateway.getTransactionInfo()).toStrictEqual(expectedInfo);
             expect(paymentIntegrationService.getState().getCartOrThrow).not.toHaveBeenCalled();
@@ -158,7 +158,7 @@ describe('GooglePayGateway', () => {
         describe('should fail if:', () => {
             it('currencyCode is not passed (Buy Now flow)', async () => {
                 try {
-                    await gateway.initialize(getGeneric, true);
+                    await gateway.initialize(getGeneric, false, true);
                 } catch (error) {
                     expect(error).toBeInstanceOf(InvalidArgumentError);
                 }
@@ -232,6 +232,22 @@ describe('GooglePayGateway', () => {
 
             await expect(gateway.getRequiredData()).resolves.toStrictEqual(expectedRequiredData);
         });
+
+        it('should require shipping address and options', async () => {
+            const expectedRequiredData = {
+                emailRequired: true,
+                shippingAddressRequired: true,
+                shippingOptionRequired: true,
+                shippingAddressParameters: {
+                    phoneNumberRequired: true,
+                    allowedCountryCodes: ['AU', 'US', 'JP'],
+                },
+            };
+
+            await gateway.initialize(getGeneric, true);
+
+            await expect(gateway.getRequiredData()).resolves.toStrictEqual(expectedRequiredData);
+        });
     });
 
     describe('#getCallbackIntents', () => {

packages/google-pay-integration/src/gateways/google-pay-gateway.ts

@@ -43,6 +43,7 @@ import {
 
 export default class GooglePayGateway {
     private _getPaymentMethodFn?: () => PaymentMethod<GooglePayInitializationData>;
+    private _requireShippingAddress?: boolean;
     private _isBuyNowFlow = false;
     private _currencyCode?: string;
     private _currencyService?: CurrencyService;
@@ -258,10 +259,12 @@ export default class GooglePayGateway {
 
     initialize(
         getPaymentMethod: () => PaymentMethod<GooglePayInitializationData>,
+        requireShippingAddress?: boolean,
         isBuyNowFlow?: boolean,
         currencyCode?: string,
     ): Promise<void> {
         this._getPaymentMethodFn = getPaymentMethod;
+        this._requireShippingAddress = requireShippingAddress;
         this._isBuyNowFlow = Boolean(isBuyNowFlow);
         this._currencyCode = currencyCode;
 
@@ -446,6 +449,10 @@ export default class GooglePayGateway {
     }
 
     private _isShippingAddressRequired(): boolean {
+        if (this._requireShippingAddress) {
+            return true;
+        }
+
         const { getCartOrThrow, getStoreConfig, getShippingAddress } =
             this._paymentIntegrationService.getState();
 

packages/google-pay-integration/src/google-pay-bigcommerce-payments/google-pay-bigcommerce-payments-gateway.ts

@@ -31,6 +31,7 @@ export default class GooglePayBigCommercePaymentsGateway extends GooglePayGatewa
 
     async initialize(
         getPaymentMethod: () => PaymentMethod<GooglePayPayPalCommerceInitializationData>,
+        requireShippingAddress?: boolean,
         isBuyNowFlow?: boolean,
         currencyCode?: string,
     ): Promise<void> {
@@ -40,7 +41,7 @@ export default class GooglePayBigCommercePaymentsGateway extends GooglePayGatewa
             throw new MissingDataError(MissingDataErrorType.MissingPaymentMethod);
         }
 
-        await super.initialize(getPaymentMethod, isBuyNowFlow, currency);
+        await super.initialize(getPaymentMethod, requireShippingAddress, isBuyNowFlow, currency);
 
         const paymentMethod = super.getPaymentMethod();
 

packages/google-pay-integration/src/google-pay-button-strategy.ts

@@ -95,6 +95,7 @@ export default class GooglePayButtonStrategy implements CheckoutButtonStrategy {
             await this._googlePayPaymentProcessor.initialize(
                 () => paymentMethod,
                 this._getGooglePayClientOptions(),
+                false,
                 !!buyNowInitializeOptions,
                 currencyCode,
             );

packages/google-pay-integration/src/google-pay-customer-initialize-options.ts

@@ -30,6 +30,11 @@ export default interface GooglePayCustomerInitializeOptions {
      */
     buttonType?: GooglePayButtonType;
 
+    /**
+     * Require GooglePay to provide shipping address and methods.
+     */
+    requireShippingAddress?: boolean;
+
     /**
      * A callback that gets called when GooglePay fails to initialize or
      * selects a payment option.

packages/google-pay-integration/src/google-pay-customer-strategy.ts

@@ -66,6 +66,7 @@ export default class GooglePayCustomerStrategy implements CustomerStrategy {
             await this._googlePayPaymentProcessor.initialize(
                 () => paymentMethod,
                 this._getGooglePayClientOptions(paymentMethod.initializationData?.storeCountry),
+                googlePayOptions.requireShippingAddress,
             );
         } catch {
             return;