woocommerce/plugins/woocommerce-admin/client/analytics/report/taxes/table.js

/**
 * External dependencies
 */
import { __, _n } from '@wordpress/i18n';
import { Component } from '@wordpress/element';
import { map } from 'lodash';

/**
 * WooCommerce dependencies
 */
import { Link } from '@woocommerce/components';
import { getNewPath, getPersistedQuery } from '@woocommerce/navigation';
import { getTaxCode } from './utils';
import { formatValue } from '@woocommerce/number';

/**
 * Internal dependencies
 */
import ReportTable from 'analytics/components/report-table';
import { CurrencyContext } from 'lib/currency-context';

class TaxesReportTable extends Component {
	constructor() {
		super();

		this.getHeadersContent = this.getHeadersContent.bind( this );
		this.getRowsContent = this.getRowsContent.bind( this );
		this.getSummary = this.getSummary.bind( this );
	}

	getHeadersContent() {
		return [
			{
				label: __( 'Tax Code', 'woocommerce-admin' ),
				key: 'tax_code',
				required: true,
				isLeftAligned: true,
				isSortable: true,
			},
			{
				label: __( 'Rate', 'woocommerce-admin' ),
				key: 'rate',
				isSortable: true,
				isNumeric: true,
			},
			{
				label: __( 'Total Tax', 'woocommerce-admin' ),
				key: 'total_tax',
				isSortable: true,
			},
			{
				label: __( 'Order Tax', 'woocommerce-admin' ),
				key: 'order_tax',
				isSortable: true,
			},
			{
				label: __( 'Shipping Tax', 'woocommerce-admin' ),
				key: 'shipping_tax',
				isSortable: true,
			},
			{
				label: __( 'Orders', 'woocommerce-admin' ),
				key: 'orders_count',
				required: true,
				defaultSort: true,
				isSortable: true,
				isNumeric: true,
			},
		];
	}

	getRowsContent( taxes ) {
		const {
			render: renderCurrency,
			formatDecimal: getCurrencyFormatDecimal,
			getCurrencyConfig,
		} = this.context;

		return map( taxes, ( tax ) => {
			const { query } = this.props;
			const {
				order_tax: orderTax,
				orders_count: ordersCount,
				tax_rate: taxRate,
				tax_rate_id: taxRateId,
				total_tax: totalTax,
				shipping_tax: shippingTax,
			} = tax;
			const taxCode = getTaxCode( tax );

			const persistedQuery = getPersistedQuery( query );
			const ordersTaxLink = getNewPath(
				persistedQuery,
				'/analytics/orders',
				{
					filter: 'advanced',
					tax_rate_includes: taxRateId,
				}
			);
			const taxLink = (
				<Link href={ ordersTaxLink } type="wc-admin">
					{ taxCode }
				</Link>
			);

			return [
				{
					display: taxLink,
					value: taxCode,
				},
				{
					display: taxRate.toFixed( 2 ) + '%',
					value: taxRate,
				},
				{
					display: renderCurrency( totalTax ),
					value: getCurrencyFormatDecimal( totalTax ),
				},
				{
					display: renderCurrency( orderTax ),
					value: getCurrencyFormatDecimal( orderTax ),
				},
				{
					display: renderCurrency( shippingTax ),
					value: getCurrencyFormatDecimal( shippingTax ),
				},
				{
					display: formatValue(
						getCurrencyConfig(),
						'number',
						ordersCount
					),
					value: ordersCount,
				},
			];
		} );
	}

	getSummary( totals ) {
		const {
			tax_codes: taxesCodes = 0,
			total_tax: totalTax = 0,
			order_tax: orderTax = 0,
			shipping_tax: shippingTax = 0,
			orders_count: ordersCount = 0,
		} = totals;
		const { formatAmount, getCurrencyConfig } = this.context;
		const currency = getCurrencyConfig();
		return [
			{
				label: _n(
					'tax code',
					'tax codes',
					taxesCodes,
					'woocommerce-admin'
				),
				value: formatValue( currency, 'number', taxesCodes ),
			},
			{
				label: __( 'total tax', 'woocommerce-admin' ),
				value: formatAmount( totalTax ),
			},
			{
				label: __( 'order tax', 'woocommerce-admin' ),
				value: formatAmount( orderTax ),
			},
			{
				label: __( 'shipping tax', 'woocommerce-admin' ),
				value: formatAmount( shippingTax ),
			},
			{
				label: _n(
					'order',
					'orders',
					ordersCount,
					'woocommerce-admin'
				),
				value: formatValue( currency, 'number', ordersCount ),
			},
		];
	}

	render() {
		const { advancedFilters, filters, isRequesting, query } = this.props;

		return (
			<ReportTable
				compareBy="taxes"
				endpoint="taxes"
				getHeadersContent={ this.getHeadersContent }
				getRowsContent={ this.getRowsContent }
				getSummary={ this.getSummary }
				summaryFields={ [
					'tax_codes',
					'total_tax',
					'order_tax',
					'shipping_tax',
					'orders_count',
				] }
				isRequesting={ isRequesting }
				itemIdField="tax_rate_id"
				query={ query }
				searchBy="taxes"
				tableQuery={ {
					orderby: query.orderby || 'tax_rate_id',
				} }
				title={ __( 'Taxes', 'woocommerce-admin' ) }
				columnPrefsKey="taxes_report_columns"
				filters={ filters }
				advancedFilters={ advancedFilters }
			/>
		);
	}
}

TaxesReportTable.contextType = CurrencyContext;

export default TaxesReportTable;