woocommerce/plugins/woocommerce-admin/client/analytics/report/downloads/config.js

250 lines
7.5 KiB
JavaScript

/**
* External dependencies
*/
import { __, _x } from '@wordpress/i18n';
import { applyFilters } from '@wordpress/hooks';
/**
* Internal dependencies
*/
import {
getCustomerLabels,
getProductLabels,
} from '../../../lib/async-requests';
const DOWLOADS_REPORT_CHARTS_FILTER =
'woocommerce_admin_downloads_report_charts';
const DOWLOADS_REPORT_FILTERS_FILTER =
'woocommerce_admin_downloads_report_filters';
const DOWLOADS_REPORT_ADVANCED_FILTERS_FILTER =
'woocommerce_admin_downloads_report_advanced_filters';
/**
* @typedef {import('../index.js').chart} chart
*/
/**
* Downloads Report charts filter.
*
* @filter woocommerce_admin_downloads_report_charts
* @param {Array.<chart>} charts Report charts.
*/
export const charts = applyFilters( DOWLOADS_REPORT_CHARTS_FILTER, [
{
key: 'download_count',
label: __( 'Downloads', 'woocommerce' ),
type: 'number',
},
] );
/**
* @typedef {import('../index.js').filter} filter
*/
/**
* Downloads Report Filters.
*
* @filter woocommerce_admin_downloads_report_filters
* @param {Array.<filter>} filters Report filters.
*/
export const filters = applyFilters( DOWLOADS_REPORT_FILTERS_FILTER, [
{
label: __( 'Show', 'woocommerce' ),
staticParams: [ 'chartType', 'paged', 'per_page' ],
param: 'filter',
showFilters: () => true,
filters: [
{ label: __( 'All downloads', 'woocommerce' ), value: 'all' },
{
label: __( 'Advanced filters', 'woocommerce' ),
value: 'advanced',
},
],
},
] );
/*eslint-disable max-len*/
/**
* Downloads Report Advanced Filters.
*
* @filter woocommerce_admin_downloads_report_advanced_filters
* @param {Object} advancedFilters Report Advanced Filters.
* @param {string} advancedFilters.title Interpolated component string for Advanced Filters title.
* @param {Object} advancedFilters.filters An object specifying a report's Advanced Filters.
*/
export const advancedFilters = applyFilters(
DOWLOADS_REPORT_ADVANCED_FILTERS_FILTER,
{
title: _x(
'Downloads match {{select /}} filters',
'A sentence describing filters for Downloads. See screen shot for context: https://cloudup.com/ccxhyH2mEDg',
'woocommerce'
),
filters: {
product: {
labels: {
add: __( 'Product', 'woocommerce' ),
placeholder: __( 'Search', 'woocommerce' ),
remove: __( 'Remove product filter', 'woocommerce' ),
rule: __( 'Select a product filter match', 'woocommerce' ),
/* translators: A sentence describing a Product filter. See screen shot for context: https://cloudup.com/ccxhyH2mEDg */
title: __(
'{{title}}Product{{/title}} {{rule /}} {{filter /}}',
'woocommerce'
),
filter: __( 'Select product', 'woocommerce' ),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to products including a given product(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x( 'Includes', 'products', 'woocommerce' ),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to products excluding a products(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x( 'Excludes', 'products', 'woocommerce' ),
},
],
input: {
component: 'Search',
type: 'products',
getLabels: getProductLabels,
},
},
customer: {
labels: {
add: __( 'Username', 'woocommerce' ),
placeholder: __(
'Search customer username',
'woocommerce'
),
remove: __(
'Remove customer username filter',
'woocommerce'
),
rule: __(
'Select a customer username filter match',
'woocommerce'
),
/* translators: A sentence describing a customer username filter. See screen shot for context: https://cloudup.com/ccxhyH2mEDg */
title: __(
'{{title}}Username{{/title}} {{rule /}} {{filter /}}',
'woocommerce'
),
filter: __( 'Select customer username', 'woocommerce' ),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to customer usernames including a given username(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x(
'Includes',
'customer usernames',
'woocommerce'
),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to customer usernames excluding a given username(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x(
'Excludes',
'customer usernames',
'woocommerce'
),
},
],
input: {
component: 'Search',
type: 'usernames',
getLabels: getCustomerLabels,
},
},
order: {
labels: {
add: __( 'Order #', 'woocommerce' ),
placeholder: __( 'Search order number', 'woocommerce' ),
remove: __( 'Remove order number filter', 'woocommerce' ),
rule: __(
'Select a order number filter match',
'woocommerce'
),
/* translators: A sentence describing a order number filter. See screen shot for context: https://cloudup.com/ccxhyH2mEDg */
title: __(
'{{title}}Order #{{/title}} {{rule /}} {{filter /}}',
'woocommerce'
),
filter: __( 'Select order number', 'woocommerce' ),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to order numbers including a given order(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x( 'Includes', 'order numbers', 'woocommerce' ),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to order numbers excluding a given order(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x( 'Excludes', 'order numbers', 'woocommerce' ),
},
],
input: {
component: 'Search',
type: 'orders',
getLabels: async ( value ) => {
const orderIds = value.split( ',' );
return await orderIds.map( ( orderId ) => ( {
id: orderId,
label: '#' + orderId,
} ) );
},
},
},
ip_address: {
labels: {
add: __( 'IP Address', 'woocommerce' ),
placeholder: __( 'Search IP address', 'woocommerce' ),
remove: __( 'Remove IP address filter', 'woocommerce' ),
rule: __(
'Select an IP address filter match',
'woocommerce'
),
/* translators: A sentence describing a order number filter. See screen shot for context: https://cloudup.com/ccxhyH2mEDg */
title: __(
'{{title}}IP Address{{/title}} {{rule /}} {{filter /}}',
'woocommerce'
),
filter: __( 'Select IP address', 'woocommerce' ),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to IP addresses including a given address(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x( 'Includes', 'IP addresses', 'woocommerce' ),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to IP addresses excluding a given address(s). Screenshot for context: https://cloudup.com/ccxhyH2mEDg */
label: _x( 'Excludes', 'IP addresses', 'woocommerce' ),
},
],
input: {
component: 'Search',
type: 'downloadIps',
getLabels: async ( value ) => {
const ips = value.split( ',' );
return await ips.map( ( ip ) => {
return {
id: ip,
label: ip,
};
} );
},
},
},
},
}
);
/*eslint-enable max-len*/