146 lines
3.5 KiB
TypeScript
146 lines
3.5 KiB
TypeScript
/**
|
|
* External dependencies
|
|
*/
|
|
import { CURRENCY } from '@woocommerce/settings';
|
|
import type {
|
|
Currency,
|
|
CurrencyResponse,
|
|
CartShippingPackageShippingRate,
|
|
SymbolPosition,
|
|
} from '@woocommerce/types';
|
|
|
|
/**
|
|
* Get currency prefix.
|
|
*/
|
|
const getPrefix = (
|
|
// Currency symbol.
|
|
symbol: string,
|
|
// Position of currency symbol from settings.
|
|
symbolPosition: SymbolPosition
|
|
): string => {
|
|
const prefixes = {
|
|
left: symbol,
|
|
left_space: ' ' + symbol,
|
|
right: '',
|
|
right_space: '',
|
|
};
|
|
return prefixes[ symbolPosition ] || '';
|
|
};
|
|
|
|
/**
|
|
* Get currency suffix.
|
|
*/
|
|
const getSuffix = (
|
|
// Currency symbol.
|
|
symbol: string,
|
|
// Position of currency symbol from settings.
|
|
symbolPosition: SymbolPosition
|
|
): string => {
|
|
const suffixes = {
|
|
left: '',
|
|
left_space: '',
|
|
right: symbol,
|
|
right_space: ' ' + symbol,
|
|
};
|
|
return suffixes[ symbolPosition ] || '';
|
|
};
|
|
|
|
/**
|
|
* Currency information in normalized format from server settings.
|
|
*/
|
|
const siteCurrencySettings: Currency = {
|
|
code: CURRENCY.code,
|
|
symbol: CURRENCY.symbol,
|
|
thousandSeparator: CURRENCY.thousandSeparator,
|
|
decimalSeparator: CURRENCY.decimalSeparator,
|
|
minorUnit: CURRENCY.precision,
|
|
prefix: getPrefix(
|
|
CURRENCY.symbol,
|
|
CURRENCY.symbolPosition as SymbolPosition
|
|
),
|
|
suffix: getSuffix(
|
|
CURRENCY.symbol,
|
|
CURRENCY.symbolPosition as SymbolPosition
|
|
),
|
|
};
|
|
|
|
/**
|
|
* Gets currency information in normalized format from an API response or the server.
|
|
*/
|
|
export const getCurrencyFromPriceResponse = (
|
|
// Currency data object, for example an API response containing currency formatting data.
|
|
currencyData:
|
|
| CurrencyResponse
|
|
| Record< string, never >
|
|
| CartShippingPackageShippingRate
|
|
): Currency => {
|
|
if ( ! currencyData || typeof currencyData !== 'object' ) {
|
|
return siteCurrencySettings;
|
|
}
|
|
|
|
const {
|
|
currency_code: code,
|
|
currency_symbol: symbol,
|
|
currency_thousand_separator: thousandSeparator,
|
|
currency_decimal_separator: decimalSeparator,
|
|
currency_minor_unit: minorUnit,
|
|
currency_prefix: prefix,
|
|
currency_suffix: suffix,
|
|
} = currencyData;
|
|
|
|
return {
|
|
code: code || 'USD',
|
|
symbol: symbol || '$',
|
|
thousandSeparator:
|
|
typeof thousandSeparator === 'string' ? thousandSeparator : ',',
|
|
decimalSeparator:
|
|
typeof decimalSeparator === 'string' ? decimalSeparator : '.',
|
|
minorUnit: Number.isFinite( minorUnit ) ? minorUnit : 2,
|
|
prefix: typeof prefix === 'string' ? prefix : '$',
|
|
suffix: typeof suffix === 'string' ? suffix : '',
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Gets currency information in normalized format, allowing overrides.
|
|
*/
|
|
export const getCurrency = (
|
|
currencyData: Partial< Currency > = {}
|
|
): Currency => {
|
|
return {
|
|
...siteCurrencySettings,
|
|
...currencyData,
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Format a price, provided using the smallest unit of the currency, as a
|
|
* decimal complete with currency symbols using current store settings.
|
|
*/
|
|
export const formatPrice = (
|
|
// Price in minor unit, e.g. cents.
|
|
price: number | string,
|
|
currencyData: Currency
|
|
): string => {
|
|
if ( price === '' || price === undefined ) {
|
|
return '';
|
|
}
|
|
|
|
const priceInt: number =
|
|
typeof price === 'number' ? price : parseInt( price, 10 );
|
|
|
|
if ( ! Number.isFinite( priceInt ) ) {
|
|
return '';
|
|
}
|
|
|
|
const currency: Currency = getCurrency( currencyData );
|
|
const formattedPrice: number = priceInt / 10 ** currency.minorUnit;
|
|
const formattedValue: string =
|
|
currency.prefix + formattedPrice + currency.suffix;
|
|
|
|
// This uses a textarea to magically decode HTML currency symbols.
|
|
const txt = document.createElement( 'textarea' );
|
|
txt.innerHTML = formattedValue;
|
|
return txt.value;
|
|
};
|