2020-03-05 19:54:05 +00:00
|
|
|
/**
|
|
|
|
* External dependencies
|
|
|
|
*/
|
2021-02-24 01:36:24 +00:00
|
|
|
import type { CartItem } from '@woocommerce/types';
|
2021-03-01 17:47:22 +00:00
|
|
|
import type { Reducer } from 'redux';
|
2020-03-05 19:54:05 +00:00
|
|
|
|
2020-02-25 11:36:53 +00:00
|
|
|
/**
|
|
|
|
* Internal dependencies
|
|
|
|
*/
|
|
|
|
import { ACTION_TYPES as types } from './action-types';
|
2022-07-08 05:53:24 +00:00
|
|
|
import { defaultCartState, CartState } from './default-state';
|
2021-08-13 13:28:41 +00:00
|
|
|
import { EMPTY_CART_ERRORS } from '../constants';
|
2021-02-24 01:36:24 +00:00
|
|
|
import type { CartAction } from './actions';
|
2020-02-25 11:36:53 +00:00
|
|
|
|
2020-02-28 02:05:10 +00:00
|
|
|
/**
|
|
|
|
* Sub-reducer for cart items array.
|
|
|
|
*
|
2022-04-08 13:47:19 +00:00
|
|
|
* @param {Array<CartItem>} state cartData.items state slice.
|
|
|
|
* @param {CartAction} action Action object.
|
2020-02-28 02:05:10 +00:00
|
|
|
*/
|
2021-02-24 01:36:24 +00:00
|
|
|
const cartItemsReducer = (
|
|
|
|
state: Array< CartItem > = [],
|
2021-03-01 17:47:22 +00:00
|
|
|
action: Partial< CartAction >
|
2021-02-24 01:36:24 +00:00
|
|
|
) => {
|
2020-02-28 02:05:10 +00:00
|
|
|
switch ( action.type ) {
|
2020-03-03 01:08:19 +00:00
|
|
|
case types.RECEIVE_CART_ITEM:
|
|
|
|
// Replace specified cart element with the new data from server.
|
|
|
|
return state.map( ( cartItem ) => {
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( cartItem.key === action.cartItem?.key ) {
|
2020-03-03 01:08:19 +00:00
|
|
|
return action.cartItem;
|
|
|
|
}
|
|
|
|
return cartItem;
|
|
|
|
} );
|
2020-02-28 02:05:10 +00:00
|
|
|
}
|
|
|
|
return state;
|
|
|
|
};
|
|
|
|
|
2020-02-25 11:36:53 +00:00
|
|
|
/**
|
|
|
|
* Reducer for receiving items related to the cart.
|
|
|
|
*
|
2022-04-08 13:47:19 +00:00
|
|
|
* @param {CartState} state The current state in the store.
|
|
|
|
* @param {CartAction} action Action object.
|
2020-02-25 11:36:53 +00:00
|
|
|
*
|
2021-02-24 01:36:24 +00:00
|
|
|
* @return {CartState} New or existing state.
|
2020-02-25 11:36:53 +00:00
|
|
|
*/
|
2021-03-01 17:47:22 +00:00
|
|
|
const reducer: Reducer< CartState > = (
|
|
|
|
state = defaultCartState,
|
|
|
|
action: Partial< CartAction >
|
|
|
|
) => {
|
2020-02-25 11:36:53 +00:00
|
|
|
switch ( action.type ) {
|
|
|
|
case types.RECEIVE_ERROR:
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( action.error ) {
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
errors: state.errors.concat( action.error ),
|
|
|
|
};
|
|
|
|
}
|
2020-02-25 11:36:53 +00:00
|
|
|
break;
|
|
|
|
case types.REPLACE_ERRORS:
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( action.error ) {
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
errors: [ action.error ],
|
|
|
|
};
|
|
|
|
}
|
2020-02-25 11:36:53 +00:00
|
|
|
break;
|
Add notice on quantity change and update `wc/store/cart` to use thunks (https://github.com/woocommerce/woocommerce-blocks/pull/7938)
* Add receiveCart thunk
* Add mapCartResponseToCart helper
* Add getItemsPendingQuantityUpdate selector
* Update cart resolvers to be thunks
* Remove RECEIVE_CART action and replace with SET_CART_DATA
receiveCart will turn into a thunk.
* Add notifyQuantityChanges functions
* Remove receiveCart from action type definition, replace with setCartData
* Move apiFetchWithHeaders out of controls
This will just be a normal function since we'll be updating actions to thunks which will use this instead of a control.
* Include thunks in actions file
* Update receiveCart action to setCartData
* Update applyCoupon action to a thunk
* Update useStoreCartCoupons to get action from correct place
* Update StoreCartCoupon types
* Add types for Thunk and ThunkReturnType in mapped-types
* Change applyCoupon to a thunk
* Get applyCoupon, removeCoupon, receiveApplyingCoupon from useDispatch
This is to separate the concerns of actions vs. selectors. Previously the actions were fetched during useSelect which is not a pattern we use anywhere else in the codebase. Since we updated the MapToDispatch type, we can now get correctly typed thunks from the data store.
* Improve apiFetchWithHeaders typings
* Convert removeCoupon from generator to thunk
* Add applyCoupon and removeCoupon to CartAction type
* Remove unused old-style type-def
* Add receiveApplyingCoupon & receiveRemovingCoupon to StoreCartCoupon
* Correct issues with StoreCartCoupon type
These were not intended to reflect the actions in data store, rather the functions offered by the useStoreCartCoupons hook.
* Update applyExtensionCartUpdate to a thunk
* Update addItemToCart to thunk
* Add ResolveSelectFromMap type that works with thunks
* Add CartDispatchFromMap and CartResolveSelectFromMap types
We can add this to all data stores to get them working with thunks properly.
* Add docs and update generic name in ResolveSelectFromMap
* Add correct types for thunk resolvers in cart data store
* Update removeItemFromCart to thunk
* Update apiFetchWithHeaders to use generic
* Update selectShippingRate to thunk
* Update resolver tests to test correct thunk functionality
* Update updateCustomerData to thunk
* Update reducer test to reflect new action name
* Update comments on CartDispatchFromMap and CartResolveSelectFromMap
* Add quantity_limits to preview cart
* Make notices speak when shown
* Remove copilot comment
* Add isWithinQuantityLimits function
This is because we shouldn't show a notice if the quantity limits change, but the item's quantity is still OK.
* Add tests for notifyQuantityChanges
* Show notice when multiple_of is updated
* Update test to test for multiple_of changes
* Remove empty export
* Remove controls from cart data store
Not needed anymore since the exported value from the shared-controls file was empty.
* Export a control and async function for apiFetchWithHeaders
This is required because async functions cannot be called from sync generators.
* Use control version of apiFetchWithHeaders in the collections store
* Improve comments and remove incorrect TypeScript
* Update assets/js/data/cart/actions.ts
Co-authored-by: Mike Jolley <mike.jolley@me.com>
* Update ResolveSelectFromMap to include selectors too
* Update TS in actions
* Use finally to remove duplicate code
* remove item pending delete/qty update after action runs in all cases
This will also reset the state when the request to remove it/change quantity errors
* Remove unnecessary type from param.
Not needed because we have TS now. The description can stay though, it is useful.
* Update snackbar wording to use active voice
* Remove old WP version check
* Set max quantity to high number instead of null
This would only happen in a niche case, and would require several TS changes to fix, so it's better to set it as a number here. 9999 should be high enough, and is the default quantity limit set below in get_product_quantity_limit
* Set code on woocommerce_rest_cart_invalid_key to 409
This is so the cart is returned in the response, so the client can update.
* Fix typo in comment and add CartSelectFromMap
* Remove unnecessary docblock
* Add getItemsPendingDelete selector
This is needed so we can show a notice for items that are unexpectedly removed from the cart. We need to know which ones are pending delete so we can skip showing the notice for them.
* Add type for notifyQuantityChanges args and change args to object
* Add notifyIfRemoved function
This will check items that have been removed and show a notice for them.
* Fix TS in receiveCart & pass itemsPendingDelete to notifyQuantiyChanges
* Update wording on removal notice
* Update types for notifyQuantityChanges args
* Update tests to reflect new wording and args being an object
* Check item is truth before running comparison of keys
* Update tests for unexpectedly and expectedly removed items
* Ignore print_r to satisfy phpcs
* Update PHP tests to reflect correct response code when deleting items
* Remove unnecessary controls and dispatch events directly from thunk
Co-authored-by: Mike Jolley <mike.jolley@me.com>
2022-12-16 16:06:37 +00:00
|
|
|
case types.SET_CART_DATA:
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( action.response ) {
|
|
|
|
state = {
|
|
|
|
...state,
|
2021-08-13 13:28:41 +00:00
|
|
|
errors: EMPTY_CART_ERRORS,
|
2022-02-22 17:45:01 +00:00
|
|
|
cartData: {
|
|
|
|
...state.cartData,
|
|
|
|
...action.response,
|
|
|
|
},
|
2021-02-24 01:36:24 +00:00
|
|
|
};
|
|
|
|
}
|
2020-02-25 11:36:53 +00:00
|
|
|
break;
|
|
|
|
case types.APPLYING_COUPON:
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( action.couponCode || action.couponCode === '' ) {
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
metaData: {
|
|
|
|
...state.metaData,
|
|
|
|
applyingCoupon: action.couponCode,
|
|
|
|
},
|
|
|
|
};
|
|
|
|
}
|
2020-02-25 11:36:53 +00:00
|
|
|
break;
|
2022-06-10 16:59:25 +00:00
|
|
|
case types.SET_BILLING_ADDRESS:
|
2022-02-22 17:45:01 +00:00
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
cartData: {
|
|
|
|
...state.cartData,
|
|
|
|
billingAddress: {
|
|
|
|
...state.cartData.billingAddress,
|
2022-06-10 16:59:25 +00:00
|
|
|
...action.billingAddress,
|
2022-02-22 17:45:01 +00:00
|
|
|
},
|
|
|
|
},
|
|
|
|
};
|
|
|
|
break;
|
|
|
|
case types.SET_SHIPPING_ADDRESS:
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
cartData: {
|
|
|
|
...state.cartData,
|
|
|
|
shippingAddress: {
|
|
|
|
...state.cartData.shippingAddress,
|
|
|
|
...action.shippingAddress,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
};
|
|
|
|
break;
|
|
|
|
|
2020-02-25 11:36:53 +00:00
|
|
|
case types.REMOVING_COUPON:
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( action.couponCode || action.couponCode === '' ) {
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
metaData: {
|
|
|
|
...state.metaData,
|
|
|
|
removingCoupon: action.couponCode,
|
|
|
|
},
|
|
|
|
};
|
|
|
|
}
|
2020-02-25 11:36:53 +00:00
|
|
|
break;
|
2020-02-28 02:05:10 +00:00
|
|
|
|
2020-04-07 11:03:22 +00:00
|
|
|
case types.ITEM_PENDING_QUANTITY:
|
2020-02-28 02:05:10 +00:00
|
|
|
// Remove key by default - handles isQuantityPending==false
|
|
|
|
// and prevents duplicates when isQuantityPending===true.
|
2020-04-07 11:03:22 +00:00
|
|
|
const keysPendingQuantity = state.cartItemsPendingQuantity.filter(
|
2020-02-28 02:05:10 +00:00
|
|
|
( key ) => key !== action.cartItemKey
|
|
|
|
);
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( action.isPendingQuantity && action.cartItemKey ) {
|
2020-04-07 11:03:22 +00:00
|
|
|
keysPendingQuantity.push( action.cartItemKey );
|
2020-02-28 02:05:10 +00:00
|
|
|
}
|
|
|
|
state = {
|
|
|
|
...state,
|
2020-04-07 11:03:22 +00:00
|
|
|
cartItemsPendingQuantity: keysPendingQuantity,
|
|
|
|
};
|
|
|
|
break;
|
|
|
|
case types.RECEIVE_REMOVED_ITEM:
|
|
|
|
const keysPendingDelete = state.cartItemsPendingDelete.filter(
|
|
|
|
( key ) => key !== action.cartItemKey
|
|
|
|
);
|
2021-02-24 01:36:24 +00:00
|
|
|
if ( action.isPendingDelete && action.cartItemKey ) {
|
2020-04-07 11:03:22 +00:00
|
|
|
keysPendingDelete.push( action.cartItemKey );
|
|
|
|
}
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
cartItemsPendingDelete: keysPendingDelete,
|
2020-02-28 02:05:10 +00:00
|
|
|
};
|
|
|
|
break;
|
|
|
|
// Delegate to cartItemsReducer.
|
2020-03-03 01:08:19 +00:00
|
|
|
case types.RECEIVE_CART_ITEM:
|
2020-02-28 02:05:10 +00:00
|
|
|
state = {
|
|
|
|
...state,
|
2021-08-13 13:28:41 +00:00
|
|
|
errors: EMPTY_CART_ERRORS,
|
2020-02-28 02:05:10 +00:00
|
|
|
cartData: {
|
|
|
|
...state.cartData,
|
|
|
|
items: cartItemsReducer( state.cartData.items, action ),
|
|
|
|
},
|
|
|
|
};
|
|
|
|
break;
|
2020-11-20 15:13:35 +00:00
|
|
|
case types.UPDATING_CUSTOMER_DATA:
|
2020-03-05 19:54:05 +00:00
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
metaData: {
|
|
|
|
...state.metaData,
|
2021-02-24 01:36:24 +00:00
|
|
|
updatingCustomerData: !! action.isResolving,
|
2020-03-05 19:54:05 +00:00
|
|
|
},
|
|
|
|
};
|
|
|
|
break;
|
2020-03-31 15:40:27 +00:00
|
|
|
case types.UPDATING_SELECTED_SHIPPING_RATE:
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
metaData: {
|
|
|
|
...state.metaData,
|
2021-02-24 01:36:24 +00:00
|
|
|
updatingSelectedRate: !! action.isResolving,
|
2020-03-31 15:40:27 +00:00
|
|
|
},
|
|
|
|
};
|
2021-03-24 13:28:11 +00:00
|
|
|
break;
|
|
|
|
case types.SET_IS_CART_DATA_STALE:
|
|
|
|
state = {
|
|
|
|
...state,
|
|
|
|
metaData: {
|
|
|
|
...state.metaData,
|
|
|
|
isCartDataStale: action.isCartDataStale,
|
|
|
|
},
|
|
|
|
};
|
|
|
|
break;
|
2020-02-25 11:36:53 +00:00
|
|
|
}
|
|
|
|
return state;
|
|
|
|
};
|
|
|
|
|
2021-03-01 17:47:22 +00:00
|
|
|
export type State = ReturnType< typeof reducer >;
|
|
|
|
|
2020-02-25 11:36:53 +00:00
|
|
|
export default reducer;
|