feat(order): CHECKOUT-3047 Include payments by default in OrderRequestSender

Author: Luis Sanchez

src/cart/map-to-internal-cart.ts

@@ -14,8 +14,6 @@ export default function mapToInternalCart(checkout: Checkout): InternalCart {
     const discountedAmount = reduce(checkout.cart.discounts, (sum, discount) => {
         return sum + discount.discountedAmount;
     }, 0);
-    // @todo: remove this once API returns shipping cost breakdown (CHECKOUT-3153)
-    const shippingAmountBeforeDiscount = checkout.shippingCostTotal + getShippingDiscount(checkout);
 
     return {
         id: checkout.cart.id,
@@ -41,8 +39,8 @@ export default function mapToInternalCart(checkout: Checkout): InternalCart {
         shipping: {
             amount: checkout.shippingCostTotal,
             integerAmount: amountTransformer.toInteger(checkout.shippingCostTotal),
-            amountBeforeDiscount: shippingAmountBeforeDiscount,
-            integerAmountBeforeDiscount: amountTransformer.toInteger(shippingAmountBeforeDiscount),
+            amountBeforeDiscount: checkout.shippingCostBeforeDiscount,
+            integerAmountBeforeDiscount: amountTransformer.toInteger(checkout.shippingCostBeforeDiscount),
             required: some(checkout.cart.lineItems.physicalItems, lineItem => lineItem.isShippingRequired),
         },
         subtotal: {
@@ -71,9 +69,3 @@ export default function mapToInternalCart(checkout: Checkout): InternalCart {
         },
     };
 }
-
-function getShippingDiscount(checkout: Checkout): number {
-    const coupon = checkout.cart.coupons.find(coupon => coupon.couponType === 'shipping_discount');
-
-    return coupon ? coupon.discountedAmount : 0;
-}

src/checkout/checkout-client.ts

@@ -8,7 +8,7 @@ import { Config, ConfigRequestSender } from '../config';
 import { GiftCertificateRequestSender } from '../coupon';
 import { CustomerCredentials, CustomerRequestSender } from '../customer';
 import { CountryRequestSender, CountryResponseBody } from '../geography';
-import { InternalOrderResponseBody, Order, OrderParams, OrderRequestBody, OrderRequestSender } from '../order';
+import { InternalOrderResponseBody, Order, OrderRequestBody, OrderRequestSender } from '../order';
 import { PaymentMethodsResponseBody, PaymentMethodRequestSender, PaymentMethodResponseBody } from '../payment';
 import { QuoteRequestSender } from '../quote';
 import {
@@ -56,18 +56,10 @@ export default class CheckoutClient {
         return this._cartRequestSender.loadCart(options);
     }
 
-    loadOrder(orderId: number, options?: RequestOptions<OrderParams>): Promise<Response<Order>> {
+    loadOrder(orderId: number, options?: RequestOptions): Promise<Response<Order>> {
         return this._orderRequestSender.loadOrder(orderId, options);
     }
 
-    /**
-     * @deprecated
-     * Remove once we fully transition to Storefront API
-     */
-    loadInternalOrder(orderId: number, options?: RequestOptions): Promise<Response<InternalOrderResponseBody>> {
-        return this._orderRequestSender.loadInternalOrder(orderId, options);
-    }
-
     submitOrder(body: OrderRequestBody, options?: RequestOptions): Promise<Response<InternalOrderResponseBody>> {
         return this._orderRequestSender.submitOrder(body, options);
     }

src/checkout/checkout-request-sender.ts

@@ -1,6 +1,6 @@
 import { RequestSender, Response } from '@bigcommerce/request-sender';
 
-import { transformParams, ContentType, RequestOptions } from '../common/http-request';
+import { ContentType, RequestOptions } from '../common/http-request';
 
 import Checkout from './checkout';
 import CheckoutParams from './checkout-params';
@@ -22,9 +22,9 @@ export default class CheckoutRequestSender {
         ];
 
         return this._requestSender.get(url, {
-            params: transformParams({
-                include: defaultIncludes.concat(params && params.include || []),
-            }),
+            params: {
+                include: defaultIncludes.concat(params && params.include || []).join(','),
+            },
             headers,
             timeout,
         });

src/checkout/checkout-service.spec.js

@@ -76,10 +76,6 @@ describe('CheckoutService', () => {
                 Promise.resolve(getResponse(getOrder()))
             ),
 
-            loadInternalOrder: jest.fn(() =>
-                Promise.resolve(getResponse(getCompleteOrderResponseBody()))
-            ),
-
             submitOrder: jest.fn(() =>
                 Promise.resolve(getResponse(getCompleteOrderResponseBody()))
             ),

src/checkout/checkout-service.ts

@@ -85,10 +85,10 @@ export default class CheckoutService {
     }
 
     loadOrder(orderId: number, options?: RequestOptions): Promise<CheckoutSelectors> {
-        return Promise.all([
-            this._store.dispatch(this._orderActionCreator.loadInternalOrder(orderId, options)),
-            this._store.dispatch(this._orderActionCreator.loadOrder(orderId, options)),
-        ]).then(() => this.getState());
+        const action = this._orderActionCreator.loadOrder(orderId, options);
+
+        return this._store.dispatch(action)
+            .then(() => this.getState());
     }
 
     submitOrder(payload: OrderRequestBody, options?: RequestOptions): Promise<CheckoutSelectors> {

src/checkout/checkout-store-reducers.typedef.js

@@ -7,7 +7,7 @@ import { StoreConfig } from '../config/config';
 import { CustomerSelector, InternalCustomer } from '../customer';
 import { FormField, FormSelector } from '../form';
 import { Country, CountrySelector } from '../geography';
-import { InternalIncompleteOrder, InternalOrder, OrderSelector } from '../order';
+import { InternalOrder, OrderSelector } from '../order';
 import { PaymentMethod, PaymentMethodSelector } from '../payment';
 import { Instrument, InstrumentSelector } from '../payment/instrument';
 import { InternalQuote, QuoteSelector } from '../quote';
@@ -68,7 +68,7 @@ export default class CheckoutStoreSelector {
         return this._checkout.getCheckout();
     }
 
-    getOrder(): InternalOrder | InternalIncompleteOrder | undefined {
+    getOrder(): InternalOrder | undefined {
         return this._order.getOrder();
     }
 

src/checkout/checkout-store-selector.ts

@@ -19,6 +19,7 @@ export default interface Checkout {
     coupons: Coupon[];
     orderId: number;
     shippingCostTotal: number;
+    shippingCostBeforeDiscount: number;
     handlingCostTotal: number;
     taxTotal: number;
     grandTotal: number;

src/checkout/checkout.ts

@@ -40,6 +40,7 @@ export function getCheckout(): Checkout {
         coupons: [],
         orderId: 295,
         shippingCostTotal: 15,
+        shippingCostBeforeDiscount: 20,
         handlingCostTotal: 8,
         taxTotal: 0,
         grandTotal: 190,

src/checkout/checkouts.mock.ts

@@ -1,4 +1,3 @@
 export { default as InternalResponseBody } from './internal-response-body';
 export { default as ContentType } from './content-type';
 export { default as RequestOptions } from './request-options';
-export { default as transformParams } from './transform-params';