Add estimated shipping and taxes endpoint (#16)

* adding estimated shipping and taxes endpoint

* Adding rsa enabled info to initial data

---------

Co-authored-by: shagufa-ali <80478231+shagufa-ali@users.noreply.github.com>

Author: Shagufa92

src/shipping/estimateShippingLines.ts

@@ -0,0 +1,24 @@
+import {
+    apiTypeKeys,
+    apiTypes,
+    fetchAPI,
+    getApiOptions,
+    getApiUrl,
+    IApiReturnObject,
+    checkApiResponse,
+    IEstimateShippingLinesRequest
+} from 'src';
+
+/**
+ *
+ * Retrieve the estimated shipping lines
+ *
+ */
+export async function estimateShippingLines(requestBody: IEstimateShippingLinesRequest, numOfRetries = 0): Promise<IApiReturnObject> {
+    const {estimateShippingLines} = apiTypeKeys;
+    const url = getApiUrl(estimateShippingLines);
+    const options = getApiOptions(estimateShippingLines, requestBody);
+    const fetchRes = await fetchAPI(url, options, numOfRetries);
+    const {keysToTest} = apiTypes.estimateShippingLines;
+    return checkApiResponse(fetchRes, keysToTest);
+}

src/shipping/index.ts

@@ -1,2 +1,3 @@
 export * from './getShippingLines';
+export * from './estimateShippingLines';
 export * from './changeShippingLine';

src/taxes/estimateTaxes.ts

@@ -0,0 +1,23 @@
+import {
+    apiTypeKeys,
+    fetchAPI,
+    getApiUrl,
+    getApiOptions,
+    IApiReturnObject,
+    checkApiResponse,
+    apiTypes,
+    IEstimateTaxRequest,
+} from 'src';
+
+/** estimateTaxes
+ *
+ * Get the estimated taxes on the order
+ */
+export async function estimateTaxes(requestBody: IEstimateTaxRequest, numOfRetries = 0): Promise<IApiReturnObject> {
+    const {estimateTaxes} = apiTypeKeys;
+    const options = getApiOptions(estimateTaxes, requestBody);
+    const url = getApiUrl(estimateTaxes);
+    const fetchRes = await fetchAPI(url, options, numOfRetries);
+    const {keysToTest} = apiTypes.estimateTaxes;
+    return checkApiResponse(fetchRes, keysToTest);
+}

src/taxes/index.ts

@@ -1 +1,2 @@
+export * from './estimateTaxes';
 export * from './setTaxes';

src/types/apiInterfaces.ts

@@ -295,6 +295,8 @@ export interface IApiTypes {
     walletPayCreateOrder: IApiTypesDetail,
     walletPayOnShipping: IApiTypesDetail,
     walletPayOnApprove: IApiTypesDetail,
+    estimateShippingLines: IApiTypesDetail,
+    estimateTaxes: IApiTypesDetail,
 }
 
 export interface IApiTypeKeys {
@@ -334,6 +336,8 @@ export interface IApiTypeKeys {
     walletPayCreateOrder: keyof  IApiTypes;
     walletPayOnShipping: keyof  IApiTypes;
     walletPayOnApprove: keyof  IApiTypes;
+    estimateShippingLines: keyof  IApiTypes;
+    estimateTaxes: keyof  IApiTypes;
 }
 
 export interface IValidateAddress {
@@ -427,6 +431,7 @@ export interface ICheckoutProcess{
     tax_exempt_checkbox_enabled?: boolean,
     tax_shipping?: boolean,
     batch_requests?: boolean,
+    rsa_enabled?: boolean,
 }
 
 export interface IAddressAutoComplete{
@@ -812,6 +817,9 @@ export type IUpdatePaymentRequest = IAddPaymentRequest;
 
 export type IDeletePaymentRequest = IAddPaymentRequest;
 
+export type IEstimateTaxRequest = IAddress;
+export type IEstimateShippingLinesRequest = IAddress;
+
 export interface IPatchOrderMetaDataRequest {
     cart_parameters: ICartParameters | null;
     note_attributes: ICartParameters | null;
@@ -839,6 +847,8 @@ export type IGetApiOptionsBody =
     IWalletPayOnApproveRequest |
     IWalletPayCreateOrderRequest |
     IWalletPayOnShippingRequest |
+    IEstimateTaxRequest |
+    IEstimateShippingLinesRequest |
     Record<string, unknown>;
 
 export interface IShippingLine {

src/variables/constants.ts

@@ -316,6 +316,18 @@ export const apiTypes: IApiTypes = {
         useJwt: true,
         keysToTest: [...appStateKeysToTest]
     },
+    estimateTaxes: {
+        path: '/taxes/estimate',
+        method: methods.POST,
+        useJwt: true,
+        keysToTest: [...appStateKeysToTest]
+    },
+    estimateShippingLines: {
+        path: '/shipping_lines/estimate',
+        method: methods.POST,
+        useJwt: true,
+        keysToTest: [...appStateKeysToTest]
+    },
 };
 
 export const apiTypeKeys: IApiTypeKeys = {
@@ -355,6 +367,8 @@ export const apiTypeKeys: IApiTypeKeys = {
     walletPayCreateOrder: 'walletPayCreateOrder',
     walletPayOnShipping: 'walletPayOnShipping',
     walletPayOnApprove: 'walletPayOnApprove',
+    estimateShippingLines: 'estimateShippingLines',
+    estimateTaxes: 'estimateTaxes',
 };
 
 export const baseReturnObject: IApiReturnObject = {

src/variables/mocks.ts

@@ -334,7 +334,8 @@ export const orderInitialDataMock: IOrderInitialData = {
         checkout_process: {
             company_name_option: 'required',
             phone_number_required: false,
-            accepts_marketing_checkbox_option: 'checked'
+            accepts_marketing_checkbox_option: 'checked',
+            rsa_enabled: false,
         },
         address_autocomplete: {
             provider: null,

src/variables/variables.ts

@@ -147,7 +147,8 @@ export const generalSettings: IGeneralSettings = {
         accepts_marketing_checkbox_option: 'checked',
         tax_exempt_checkbox_enabled: undefined,
         tax_shipping: true,
-        batch_requests: false
+        batch_requests: false,
+        rsa_enabled: false
     },
     address_autocomplete: {
         provider: null,

tests/shipping/estimateShippingLine.test.ts

@@ -0,0 +1,69 @@
+import {apiTypeKeys, baseReturnObject, methods, apiTypes, estimateShippingLines} from 'src';
+import {applicationStateMock, selectShippingLineMock, shippingAddressMock} from 'src/variables/mocks';
+import * as fetchAPI from 'src/utils/fetchAPI';
+import * as getApiOptions from 'src/utils/getApiOptions';
+import * as apiUrl from 'src/utils/apiUrl';
+import * as apiResponse from 'src/utils/apiResponse';
+
+describe('testing estimate shipping lines api', () => {
+    const returnObject = {...baseReturnObject};
+    const timesWhenCalled = 1;
+    const apiUrlMock = 'https://api.com/checkout/storefront/123/123/addresses/shipping/estimate';
+    const {keysToTest} = apiTypes.estimateShippingLines;
+    let optionsMock: RequestInit;
+    let getApiOptionsSpy: jest.SpyInstance;
+    let getApiUrlSpy: jest.SpyInstance;
+    let fetchApiSpy: jest.SpyInstance;
+    let checkApiResponseSpy: jest.SpyInstance;
+
+    beforeEach(() => {
+        global.Headers = jest.fn().mockReturnValue({
+            append: jest.fn(() => null)
+        });
+        optionsMock = {method: methods.POST, headers: new Headers(), body: JSON.stringify({})};
+        getApiOptionsSpy = jest.spyOn(getApiOptions, 'getApiOptions').mockReturnValue(optionsMock);
+        getApiUrlSpy = jest.spyOn(apiUrl, 'getApiUrl').mockReturnValue(apiUrlMock);
+        fetchApiSpy = jest.spyOn(fetchAPI, 'fetchAPI').mockReturnValue(Promise.resolve(returnObject));
+        checkApiResponseSpy = jest.spyOn(apiResponse, 'checkApiResponse').mockReturnValue(returnObject);
+        returnObject.response = { data: { selected_shipping: selectShippingLineMock, application_state: applicationStateMock }};
+        returnObject.success = true;
+    });
+
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+
+    test('calling shippingLines', async () => {
+        const res = await estimateShippingLines(shippingAddressMock);
+
+        expect(getApiOptionsSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiUrlSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(fetchApiSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(checkApiResponseSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.estimateShippingLines, shippingAddressMock);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.estimateShippingLines);
+        expect(fetchApiSpy).toHaveBeenCalledWith(apiUrlMock, optionsMock, 0);
+        expect(checkApiResponseSpy).toHaveBeenCalledWith(returnObject, keysToTest);
+        expect(res).toStrictEqual(returnObject);
+    });
+
+    test('calling shippingLines w/ success = false', async () => {
+        const tempReturnObject = {...baseReturnObject};
+
+        fetchApiSpy.mockReturnValueOnce(Promise.resolve(tempReturnObject));
+        checkApiResponseSpy.mockReturnValueOnce(tempReturnObject);
+
+        const res = await estimateShippingLines(shippingAddressMock, 1);
+
+        expect(getApiOptionsSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiUrlSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(fetchApiSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(checkApiResponseSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.estimateShippingLines, shippingAddressMock);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.estimateShippingLines);
+        expect(fetchApiSpy).toHaveBeenCalledWith(apiUrlMock, optionsMock, 1);
+        expect(checkApiResponseSpy).toHaveBeenCalledWith(tempReturnObject, keysToTest);
+        expect(res).toStrictEqual(tempReturnObject);
+    });
+
+});

tests/taxes/estimateTaxes.test.ts

@@ -0,0 +1,61 @@
+import {apiTypeKeys, baseReturnObject, estimateTaxes, methods} from 'src';
+import * as fetchAPI from 'src/utils/fetchAPI';
+import * as getApiOptions from 'src/utils/getApiOptions';
+import * as apiUrl from 'src/utils/apiUrl';
+import {applicationStateMock, shippingAddressMock, taxesArrayMock} from 'src/variables/mocks';
+import * as apiResponse from 'src/utils/apiResponse';
+
+describe('testing estimate taxes api', () => {
+    const returnObject = {...baseReturnObject};
+    const timesWhenCalled = 1;
+    const apiUrlMock = 'https://api.com/checkout/storefront/123/123/taxes/estimate';
+    let optionsMock: RequestInit;
+    let getApiOptionsSpy: jest.SpyInstance;
+    let getApiUrlSpy: jest.SpyInstance;
+    let fetchApiSpy: jest.SpyInstance;
+    let checkApiResponseSpy: jest.SpyInstance;
+
+    beforeEach(() => {
+        global.Headers = jest.fn().mockReturnValue({append: jest.fn()});
+        optionsMock = {method: methods.POST, headers: new Headers(), body: JSON.stringify({})};
+        getApiOptionsSpy = jest.spyOn(getApiOptions, 'getApiOptions').mockReturnValue(optionsMock);
+        getApiUrlSpy = jest.spyOn(apiUrl, 'getApiUrl').mockReturnValue(apiUrlMock);
+        fetchApiSpy = jest.spyOn(fetchAPI, 'fetchAPI').mockReturnValue(Promise.resolve(returnObject));
+        checkApiResponseSpy = jest.spyOn(apiResponse, 'checkApiResponse').mockReturnValue(returnObject);
+        returnObject.response = { data: { taxes: taxesArrayMock, application_state: applicationStateMock }};
+        returnObject.success = true;
+    });
+
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+
+    test('calling setTaxes', async () => {
+        const res = await estimateTaxes(shippingAddressMock);
+
+        expect(getApiOptionsSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiUrlSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(fetchApiSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.estimateTaxes, shippingAddressMock);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.estimateTaxes);
+        expect(fetchApiSpy).toHaveBeenCalledWith(apiUrlMock, optionsMock, 0);
+        expect(res).toStrictEqual(returnObject);
+    });
+
+    test('calling setTaxes w/ success = false', async () => {
+        const tempReturnObject = {...baseReturnObject};
+        checkApiResponseSpy.mockReturnValueOnce(tempReturnObject);
+        fetchApiSpy.mockReturnValueOnce(Promise.resolve(tempReturnObject));
+
+        const res = await estimateTaxes(shippingAddressMock, 1);
+
+        expect(getApiOptionsSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiUrlSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(fetchApiSpy).toHaveBeenCalledTimes(timesWhenCalled);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.estimateTaxes, shippingAddressMock);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.estimateTaxes);
+        expect(fetchApiSpy).toHaveBeenCalledWith(apiUrlMock, optionsMock, 1);
+        expect(res).toStrictEqual(tempReturnObject);
+    });
+});
+