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

299 lines
7.3 KiB
JavaScript
Raw Normal View History

/** @format */
/**
* External dependencies
*/
import { __, _n, _x, sprintf } from '@wordpress/i18n';
import { Component, Fragment } from '@wordpress/element';
import { map } from 'lodash';
/**
* WooCommerce dependencies
*/
import { Date, Link, OrderStatus, ViewMoreList } from '@woocommerce/components';
import { defaultTableDateFormat } from 'lib/date';
import { formatCurrency, renderCurrency } from 'lib/currency-format';
import { formatValue } from 'lib/number-format';
import { getSetting } from '@woocommerce/wc-admin-settings';
/**
* Internal dependencies
*/
import ReportTable from 'analytics/components/report-table';
import { getNewPath, getPersistedQuery } from '@woocommerce/navigation';
import './style.scss';
export default class OrdersReportTable 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: __( 'Date', 'woocommerce-admin' ),
key: 'date',
required: true,
defaultSort: true,
isLeftAligned: true,
isSortable: true,
},
{
label: __( 'Order #', 'woocommerce-admin' ),
screenReaderLabel: __( 'Order Number', 'woocommerce-admin' ),
key: 'order_number',
required: true,
},
{
label: __( 'Status', 'woocommerce-admin' ),
key: 'status',
required: false,
isSortable: false,
},
{
label: __( 'Customer', 'woocommerce-admin' ),
key: 'customer_id',
required: false,
isSortable: false,
},
{
label: __( 'Product(s)', 'woocommerce-admin' ),
screenReaderLabel: __( 'Products', 'woocommerce-admin' ),
key: 'products',
required: false,
isSortable: false,
},
{
label: __( 'Items Sold', 'woocommerce-admin' ),
key: 'num_items_sold',
required: false,
isSortable: true,
isNumeric: true,
},
{
label: __( 'Coupon(s)', 'woocommerce-admin' ),
screenReaderLabel: __( 'Coupons', 'woocommerce-admin' ),
key: 'coupons',
required: false,
isSortable: false,
},
{
Correcting and clarifying analytics terms and calculations (https://github.com/woocommerce/woocommerce-admin/pull/3104) * Relabel Net Revenue to Net Sales, revert previous refund work on Gross revenue and rename to total sales. Update the orer of all the things * Add gross sales calculation to revenue stats endpoint. * Restore coupon_total when updating order stats. * Wire up gross sales to revenue report. * Fix revenue report refunds calculation when there are no refunds. * update net sales labels and cases in order, product and category tables * Subtract refunded shipping and taxes from gross sales. * pluses to minuses to fix the gross revenue and refund totals when refunding * Add gross_sales to revenue stats orderby enum. * Change refund labels to Returns * Remove usage of defunct coupon_total column. * Store refunded amount in stats table. * Rename "gross_total" column to "total_sales". * Net total for refund orders can be used instead of a new column. * Rename gross_revenue to total_sales. * Coalesce coupons total in order stats query. SUM()ing all nulls gives null, not zero. * Use segmentation selections to backfill missing data. Fo when report columns and segmentation columns don't match. * Remove errant gross_sales from expected interval test data. * Fix gross sales tests for revenue/stats. * Move missing segment fills back to their original locations. * Fix remaining tests failing because of gross sales. * Fix db upgrade function rename of gross_total column. * Fix linter errors.
2019-11-22 15:06:14 +00:00
label: __( 'Net Sales', 'woocommerce-admin' ),
screenReaderLabel: __( 'Net Sales', 'woocommerce-admin' ),
key: 'net_total',
required: true,
isSortable: true,
isNumeric: true,
},
];
}
getCustomerType( customerType ) {
switch ( customerType ) {
case 'new':
return _x( 'New', 'customer type', 'woocommerce-admin' );
case 'returning':
return _x( 'Returning', 'customer type', 'woocommerce-admin' );
default:
return _x( 'N/A', 'customer type', 'woocommerce-admin' );
}
}
getRowsContent( tableData ) {
const { query } = this.props;
const persistedQuery = getPersistedQuery( query );
return map( tableData, row => {
const {
currency,
customer_type,
date_created,
net_total,
num_items_sold,
order_id,
order_number,
parent_id,
status,
} = row;
const extended_info = row.extended_info || {};
const { coupons, products } = extended_info;
const formattedProducts = products
.sort( ( itemA, itemB ) => itemB.quantity - itemA.quantity )
.map( item => ( {
label: item.name,
quantity: item.quantity,
2019-03-19 01:27:31 +00:00
href: getNewPath( persistedQuery, '/analytics/products', {
filter: 'single_product',
products: item.id,
} ),
} ) );
const formattedCoupons = coupons.map( coupon => ( {
label: coupon.code,
2019-03-19 01:27:31 +00:00
href: getNewPath( persistedQuery, '/analytics/coupons', {
filter: 'single_coupon',
coupons: coupon.id,
} ),
} ) );
return [
{
display: <Date date={ date_created } visibleFormat={ defaultTableDateFormat } />,
value: date_created,
},
{
display: (
<Link
href={
'post.php?post=' +
( parent_id ? parent_id : order_id ) +
'&action=edit' +
( parent_id ? '#order_refunds' : '' )
}
type="wp-admin"
>
{ order_number }
</Link>
),
value: order_number,
},
{
display: (
<OrderStatus
className="woocommerce-orders-table__status"
order={ { status } }
orderStatusMap={ getSetting( 'orderStatuses', {} ) }
/>
),
value: status,
},
{
display: this.getCustomerType( customer_type ),
value: customer_type,
},
{
display: this.renderList(
formattedProducts.length ? [ formattedProducts[ 0 ] ] : [],
formattedProducts.map( product => ( {
label: sprintf(
__( '%s× %s', 'woocommerce-admin' ),
product.quantity,
product.label
),
href: product.href,
} ) )
),
value: formattedProducts
.map( ( { quantity, label } ) =>
sprintf( __( '%s× %s', 'woocommerce-admin' ), quantity, label )
)
.join( ', ' ),
},
{
display: formatValue( 'number', num_items_sold ),
value: num_items_sold,
},
{
display: this.renderList(
formattedCoupons.length ? [ formattedCoupons[ 0 ] ] : [],
formattedCoupons
),
value: formattedCoupons.map( coupon => coupon.label ).join( ', ' ),
},
{
display: renderCurrency( net_total, currency ),
value: net_total,
},
];
} );
}
getSummary( totals ) {
const {
orders_count = 0,
num_new_customers = 0,
num_returning_customers = 0,
products = 0,
num_items_sold = 0,
coupons_count = 0,
net_revenue = 0,
} = totals;
return [
{
label: _n( 'order', 'orders', orders_count, 'woocommerce-admin' ),
value: formatValue( 'number', orders_count ),
},
{
label: _n( 'new customer', 'new customers', num_new_customers, 'woocommerce-admin' ),
value: formatValue( 'number', num_new_customers ),
},
{
label: _n(
'returning customer',
'returning customers',
num_returning_customers,
'woocommerce-admin'
),
value: formatValue( 'number', num_returning_customers ),
},
{
label: _n( 'product', 'products', products, 'woocommerce-admin' ),
value: formatValue( 'number', products ),
},
{
label: _n( 'item sold', 'items sold', num_items_sold, 'woocommerce-admin' ),
value: formatValue( 'number', num_items_sold ),
},
{
label: _n( 'coupon', 'coupons', coupons_count, 'woocommerce-admin' ),
value: formatValue( 'number', coupons_count ),
},
{
Correcting and clarifying analytics terms and calculations (https://github.com/woocommerce/woocommerce-admin/pull/3104) * Relabel Net Revenue to Net Sales, revert previous refund work on Gross revenue and rename to total sales. Update the orer of all the things * Add gross sales calculation to revenue stats endpoint. * Restore coupon_total when updating order stats. * Wire up gross sales to revenue report. * Fix revenue report refunds calculation when there are no refunds. * update net sales labels and cases in order, product and category tables * Subtract refunded shipping and taxes from gross sales. * pluses to minuses to fix the gross revenue and refund totals when refunding * Add gross_sales to revenue stats orderby enum. * Change refund labels to Returns * Remove usage of defunct coupon_total column. * Store refunded amount in stats table. * Rename "gross_total" column to "total_sales". * Net total for refund orders can be used instead of a new column. * Rename gross_revenue to total_sales. * Coalesce coupons total in order stats query. SUM()ing all nulls gives null, not zero. * Use segmentation selections to backfill missing data. Fo when report columns and segmentation columns don't match. * Remove errant gross_sales from expected interval test data. * Fix gross sales tests for revenue/stats. * Move missing segment fills back to their original locations. * Fix remaining tests failing because of gross sales. * Fix db upgrade function rename of gross_total column. * Fix linter errors.
2019-11-22 15:06:14 +00:00
label: __( 'net sales', 'woocommerce-admin' ),
value: formatCurrency( net_revenue ),
},
];
}
renderLinks( items = [] ) {
return items.map( ( item, i ) => (
<Link href={ item.href } key={ i } type="wc-admin">
{ item.label }
</Link>
) );
}
renderList( visibleItems, popoverItems ) {
return (
<Fragment>
{ this.renderLinks( visibleItems ) }
{ popoverItems.length > 1 && <ViewMoreList items={ this.renderLinks( popoverItems ) } /> }
</Fragment>
);
}
render() {
2019-03-21 03:25:05 +00:00
const { query, filters, advancedFilters } = this.props;
return (
<ReportTable
endpoint="orders"
getHeadersContent={ this.getHeadersContent }
getRowsContent={ this.getRowsContent }
getSummary={ this.getSummary }
query={ query }
tableQuery={ {
extended_info: true,
} }
title={ __( 'Orders', 'woocommerce-admin' ) }
columnPrefsKey="orders_report_columns"
2019-03-21 03:25:05 +00:00
filters={ filters }
advancedFilters={ advancedFilters }
/>
);
}
}