feat(shipping): CHECKOUT-3243 Support tracking loading and error states per consignment

Author: Luis Sanchez

src/address/address.ts

@@ -2,9 +2,16 @@ export default interface Address extends AddressRequestBody {
     country: string;
 }
 
-export interface AddressRequestBody {
-    id?: string;
+export interface BillingAddress extends Address {
+    id: string;
     email?: string;
+}
+
+export interface CustomerAddress extends Address {
+    id: string;
+}
+
+export interface AddressRequestBody {
     firstName: string;
     lastName: string;
     company: string;
@@ -21,3 +28,8 @@ export interface AddressRequestBody {
         fieldValue: string;
     }>;
 }
+
+export interface BillingAddressUpdateRequestBody extends AddressRequestBody {
+    id: string;
+    email?: string;
+}

src/address/map-from-internal-address.spec.ts

@@ -1,11 +1,13 @@
-import { getShippingAddress as getInternalShippingAddress } from '../shipping/internal-shipping-addresses.mock';
-import { getShippingAddress } from '../shipping/shipping-addresses.mock';
+import { omit } from 'lodash';
+
+import { getBillingAddress } from '../billing/billing-addresses.mock';
+import { getBillingAddress as getInternalBillingAddress } from '../billing/internal-billing-addresses.mock';
 
 import mapFromInternalAddress from './map-from-internal-address';
 
 describe('mapFromInternalAddress()', () => {
     it('maps from internal address', () => {
-        expect(mapFromInternalAddress(getInternalShippingAddress()))
-            .toEqual(getShippingAddress());
+        expect(mapFromInternalAddress(getInternalBillingAddress()))
+            .toEqual(omit(getBillingAddress(), 'email'));
     });
 });

src/address/map-from-internal-address.ts

@@ -1,7 +1,7 @@
-import Address from './address';
+import Address, { BillingAddress } from './address';
 import InternalAddress from './internal-address';
 
-export default function mapFromInternalAddress(address: InternalAddress): Address {
+export default function mapFromInternalAddress(address: InternalAddress): Address | BillingAddress {
     return {
         id: address.id,
         firstName: address.firstName,

src/address/map-to-internal-address.spec.ts

@@ -1,11 +1,19 @@
+import { getBillingAddress } from '../billing/billing-addresses.mock';
+import { getBillingAddress as getInternalBillingAddress } from '../billing/internal-billing-addresses.mock';
+import { getConsignment } from '../shipping/consignments.mock';
 import { getShippingAddress as getInternalShippingAddress } from '../shipping/internal-shipping-addresses.mock';
 import { getShippingAddress } from '../shipping/shipping-addresses.mock';
 
 import mapToInternalAddress from './map-to-internal-address';
 
 describe('mapToInternalAddress()', () => {
     it('maps to internal address', () => {
-        expect(mapToInternalAddress(getShippingAddress()))
+        expect(mapToInternalAddress(getBillingAddress()))
+            .toEqual(getInternalBillingAddress());
+    });
+
+    it('maps to internal shipping address when consignments are passed', () => {
+        expect(mapToInternalAddress(getShippingAddress(), [getConsignment()]))
             .toEqual(getInternalShippingAddress());
     });
 });

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

@@ -1,9 +1,19 @@
-import Address from './address';
+import { Consignment } from '../shipping';
+
+import Address, { BillingAddress } from './address';
 import InternalAddress from './internal-address';
 
-export default function mapToInternalAddress(address: Address, id?: string): InternalAddress {
+export default function mapToInternalAddress(address: Address | BillingAddress, consignments?: Consignment[]): InternalAddress {
+    let addressId;
+
+    if ((address as BillingAddress).id) {
+        addressId = (address as BillingAddress).id;
+    } else if (consignments && consignments.length) {
+        addressId = consignments[0].id;
+    }
+
     return {
-        id: id ? id : address.id,
+        id: addressId,
         firstName: address.firstName,
         lastName: address.lastName,
         company: address.company,

src/billing/billing-address-action-creator.ts

@@ -3,7 +3,7 @@ import { Response } from '@bigcommerce/request-sender';
 import { Observable } from 'rxjs/Observable';
 import { Observer } from 'rxjs/Observer';
 
-import { AddressRequestBody } from '../address';
+import { BillingAddressUpdateRequestBody } from '../address/address';
 import { Checkout, CheckoutClient, InternalCheckoutSelectors, ReadableCheckoutStore } from '../checkout';
 import { MissingDataError, MissingDataErrorType } from '../common/error/errors';
 import { RequestOptions } from '../common/http-request';
@@ -15,7 +15,7 @@ export default class BillingAddressActionCreator {
         private _checkoutClient: CheckoutClient
     ) {}
 
-    updateAddress(address: Partial<AddressRequestBody>, options?: RequestOptions): ThunkAction<UpdateBillingAddressAction, InternalCheckoutSelectors> {
+    updateAddress(address: Partial<BillingAddressUpdateRequestBody>, options?: RequestOptions): ThunkAction<UpdateBillingAddressAction, InternalCheckoutSelectors> {
         return store => Observable.create((observer: Observer<UpdateBillingAddressAction>) => {
             observer.next(createAction(BillingAddressActionType.UpdateBillingAddressRequested));
 
@@ -30,7 +30,7 @@ export default class BillingAddressActionCreator {
         });
     }
 
-    private _requestBillingAddressUpdate(store: ReadableCheckoutStore, address: Partial<AddressRequestBody>, options?: RequestOptions): Promise<Response<Checkout>> {
+    private _requestBillingAddressUpdate(store: ReadableCheckoutStore, address: Partial<BillingAddressUpdateRequestBody>, options?: RequestOptions): Promise<Response<Checkout>> {
         const state = store.getState();
         const checkout = state.checkout.getCheckout();
 

src/billing/billing-address-reducer.ts

@@ -1,6 +1,6 @@
 import { combineReducers } from '@bigcommerce/data-store';
 
-import { Address } from '../address';
+import { BillingAddress } from '../address/address';
 import { CheckoutAction, CheckoutActionType } from '../checkout';
 import { OrderAction, OrderActionType } from '../order';
 
@@ -26,9 +26,9 @@ export default function billingAddressReducer(
 }
 
 function dataReducer(
-    data: Address | undefined,
+    data: BillingAddress | undefined,
     action: CheckoutAction | BillingAddressAction | OrderAction
-): Address | undefined {
+): BillingAddress | undefined {
     switch (action.type) {
     case BillingAddressActionType.UpdateBillingAddressSucceeded:
     case CheckoutActionType.LoadCheckoutSucceeded:

src/billing/billing-address-request-sender.ts

@@ -1,6 +1,7 @@
 import { RequestSender, Response } from '@bigcommerce/request-sender';
 
 import { AddressRequestBody } from '../address';
+import { BillingAddressUpdateRequestBody } from '../address/address';
 import { Checkout } from '../checkout';
 import { ContentType, RequestOptions } from '../common/http-request';
 
@@ -25,7 +26,7 @@ export default class BillingAddressRequestSender {
         return this._requestSender.post(url, { body: address, params: DEFAULT_PARAMS, headers, timeout });
     }
 
-    updateAddress(checkoutId: string, address: Partial<AddressRequestBody>, { timeout }: RequestOptions = {}): Promise<Response<Checkout>> {
+    updateAddress(checkoutId: string, address: Partial<BillingAddressUpdateRequestBody>, { timeout }: RequestOptions = {}): Promise<Response<Checkout>> {
         const { id, ...body } = address;
         const url = `/api/storefront/checkouts/${checkoutId}/billing-address/${id}`;
         const headers = { Accept: ContentType.JsonV1 };

src/billing/billing-address-selector.ts

@@ -1,4 +1,4 @@
-import { Address } from '../address';
+import { BillingAddress } from '../address/address';
 import { selector } from '../common/selector';
 
 import BillingAddressState from './billing-address-state';
@@ -9,7 +9,7 @@ export default class BillingAddressSelector {
         private _billingAddress: BillingAddressState
     ) {}
 
-    getBillingAddress(): Address | undefined {
+    getBillingAddress(): BillingAddress | undefined {
         return this._billingAddress.data;
     }
 

src/billing/billing-address-state.ts

@@ -1,7 +1,7 @@
-import { Address } from '../address';
+import { BillingAddress } from '../address/address';
 
 export default interface BillingAddressState {
-    data?: Address;
+    data?: BillingAddress;
     errors: BillingAddressErrorsState;
     statuses: BillingAddressStatusesState;
 }