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

517 lines
15 KiB
JavaScript

/**
* External dependencies
*/
import { __, _x } from '@wordpress/i18n';
import { decodeEntities } from '@wordpress/html-entities';
import { applyFilters } from '@wordpress/hooks';
import { getSetting } from '@woocommerce/wc-admin-settings';
const { countries } = getSetting( 'dataEndpoints', { countries: {} } );
/**
* Internal dependencies
*/
import { getCustomerLabels, getRequestByIdString } from 'lib/async-requests';
import { NAMESPACE } from 'wc-api/constants';
const CUSTOMERS_REPORT_FILTERS_FILTER =
'woocommerce_admin_customers_report_filters';
const CUSTOMERS_REPORT_ADVANCED_FILTERS_FILTER =
'woocommerce_admin_customers_report_advanced_filters';
export const filters = applyFilters( CUSTOMERS_REPORT_FILTERS_FILTER, [
{
label: __( 'Show', 'woocommerce-admin' ),
staticParams: [ 'paged', 'per_page' ],
param: 'filter',
showFilters: () => true,
filters: [
{ label: __( 'All Customers', 'woocommerce-admin' ), value: 'all' },
{
label: __( 'Single Customer', 'woocommerce-admin' ),
value: 'select_customer',
chartMode: 'item-comparison',
subFilters: [
{
component: 'Search',
value: 'single_customer',
chartMode: 'item-comparison',
path: [ 'select_customer' ],
settings: {
type: 'customers',
param: 'customers',
getLabels: getCustomerLabels,
labels: {
placeholder: __(
'Type to search for a customer',
'woocommerce-admin'
),
button: __(
'Single Customer',
'woocommerce-admin'
),
},
},
},
],
},
{
label: __( 'Advanced Filters', 'woocommerce-admin' ),
value: 'advanced',
},
],
},
] );
/*eslint-disable max-len*/
export const advancedFilters = applyFilters(
CUSTOMERS_REPORT_ADVANCED_FILTERS_FILTER,
{
title: _x(
'Customers Match {{select /}} Filters',
'A sentence describing filters for Customers. See screen shot for context: https://cloudup.com/cCsm3GeXJbE',
'woocommerce-admin'
),
filters: {
name: {
labels: {
add: __( 'Name', 'woocommerce-admin' ),
placeholder: __( 'Search', 'woocommerce-admin' ),
remove: __(
'Remove customer name filter',
'woocommerce-admin'
),
rule: __(
'Select a customer name filter match',
'woocommerce-admin'
),
/* translators: A sentence describing a Product filter. See screen shot for context: https://cloudup.com/cCsm3GeXJbE */
title: __(
'{{title}}Name{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
filter: __( 'Select customer name', 'woocommerce-admin' ),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to customer names including a given name(s). Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Includes',
'customer names',
'woocommerce-admin'
),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to customer names excluding a given name(s). Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Excludes',
'customer names',
'woocommerce-admin'
),
},
],
input: {
component: 'Search',
type: 'customers',
getLabels: getRequestByIdString(
NAMESPACE + '/customers',
( customer ) => ( {
id: customer.id,
label: customer.name,
} )
),
},
},
country: {
labels: {
add: __( 'Country / Region', 'woocommerce-admin' ),
placeholder: __( 'Search', 'woocommerce-admin' ),
remove: __(
'Remove country / region filter',
'woocommerce-admin'
),
rule: __(
'Select a country / region filter match',
'woocommerce-admin'
),
/* translators: A sentence describing a Product filter. See screen shot for context: https://cloudup.com/cCsm3GeXJbE */
title: __(
'{{title}}Country / Region{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
filter: __(
'Select country / region',
'woocommerce-admin'
),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to countries including a given country or countries. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Includes',
'countries',
'woocommerce-admin'
),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to countries excluding a given country or countries. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Excludes',
'countries',
'woocommerce-admin'
),
},
],
input: {
component: 'Search',
type: 'countries',
getLabels: async ( value ) => {
const allLabels = countries.map( ( country ) => ( {
key: country.code,
label: decodeEntities( country.name ),
} ) );
const labels = value.split( ',' );
return await allLabels.filter( ( label ) => {
return labels.includes( label.key );
} );
},
},
},
username: {
labels: {
add: __( 'Username', 'woocommerce-admin' ),
placeholder: __(
'Search customer username',
'woocommerce-admin'
),
remove: __(
'Remove customer username filter',
'woocommerce-admin'
),
rule: __(
'Select a customer username filter match',
'woocommerce-admin'
),
/* translators: A sentence describing a customer username filter. See screen shot for context: https://cloudup.com/cCsm3GeXJbE */
title: __(
'{{title}}Username{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
filter: __(
'Select customer username',
'woocommerce-admin'
),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to customer usernames including a given username(s). Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Includes',
'customer usernames',
'woocommerce-admin'
),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to customer usernames excluding a given username(s). Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Excludes',
'customer usernames',
'woocommerce-admin'
),
},
],
input: {
component: 'Search',
type: 'usernames',
getLabels: getCustomerLabels,
},
},
email: {
labels: {
add: __( 'Email', 'woocommerce-admin' ),
placeholder: __(
'Search customer email',
'woocommerce-admin'
),
remove: __(
'Remove customer email filter',
'woocommerce-admin'
),
rule: __(
'Select a customer email filter match',
'woocommerce-admin'
),
/* translators: A sentence describing a customer email filter. See screen shot for context: https://cloudup.com/cCsm3GeXJbE */
title: __(
'{{title}}Email{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
filter: __( 'Select customer email', 'woocommerce-admin' ),
},
rules: [
{
value: 'includes',
/* translators: Sentence fragment, logical, "Includes" refers to customer emails including a given email(s). Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Includes',
'customer emails',
'woocommerce-admin'
),
},
{
value: 'excludes',
/* translators: Sentence fragment, logical, "Excludes" refers to customer emails excluding a given email(s). Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Excludes',
'customer emails',
'woocommerce-admin'
),
},
],
input: {
component: 'Search',
type: 'emails',
getLabels: getRequestByIdString(
NAMESPACE + '/customers',
( customer ) => ( {
id: customer.id,
label: customer.email,
} )
),
},
},
orders_count: {
labels: {
add: __( 'No. of Orders', 'woocommerce-admin' ),
remove: __( 'Remove order filter', 'woocommerce-admin' ),
rule: __(
'Select an order count filter match',
'woocommerce-admin'
),
title: __(
'{{title}}No. of Orders{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
},
rules: [
{
value: 'max',
/* translators: Sentence fragment, logical, "Less Than" refers to number of orders a customer has placed, less than a given amount. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Less Than',
'number of orders',
'woocommerce-admin'
),
},
{
value: 'min',
/* translators: Sentence fragment, logical, "More Than" refers to number of orders a customer has placed, more than a given amount. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'More Than',
'number of orders',
'woocommerce-admin'
),
},
{
value: 'between',
/* translators: Sentence fragment, logical, "Between" refers to number of orders a customer has placed, between two given integers. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Between',
'number of orders',
'woocommerce-admin'
),
},
],
input: {
component: 'Number',
},
},
total_spend: {
labels: {
add: __( 'Total Spend', 'woocommerce-admin' ),
remove: __(
'Remove total spend filter',
'woocommerce-admin'
),
rule: __(
'Select a total spend filter match',
'woocommerce-admin'
),
title: __(
'{{title}}Total Spend{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
},
rules: [
{
value: 'max',
/* translators: Sentence fragment, logical, "Less Than" refers to total spending by a customer, less than a given amount. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Less Than',
'total spend by customer',
'woocommerce-admin'
),
},
{
value: 'min',
/* translators: Sentence fragment, logical, "Less Than" refers to total spending by a customer, more than a given amount. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'More Than',
'total spend by customer',
'woocommerce-admin'
),
},
{
value: 'between',
/* translators: Sentence fragment, logical, "Between" refers to total spending by a customer, between two given amounts. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Between',
'total spend by customer',
'woocommerce-admin'
),
},
],
input: {
component: 'Currency',
},
},
avg_order_value: {
labels: {
add: __( 'AOV', 'woocommerce-admin' ),
remove: __(
'Remove average order value filter',
'woocommerce-admin'
),
rule: __(
'Select an average order value filter match',
'woocommerce-admin'
),
title: __(
'{{title}}AOV{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
},
rules: [
{
value: 'max',
/* translators: Sentence fragment, logical, "Less Than" refers to average order value of a customer, more than a given amount. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Less Than',
'average order value of customer',
'woocommerce-admin'
),
},
{
value: 'min',
/* translators: Sentence fragment, logical, "Less Than" refers to average order value of a customer, less than a given amount. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'More Than',
'average order value of customer',
'woocommerce-admin'
),
},
{
value: 'between',
/* translators: Sentence fragment, logical, "Between" refers to average order value of a customer, between two given amounts. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x(
'Between',
'average order value of customer',
'woocommerce-admin'
),
},
],
input: {
component: 'Currency',
},
},
registered: {
labels: {
add: __( 'Registered', 'woocommerce-admin' ),
remove: __(
'Remove registered filter',
'woocommerce-admin'
),
rule: __(
'Select a registered filter match',
'woocommerce-admin'
),
/* translators: A sentence describing a Product filter. See screen shot for context: https://cloudup.com/cCsm3GeXJbE */
title: __(
'{{title}}Registered{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
filter: __( 'Select registered date', 'woocommerce-admin' ),
},
rules: [
{
value: 'before',
/* translators: Sentence fragment, logical, "Before" refers to customers registered before a given date. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x( 'Before', 'date', 'woocommerce-admin' ),
},
{
value: 'after',
/* translators: Sentence fragment, logical, "after" refers to customers registered after a given date. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x( 'After', 'date', 'woocommerce-admin' ),
},
{
value: 'between',
/* translators: Sentence fragment, logical, "Between" refers to average order value of a customer, between two given amounts. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x( 'Between', 'date', 'woocommerce-admin' ),
},
],
input: {
component: 'Date',
},
},
last_active: {
labels: {
add: __( 'Last active', 'woocommerce-admin' ),
remove: __(
'Remove last active filter',
'woocommerce-admin'
),
rule: __(
'Select a last active filter match',
'woocommerce-admin'
),
/* translators: A sentence describing a Product filter. See screen shot for context: https://cloudup.com/cCsm3GeXJbE */
title: __(
'{{title}}Last active{{/title}} {{rule /}} {{filter /}}',
'woocommerce-admin'
),
filter: __( 'Select registered date', 'woocommerce-admin' ),
},
rules: [
{
value: 'before',
/* translators: Sentence fragment, logical, "Before" refers to customers registered before a given date. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x( 'Before', 'date', 'woocommerce-admin' ),
},
{
value: 'after',
/* translators: Sentence fragment, logical, "after" refers to customers registered after a given date. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x( 'After', 'date', 'woocommerce-admin' ),
},
{
value: 'between',
/* translators: Sentence fragment, logical, "Between" refers to average order value of a customer, between two given amounts. Screenshot for context: https://cloudup.com/cCsm3GeXJbE */
label: _x( 'Between', 'date', 'woocommerce-admin' ),
},
],
input: {
component: 'Date',
},
},
},
}
);
/*eslint-enable max-len*/