Release Version - 0.52.0

Author: shagufa-ali

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@boldcommerce/checkout-frontend-library",
-  "version": "0.51.0",
+  "version": "0.52.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "license": "MIT",

package.json

@@ -0,0 +1,27 @@
+import {
+    apiTypeKeys,
+    checkApiResponse,
+    fetchAPI,
+    getApiOptions,
+    getApiUrl,
+    IApiReturnObject,
+    ICreatePaymentGatewayOrderRequest,
+    keysToTestFromResponse,
+} from 'src';
+
+/** addPayment
+ *
+ * Adds a new payment to the order.
+ *
+ * @param {@link ICreatePaymentGatewayOrderRequest} requestBody - create payment gateway order for specific payment gateways.
+ * @param {number} [numOfRetries=0] - Number of retries for some HTTP errors - Number from 0 to 5
+ *
+ * @returns {Promise<IApiReturnObject>} response
+ */
+export async function createPaymentGatewayOrder(requestBody: ICreatePaymentGatewayOrderRequest, numOfRetries= 0): Promise<IApiReturnObject> {
+    const {createPaymentGatewayOrder} = apiTypeKeys;
+    const options = getApiOptions(createPaymentGatewayOrder, requestBody);
+    const url = getApiUrl(createPaymentGatewayOrder);
+    const fetchRes = await fetchAPI(url, options, numOfRetries);
+    return checkApiResponse(fetchRes, [keysToTestFromResponse.data, keysToTestFromResponse.applicationState]);
+}

src/payment/createPaymentGatewayOrder.ts

@@ -2,4 +2,5 @@ export * from './addPayment';
 export * from './deletePayment';
 export * from './deleteGiftCardPayment';
 export * from './getPaymentList';
+export * from './createPaymentGatewayOrder';
 export * from './updatePayment';

src/payment/index.ts

@@ -24,6 +24,7 @@ export function setApplicationState({
     order_meta_data,
     shipping,
     order_total,
+    order_balance,
     resumable_link,
     created_via,
     is_processed,
@@ -47,6 +48,7 @@ export function setApplicationState({
         applicationState.display_exchange_rate = display_exchange_rate;
     }
     applicationState.order_total = order_total;
+    applicationState.order_balance = order_balance;
     applicationState.resumable_link = resumable_link;
     applicationState.created_via = created_via;
     applicationState.is_processed = is_processed;

src/state/setApplicationState.ts

@@ -17,6 +17,7 @@ export interface IApiSuccessResponse {
         ICssStylingPaymentIframeResponse |
         ICheckInventoryResponse |
         IAddPaymentResponse |
+        ICreatePaymentGatewayOrderResponse |
         IUpdateLineItemQuantityResponse |
         IProcessOrderResponse |
         IPatchOrderMetaDataResponse |
@@ -103,6 +104,7 @@ export interface IAlternatePaymentMethodType {
     BRAINTREE_GOOGLE: string;
     BRAINTREE_APPLE: string;
     PPCP_APPLE: string;
+    PPCP: string;
 }
 
 export type IInventoryStage = 'initial' | 'final';
@@ -212,6 +214,15 @@ export interface IAddPaymentResponse {
     application_state: IApplicationState | undefined;
 }
 
+export interface ICreatePaymentGatewayOrderPaypalResponse {
+    id: string
+}
+
+export interface ICreatePaymentGatewayOrderResponse {
+    data: ICreatePaymentGatewayOrderPaypalResponse | Record<string, unknown>;
+    application_state: IApplicationState | undefined;
+}
+
 export interface IGetPaymentIframeUrl {
     url: string | undefined;
 }
@@ -261,6 +272,7 @@ export interface IApiTypes {
     checkInventory: IApiTypesDetail;
     validateDiscount: IApiTypesDetail;
     getPaymentList: IApiTypesDetail;
+    createPaymentGatewayOrder: IApiTypesDetail;
     addPayment: IApiTypesDetail;
     updatePayment: IApiTypesDetail;
     deletePayment: IApiTypesDetail;
@@ -298,6 +310,7 @@ export interface IApiTypeKeys {
     validateDiscount: keyof  IApiTypes;
     getPaymentList: keyof  IApiTypes;
     addPayment: keyof  IApiTypes;
+    createPaymentGatewayOrder: keyof  IApiTypes;
     updatePayment: keyof  IApiTypes;
     deletePayment: keyof  IApiTypes;
     deleteGiftCardPayment: keyof  IApiTypes;
@@ -347,7 +360,7 @@ export interface IApiTypesDetail {
     keysToTest?: Array<string>;
 }
 
-export type IAlternativePaymentMethod = Array<IExpressPayStripe | IExpressPayPaypal | IExpressPayBraintreeGoogle | IExpressPayBraintreeApple | IExpressPayPaypalCommercePlatform> ;
+export type IAlternativePaymentMethod = Array<IExpressPayStripe | IExpressPayPaypal | IExpressPayBraintreeGoogle | IExpressPayBraintreeApple | IExpressPayPaypalCommercePlatform | IExpressPayPaypalCommercePlatformButton> ;
 export type IExternalPaymentGateways = Array<IExternalPaymentGateway>;
 
 export interface IOrderInitialData {
@@ -434,6 +447,19 @@ export interface IExpressPayPaypalCommercePlatform {
     merchant_id: string;
 }
 
+export interface IExpressPayPaypalCommercePlatformButton {
+    'public_id': string,
+    'merchant_id': string,
+    'partner_id': string,
+    'is_3ds_enabled': boolean,
+    'style': Record<string, unknown>,
+    'apple_pay_enabled': boolean,
+    'type': string,
+    'merchant_country': string,
+    'payment_types': Record<string, unknown>,
+    'is_dev': boolean
+}
+
 export interface IExpressPayBraintree {
     type: string;
     public_id: string;
@@ -497,6 +523,7 @@ export interface IApplicationState {
     discounts: Array<IDiscount>;
     payments: Array<IPayment>;
     order_total: number;
+    order_balance: number;
     order_meta_data: IOrderMetaData;
     currency: ICurrency;
     display_currency: ICurrency | null;
@@ -729,6 +756,16 @@ export interface IAddPaymentRequest {
     custom_attributes?: Record<string, string|number|boolean>;
 }
 
+export interface ICreatePaymentGatewayOrderPaypalPayload {
+    payment_type: string;
+    locale: string;
+}
+
+export interface ICreatePaymentGatewayOrderRequest{
+    gateway_type: string;
+    payment_data: ICreatePaymentGatewayOrderPaypalPayload | Record<string, unknown>
+}
+
 export type IUpdatePaymentRequest = IAddPaymentRequest;
 
 export type IDeletePaymentRequest = IAddPaymentRequest;
@@ -757,6 +794,7 @@ export type IGetApiOptionsBody =
     IUpdatePaymentRequest |
     IDeletePaymentRequest |
     IPatchOrderMetaDataRequest |
+    ICreatePaymentGatewayOrderRequest |
     Record<string, unknown>;
 
 export interface IShippingLine {

src/types/apiInterfaces.ts

@@ -0,0 +1,35 @@
+
+import {
+    apiTypeKeys,
+    getBillingAddress,
+    getShippingAddress,
+    IAddress,
+    IBatchableRequest
+} from 'src';
+import {isObjectEmpty} from 'src/utils/isObjectEmpty';
+import {isObjectEquals} from 'src/utils/isObjectEquals';
+
+
+export const buildAddressBatchRequest = (
+    address: IAddress,
+    type: 'shipping'|'billing'
+): IBatchableRequest | null => {
+    const {setBillingAddress, updateBillingAddress, setShippingAddress, updateShippingAddress} = apiTypeKeys;
+
+    const prevAddress = type === 'shipping' ? getShippingAddress() : getBillingAddress();
+    const isPrevEmpty = isObjectEmpty(prevAddress);
+    const isEqual = isObjectEquals(prevAddress, address);
+
+    if (isPrevEmpty && !isEqual) {
+        return {
+            apiType: type === 'shipping' ? setShippingAddress : setBillingAddress,
+            payload: address
+        };
+    } else if (!isEqual) {
+        return {
+            apiType: type === 'shipping' ? updateShippingAddress : updateBillingAddress,
+            payload: address
+        };
+    }
+    return null;
+};

src/utils/buildAddressBatchRequest.ts

@@ -0,0 +1,28 @@
+import {apiTypeKeys, getApplicationState, IBatchableRequest} from 'src';
+import {isObjectEmpty, isObjectEquals} from 'src/utils';
+
+
+export const buildCustomerBatchRequest = (firstName: string, lastName: string, email: string): IBatchableRequest | null => {
+    const {addGuestCustomer, updateCustomer} = apiTypeKeys;
+    const {customer: prevCustomer} = getApplicationState();
+    const previous = {
+        email: prevCustomer.email_address,
+        firstName: prevCustomer.first_name,
+        lastName: prevCustomer.last_name
+    };
+    const userLogin = !!prevCustomer.platform_id && prevCustomer.platform_id !== '0';
+    if (!userLogin) {
+        const payload = {
+            first_name: firstName,
+            last_name: lastName,
+            email_address: email,
+            accepts_marketing: prevCustomer.accepts_marketing
+        };
+        if (isObjectEmpty(previous)) {
+            return {apiType: addGuestCustomer, payload};
+        } else if (!isObjectEquals({firstName, lastName, email}, previous)) {
+            return {apiType: updateCustomer, payload};
+        }
+    }
+    return null;
+};

src/utils/buildCustomerBatchRequest.ts

@@ -2,8 +2,12 @@ export * from './fetchAPI';
 export * from './fetchError';
 export * from './apiUrl';
 export * from './getApiOptions';
+export * from './buildAddressBatchRequest';
+export * from './buildCustomerBatchRequest';
 export * from './getSubrequestApiOptions';
 export * from './apiResponse';
 export * from './isObject';
 export * from './findKeyInObject';
 export * from './getErrorFromFieldName';
+export * from './isObjectEmpty';
+export * from './isObjectEquals';

src/utils/index.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+export function isObjectEmpty(object: any): boolean {
+    return object ? Object.values(object).every(x => x === null || x === '' || x === undefined) : true;
+}