/** * External dependencies */ import { select } from '@wordpress/data-controls'; /** * Internal dependencies */ import { ACTION_TYPES as types } from './action-types'; import { STORE_KEY as CART_STORE_KEY } from './constants'; import { apiFetchWithHeaders } from '../shared-controls'; /** * Returns an action object used in updating the store with the provided items * retrieved from a request using the given querystring. * * This is a generic response action. * * @param {Object} [response={}] An object containing the response from the * request. * @return {Object} Object for action. */ export function receiveCart( response = {} ) { return { type: types.RECEIVE_CART, response, }; } /** * Returns an action object used for receiving customer facing errors from the * API. * * @param {Object} [error={}] An error object containing the error message * and response code. * @param {boolean} [replace=true] Should existing errors be replaced, or should * the error be appended. * @return {Object} Object for action. */ export function receiveError( error = {}, replace = true ) { return { type: replace ? types.REPLACE_ERRORS : types.RECEIVE_ERROR, error, }; } /** * Returns an action object used to track when a coupon is applying. * * @param {string} [couponCode] Coupon being added. * @return {Object} Object for action. */ export function receiveApplyingCoupon( couponCode ) { return { type: types.APPLYING_COUPON, couponCode, }; } /** * Returns an action object used to track when a coupon is removing. * * @param {string} [couponCode] Coupon being removed. * @return {Object} Object for action. */ export function receiveRemovingCoupon( couponCode ) { return { type: types.REMOVING_COUPON, couponCode, }; } /** * Returns an action object for updating a single cart item in the store. * * @param {Object} [response={}] A cart item API response. * @return {Object} Object for action. */ export function receiveCartItem( response = {} ) { return { type: types.RECEIVE_CART_ITEM, cartItem: response, }; } /** * Returns an action object to indicate if the specified cart item * quantity is being updated. * * @param {string} cartItemKey Cart item being updated. * @param {boolean} isPendingQuantity Flag for update state; true if API request * is pending. * @return {Object} Object for action. */ export function itemIsPendingQuantity( cartItemKey, isPendingQuantity = true ) { return { type: types.ITEM_PENDING_QUANTITY, cartItemKey, isPendingQuantity, }; } /** * Returns an action object to remove a cart item from the store. * * @param {string} cartItemKey Cart item to remove. * @param {boolean} isPendingDelete Flag for update state; true if API request * is pending. * @return {Object} Object for action. */ export function itemIsPendingDelete( cartItemKey, isPendingDelete = true ) { return { type: types.RECEIVE_REMOVED_ITEM, cartItemKey, isPendingDelete, }; } /** * Returns an action object used to track when customer data is being updated (billing and/or shipping). * * @param {boolean} isResolving if we're updating customer data or not. * @return {Object} Object for action. */ export function updatingCustomerData( isResolving ) { return { type: types.UPDATING_CUSTOMER_DATA, isResolving, }; } /** * Returns an action object used to track whether the shipping rate is being * selected or not. * * @param {boolean} isResolving True if shipping rate is being selected. * * @return {Object} Action object. */ export function shippingRatesBeingSelected( isResolving ) { return { type: types.UPDATING_SELECTED_SHIPPING_RATE, isResolving, }; } /** * Applies a coupon code and either invalidates caches, or receives an error if * the coupon cannot be applied. * * @throws Will throw an error if there is an API problem. * @param {string} couponCode The coupon code to apply to the cart. */ export function* applyCoupon( couponCode ) { yield receiveApplyingCoupon( couponCode ); try { const { response } = yield apiFetchWithHeaders( { path: '/wc/store/cart/apply-coupon', method: 'POST', data: { code: couponCode, }, cache: 'no-store', } ); yield receiveCart( response ); yield receiveApplyingCoupon( '' ); } catch ( error ) { yield receiveError( error ); yield receiveApplyingCoupon( '' ); // If updated cart state was returned, also update that. if ( error.data?.cart ) { yield receiveCart( error.data.cart ); } // Re-throw the error. throw error; } return true; } /** * Removes a coupon code and either invalidates caches, or receives an error if * the coupon cannot be removed. * * @throws Will throw an error if there is an API problem. * @param {string} couponCode The coupon code to remove from the cart. */ export function* removeCoupon( couponCode ) { yield receiveRemovingCoupon( couponCode ); try { const { response } = yield apiFetchWithHeaders( { path: '/wc/store/cart/remove-coupon', method: 'POST', data: { code: couponCode, }, cache: 'no-store', } ); yield receiveCart( response ); yield receiveRemovingCoupon( '' ); } catch ( error ) { yield receiveError( error ); yield receiveRemovingCoupon( '' ); // If updated cart state was returned, also update that. if ( error.data?.cart ) { yield receiveCart( error.data.cart ); } // Re-throw the error. throw error; } return true; } /** * Adds an item to the cart: * - Calls API to add item. * - If successful, yields action to add item from store. * - If error, yields action to store error. * * @throws Will throw an error if there is an API problem. * @param {number} productId Product ID to add to cart. * @param {number} quantity Number of product ID being added to cart. */ export function* addItemToCart( productId, quantity = 1 ) { try { const { response } = yield apiFetchWithHeaders( { path: `/wc/store/cart/add-item`, method: 'POST', data: { id: productId, quantity, }, cache: 'no-store', } ); yield receiveCart( response ); } catch ( error ) { yield receiveError( error ); // If updated cart state was returned, also update that. if ( error.data?.cart ) { yield receiveCart( error.data.cart ); } // Re-throw the error. throw error; } return true; } /** * Removes specified item from the cart: * - Calls API to remove item. * - If successful, yields action to remove item from store. * - If error, yields action to store error. * - Sets cart item as pending while API request is in progress. * * @param {string} cartItemKey Cart item being updated. */ export function* removeItemFromCart( cartItemKey ) { yield itemIsPendingDelete( cartItemKey ); try { const { response } = yield apiFetchWithHeaders( { path: `/wc/store/cart/remove-item/?key=${ cartItemKey }`, method: 'POST', cache: 'no-store', } ); yield receiveCart( response ); } catch ( error ) { yield receiveError( error ); // If updated cart state was returned, also update that. if ( error.data?.cart ) { yield receiveCart( error.data.cart ); } } yield itemIsPendingDelete( cartItemKey, false ); } /** * Persists a quantity change the for specified cart item: * - Calls API to set quantity. * - If successful, yields action to update store. * - If error, yields action to store error. * * @param {string} cartItemKey Cart item being updated. * @param {number} quantity Specified (new) quantity. */ export function* changeCartItemQuantity( cartItemKey, quantity ) { const cartItem = yield select( CART_STORE_KEY, 'getCartItem', cartItemKey ); yield itemIsPendingQuantity( cartItemKey ); if ( cartItem?.quantity === quantity ) { return; } try { const { response } = yield apiFetchWithHeaders( { path: '/wc/store/cart/update-item', method: 'POST', data: { key: cartItemKey, quantity, }, cache: 'no-store', } ); yield receiveCart( response ); } catch ( error ) { yield receiveError( error ); // If updated cart state was returned, also update that. if ( error.data?.cart ) { yield receiveCart( error.data.cart ); } } yield itemIsPendingQuantity( cartItemKey, false ); } /** * Selects a shipping rate. * * @param {string} rateId the id of the rate being selected. * @param {number|string} [packageId] the key of the packages that we will select within. */ export function* selectShippingRate( rateId, packageId = 0 ) { try { yield shippingRatesBeingSelected( true ); const { response } = yield apiFetchWithHeaders( { path: `/wc/store/cart/select-shipping-rate`, method: 'POST', data: { package_id: packageId, rate_id: rateId, }, cache: 'no-store', } ); yield receiveCart( response ); } catch ( error ) { yield receiveError( error ); yield shippingRatesBeingSelected( false ); // If updated cart state was returned, also update that. if ( error.data?.cart ) { yield receiveCart( error.data.cart ); } // Re-throw the error. throw error; } yield shippingRatesBeingSelected( false ); return true; } /** * Updates the shipping and/or billing address for the customer and returns an updated cart. * * @param {Object} customerData Address data to be updated; can contain both billing_address and shipping_address. */ export function* updateCustomerData( customerData ) { yield updatingCustomerData( true ); try { const { response } = yield apiFetchWithHeaders( { path: '/wc/store/cart/update-customer', method: 'POST', data: customerData, cache: 'no-store', } ); yield receiveCart( response ); } catch ( error ) { yield receiveError( error ); yield updatingCustomerData( false ); // If updated cart state was returned, also update that. if ( error.data?.cart ) { yield receiveCart( error.data.cart ); } // rethrow error. throw error; } yield updatingCustomerData( false ); return true; }