woocommerce/plugins/woocommerce-blocks/assets/js/data/cart/selectors.js

165 lines
4.1 KiB
JavaScript
Raw Normal View History

/** @typedef { import('@woocommerce/type-defs/cart').CartData } CartData */
/** @typedef { import('@woocommerce/type-defs/cart').CartTotals } CartTotals */
/**
* Retrieves cart data from state.
*
* @param {Object} state The current state.
* @return {CartData} The data to return.
*/
export const getCartData = ( state ) => {
return state.cartData;
};
/**
* Retrieves cart totals from state.
*
* @param {Object} state The current state.
* @return {CartTotals} The data to return.
*/
export const getCartTotals = ( state ) => {
return (
state.cartData.totals || {
currency_code: '',
currency_symbol: '',
currency_minor_unit: 2,
currency_decimal_separator: '.',
currency_thousand_separator: ',',
currency_prefix: '',
currency_suffix: '',
total_items: '0',
total_items_tax: '0',
total_fees: '0',
total_fees_tax: '0',
total_discount: '0',
total_discount_tax: '0',
total_shipping: '0',
total_shipping_tax: '0',
total_price: '0',
total_tax: '0',
tax_lines: [],
}
);
};
/**
* Retrieves cart meta from state.
*
* @param {Object} state The current state.
* @return {Object} The data to return.
*/
export const getCartMeta = ( state ) => {
return (
state.metaData || {
applyingCoupon: '',
removingCoupon: '',
}
);
};
/**
* Retrieves cart errors from state.
*
* @param {Object} state The current state.
* @return {Array} Array of errors.
*/
export const getCartErrors = ( state ) => {
return state.errors || [];
};
/**
* Returns true if any coupon is being applied.
*
* @param {Object} state The current state.
* @return {boolean} True if a coupon is being applied.
*/
export const isApplyingCoupon = ( state ) => {
return !! state.metaData.applyingCoupon;
};
/**
* Retrieves the coupon code currently being applied.
*
* @param {Object} state The current state.
* @return {string} The data to return.
*/
export const getCouponBeingApplied = ( state ) => {
return state.metaData.applyingCoupon || '';
};
/**
* Returns true if any coupon is being removed.
*
* @param {Object} state The current state.
* @return {boolean} True if a coupon is being removed.
*/
export const isRemovingCoupon = ( state ) => {
return !! state.metaData.removingCoupon;
};
/**
* Retrieves the coupon code currently being removed.
*
* @param {Object} state The current state.
* @return {string} The data to return.
*/
export const getCouponBeingRemoved = ( state ) => {
return state.metaData.removingCoupon || '';
};
/**
* Returns cart item matching specified key.
*
* @param {Object} state The current state.
* @param {string} cartItemKey Key for a cart item.
* @return {Object} Cart item object, or undefined if not found.
*/
export const getCartItem = ( state, cartItemKey ) => {
return state.cartData.items.find(
( cartItem ) => cartItem.key === cartItemKey
);
};
/**
* Returns true if the specified cart item quantity is being updated.
*
* @param {Object} state The current state.
* @param {string} cartItemKey Key for a cart item.
* @return {boolean} True if a item has a pending request to be updated.
*/
export const isItemPendingQuantity = ( state, cartItemKey ) => {
return state.cartItemsPendingQuantity.includes( cartItemKey );
};
Update and select shipping rates dynamically (https://github.com/woocommerce/woocommerce-blocks/pull/1794) * add select shipping endpoint to router * add select shipping method * add selected rates to cart * better select rates * move schema function to seperate function * move validation to Cart Controller * fix wrong session key * Update shipping/cart endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1833) * Items should not have keys in API response * Include package ID in response (this is just a basic index) * /cart/select-shipping-rate/package_id * Add package_id to package array * Update responses and add shipping-rates to main cart endpoint * update-shipping endpoint * Add querying selected shipping rate to the store (https://github.com/woocommerce/woocommerce-blocks/pull/1829) * add selecting shipping to store * directly call useSelectShippingRate * refactor cart keys transformation to reducer * remove selecting first result and accept selecting * move update shipping to new endpoint * pass selected rates down * select shipping right directly and fix editor issues * fix some broken prop types * key -> package id * Update and fix cart/shipping-rate tests * fix case for when rates are set * Update useShippingRates test * add args to rest endpoint * move selecting shipping rate logic to hook * fix some naming issues * update propTypes * update action call * fully watch cart state * address review issues * fix prop type issues * fix issue with rates not loading in checkout * remove extra package for shipping * move ShippingCalculatorOptions to outside Co-authored-by: Mike Jolley <mike.jolley@me.com> Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-03-05 19:54:05 +00:00
/**
* Returns true if the specified cart item quantity is being updated.
*
* @param {Object} state The current state.
* @param {string} cartItemKey Key for a cart item.
* @return {boolean} True if a item has a pending request to be updated.
*/
export const isItemPendingDelete = ( state, cartItemKey ) => {
return state.cartItemsPendingDelete.includes( cartItemKey );
};
Update and select shipping rates dynamically (https://github.com/woocommerce/woocommerce-blocks/pull/1794) * add select shipping endpoint to router * add select shipping method * add selected rates to cart * better select rates * move schema function to seperate function * move validation to Cart Controller * fix wrong session key * Update shipping/cart endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1833) * Items should not have keys in API response * Include package ID in response (this is just a basic index) * /cart/select-shipping-rate/package_id * Add package_id to package array * Update responses and add shipping-rates to main cart endpoint * update-shipping endpoint * Add querying selected shipping rate to the store (https://github.com/woocommerce/woocommerce-blocks/pull/1829) * add selecting shipping to store * directly call useSelectShippingRate * refactor cart keys transformation to reducer * remove selecting first result and accept selecting * move update shipping to new endpoint * pass selected rates down * select shipping right directly and fix editor issues * fix some broken prop types * key -> package id * Update and fix cart/shipping-rate tests * fix case for when rates are set * Update useShippingRates test * add args to rest endpoint * move selecting shipping rate logic to hook * fix some naming issues * update propTypes * update action call * fully watch cart state * address review issues * fix prop type issues * fix issue with rates not loading in checkout * remove extra package for shipping * move ShippingCalculatorOptions to outside Co-authored-by: Mike Jolley <mike.jolley@me.com> Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-03-05 19:54:05 +00:00
/**
* Retrieves if the address is being applied for shipping.
*
* @param {Object} state The current state.
* @return {boolean} are shipping rates loading.
*/
export const areShippingRatesLoading = ( state ) => {
return !! state.metaData.updatingShipping;
};
/**
* Retrieves if the shipping rate selection is being persisted.
*
* @param {Object} state The current state.
*
* @return {boolean} True if the shipping rate selection is being persisted to
* the server.
*/
export const isShippingRateBeingSelected = ( state ) => {
return !! state.metaData.updatingSelectedRate;
};