-
Notifications
You must be signed in to change notification settings - Fork 10.7k
/
config.js
223 lines (212 loc) · 5.31 KB
/
config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/**
* 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 {
getProductLabels,
getVariationLabels,
} from '../../../lib/async-requests';
const PRODUCTS_REPORT_CHARTS_FILTER =
'woocommerce_admin_products_report_charts';
const PRODUCTS_REPORT_FILTERS_FILTER =
'woocommerce_admin_products_report_filters';
const PRODUCTS_REPORT_ADVANCED_FILTERS_FILTER =
'woocommerce_admin_products_report_advanced_filters';
const { addCesSurveyForAnalytics } = dispatch( CES_STORE_KEY );
/**
* @typedef {import('../index.js').chart} chart
*/
/**
* Products Report charts filter.
*
* @filter woocommerce_admin_products_report_charts
* @param {Array.<chart>} charts Report charts.
*/
export const charts = applyFilters( PRODUCTS_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',
},
] );
const filterConfig = {
label: __( 'Show', 'woocommerce' ),
staticParams: [ 'chartType', 'paged', 'per_page' ],
param: 'filter',
showFilters: () => true,
filters: [
{ label: __( 'All products', 'woocommerce' ), value: 'all' },
{
label: __( 'Single product', 'woocommerce' ),
value: 'select_product',
chartMode: 'item-comparison',
subFilters: [
{
component: 'Search',
value: 'single_product',
chartMode: 'item-comparison',
path: [ 'select_product' ],
settings: {
type: 'products',
param: 'products',
getLabels: getProductLabels,
labels: {
placeholder: __(
'Type to search for a product',
'woocommerce'
),
button: __( 'Single product', 'woocommerce' ),
},
},
},
],
},
{
label: __( 'Comparison', 'woocommerce' ),
value: 'compare-products',
chartMode: 'item-comparison',
settings: {
type: 'products',
param: 'products',
getLabels: getProductLabels,
labels: {
helpText: __(
'Check at least two products below to compare',
'woocommerce'
),
placeholder: __(
'Search for products to compare',
'woocommerce'
),
title: __( 'Compare Products', 'woocommerce' ),
update: __( 'Compare', 'woocommerce' ),
},
onClick: addCesSurveyForAnalytics,
},
},
],
};
const variationsConfig = {
showFilters: ( query ) =>
query.filter === 'single_product' &&
!! query.products &&
query[ 'is-variable' ],
staticParams: [ 'filter', 'products', 'chartType', 'paged', 'per_page' ],
param: 'filter-variations',
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' ),
},
},
},
],
};
/**
* Produts Report Advanced Filters.
*
* @filter woocommerce_admin_products_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(
PRODUCTS_REPORT_ADVANCED_FILTERS_FILTER,
{
filters: {},
title: _x(
'Products Match {{select /}} Filters',
'A sentence describing filters for Products. See screen shot for context: https://cloudup.com/cSsUY9VeCVJ',
'woocommerce'
),
}
);
if ( Object.keys( advancedFilters.filters ).length ) {
filterConfig.filters.push( {
label: __( 'Advanced Filters', 'woocommerce' ),
value: 'advanced',
} );
variationsConfig.filters.push( {
label: __( 'Advanced Filters', 'woocommerce' ),
value: 'advanced',
} );
}
/**
* @typedef {import('../index.js').filter} filter
*/
/**
* Products Report Filters.
*
* @filter woocommerce_admin_products_report_filters
* @param {Array.<filter>} filters Report filters.
*/
export const filters = applyFilters( PRODUCTS_REPORT_FILTERS_FILTER, [
filterConfig,
variationsConfig,
] );