/** * External dependencies */ import { __, _x } from '@wordpress/i18n'; import { applyFilters } from '@wordpress/hooks'; import { dispatch } from '@wordpress/data'; import { STORE_KEY as CES_STORE_KEY } from '@woocommerce/customer-effort-score'; /** * Internal dependencies */ import { getCategoryLabels, getProductLabels, getVariationLabels, } from '../../../lib/async-requests'; const VARIATIONS_REPORT_CHARTS_FILTER = 'woocommerce_admin_variations_report_charts'; const VARIATIONS_REPORT_FILTERS_FILTER = 'woocommerce_admin_variations_report_filters'; const VARIATIONS_REPORT_ADVANCED_FILTERS_FILTER = 'woocommerce_admin_variations_report_advanced_filters'; const { addCesSurveyForAnalytics } = dispatch( CES_STORE_KEY ); /** * @typedef {import('../index.js').chart} chart */ /** * Variations Report charts filter. * * @filter woocommerce_admin_variations_report_charts * @param {Array.} charts Report charts. */ export const charts = applyFilters( VARIATIONS_REPORT_CHARTS_FILTER, [ { key: 'items_sold', label: __( 'Items sold', 'woocommerce' ), order: 'desc', orderby: 'items_sold', type: 'number', }, { key: 'net_revenue', label: __( 'Net sales', 'woocommerce' ), order: 'desc', orderby: 'net_revenue', type: 'currency', }, { key: 'orders_count', label: __( 'Orders', 'woocommerce' ), order: 'desc', orderby: 'orders_count', type: 'number', }, ] ); /** * @typedef {import('../index.js').filter} filter */ /** * Variations Report Filters. * * @filter woocommerce_admin_variations_report_filters * @param {Array.} filters Report filters. */ export const filters = applyFilters( VARIATIONS_REPORT_FILTERS_FILTER, [ { label: __( 'Show', 'woocommerce' ), staticParams: [ 'chartType', 'paged', 'per_page' ], param: 'filter-variations', showFilters: () => true, filters: [ { label: __( 'All variations', 'woocommerce' ), chartMode: 'item-comparison', value: 'all', }, { label: __( 'Single variation', 'woocommerce' ), value: 'select_variation', subFilters: [ { component: 'Search', value: 'single_variation', path: [ 'select_variation' ], settings: { type: 'variations', param: 'variations', getLabels: getVariationLabels, labels: { placeholder: __( 'Type to search for a variation', 'woocommerce' ), button: __( 'Single variation', 'woocommerce' ), }, }, }, ], }, { label: __( 'Comparison', 'woocommerce' ), chartMode: 'item-comparison', value: 'compare-variations', settings: { type: 'variations', param: 'variations', getLabels: getVariationLabels, labels: { helpText: __( 'Check at least two variations below to compare', 'woocommerce' ), placeholder: __( 'Search for variations to compare', 'woocommerce' ), title: __( 'Compare Variations', 'woocommerce' ), update: __( 'Compare', 'woocommerce' ), }, onClick: addCesSurveyForAnalytics, }, }, { label: __( 'Advanced filters', 'woocommerce' ), value: 'advanced', }, ], }, ] ); /** * Variations Report Advanced Filters. * * @filter woocommerce_admin_variations_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( VARIATIONS_REPORT_ADVANCED_FILTERS_FILTER, { title: _x( 'Variations match