woocommerce/plugins/woocommerce-admin/client/dashboard/utils.js

175 lines
4.3 KiB
JavaScript

/**
* External dependencies
*/
import { decodeEntities } from '@wordpress/html-entities';
import { without } from 'lodash';
import { getSetting } from '@woocommerce/wc-admin-settings';
/**
* Gets the country code from a country:state value string.
*
* @param {string} countryState Country state string, e.g. US:GA.
* @return {string} Country string.
*/
export function getCountryCode( countryState ) {
if ( ! countryState ) {
return null;
}
return countryState.split( ':' )[ 0 ];
}
export function getCurrencyRegion( countryState ) {
let region = getCountryCode( countryState );
const euCountries = without(
getSetting( 'onboarding', { euCountries: [] } ).euCountries,
'GB'
);
if ( euCountries.includes( region ) ) {
region = 'EU';
}
return region;
}
/**
* Gets the product IDs for items based on the product types and theme selected in the onboarding profiler.
*
* @param {Object} profileItems Onboarding profile.
* @param {boolean} includeInstalledItems Include installed items in returned product IDs.
* @param {Array} installedPlugins Installed plugins.
* @return {Array} Product Ids.
*/
export function getProductIdsForCart(
profileItems,
includeInstalledItems = false,
installedPlugins
) {
const productList = getProductList(
profileItems,
includeInstalledItems,
installedPlugins
);
const productIds = productList.map(
( product ) => product.id || product.product
);
return productIds;
}
/**
* Gets the labeled/categorized product names and types for items based on the product types and theme selected in the onboarding profiler.
*
* @param {Object} profileItems Onboarding profile.
* @param {Array} installedPlugins Installed plugins.
* @return {Array} Objects with labeled/categorized product names and types.
*/
export function getCategorizedOnboardingProducts(
profileItems,
installedPlugins
) {
const productList = {};
productList.products = getProductList(
profileItems,
true,
installedPlugins
);
productList.remainingProducts = getProductList(
profileItems,
false,
installedPlugins
);
const uniqueItemsList = [
...new Set( [
...productList.products,
...productList.remainingProducts,
] ),
];
productList.uniqueItemsList = uniqueItemsList.map( ( product ) => {
let cleanedProduct;
if ( product.label ) {
cleanedProduct = { type: 'extension', name: product.label };
} else {
cleanedProduct = { type: 'theme', name: product.title };
}
return cleanedProduct;
} );
return productList;
}
/**
* Gets a product list for items based on the product types and theme selected in the onboarding profiler.
*
* @param {Object} profileItems Onboarding profile.
* @param {boolean} includeInstalledItems Include installed items in returned product list.
* @param {Array} installedPlugins Installed plugins.
* @return {Array} Products.
*/
export function getProductList(
profileItems,
includeInstalledItems = false,
installedPlugins
) {
const onboarding = getSetting( 'onboarding', {} );
const productList = [];
// The population of onboarding.productTypes only happens if the task list should be shown
// so bail early if it isn't present.
if ( ! onboarding.productTypes ) {
return productList;
}
const productTypes = profileItems.product_types || [];
productTypes.forEach( ( productType ) => {
if (
onboarding.productTypes[ productType ] &&
onboarding.productTypes[ productType ].product &&
( includeInstalledItems ||
! installedPlugins.includes(
onboarding.productTypes[ productType ].slug
) )
) {
productList.push( onboarding.productTypes[ productType ] );
}
} );
const theme = onboarding.themes.find(
( themeData ) => themeData.slug === profileItems.theme
);
if (
theme &&
theme.id &&
getPriceValue( theme.price ) > 0 &&
( includeInstalledItems || ! theme.is_installed )
) {
productList.push( theme );
}
return productList;
}
/**
* Get the value of a price from a string, removing any non-numeric characters.
*
* @param {string} string Price string.
* @return {number} Number value.
*/
export function getPriceValue( string ) {
return Number( decodeEntities( string ).replace( /[^0-9.-]+/g, '' ) );
}
/**
* Determines if a URL is a WC admin url.
*
* @param {*} url - the url to test
* @return {boolean} true if the url is a wc-admin URL
*/
export function isWCAdmin( url ) {
return /admin.php\?page=wc-admin/.test( url );
}