data-visualizer-app/src/modules/layoutValidation.js at c17b723dbf30f27b4d8eb15905c70d1ff937256e · dhis2/data-visualizer-app · GitHub

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
import {
    AXIS,
    DIMENSION_ID_PERIOD,
    VIS_TYPE_YEAR_OVER_YEAR_LINE,
    VIS_TYPE_YEAR_OVER_YEAR_COLUMN,
    VIS_TYPE_PIE,
    VIS_TYPE_DONUT,
    VIS_TYPE_GAUGE,
    VIS_TYPE_SINGLE_VALUE,
    VIS_TYPE_PIVOT_TABLE,
    VIS_TYPE_SCATTER,
    VIS_TYPE_OUTLIER_TABLE,
    getPredefinedDimensionProp,
    dimensionIsValid,
    layoutGetDimension,
    DIMENSION_PROP_NO_ITEMS,
    DIMENSION_ID_DATA,
} from '@dhis2/analytics'
import {
    NoSeriesError,
    NoCategoryError,
    NoPeriodError,
    NoDataError,
    NoSeriesOrCategoryError,
    NoPointsError,
    NoVerticalError,
    NoHorizontalError,
    DuplicateItemsError,
} from './error.js'
import { BASE_FIELD_YEARLY_SERIES } from './fields/baseFields.js'
import { ITEM_ATTRIBUTE_HORIZONTAL, ITEM_ATTRIBUTE_VERTICAL } from './ui.js'

// Layout validation helper functions
const isAxisValid = (axis) =>
    AXIS.isValid(axis) &&
    axis.some((axisItem) =>
        dimensionIsValid(axisItem, {
            requireItems: !getPredefinedDimensionProp(
                axisItem.dimension,
                DIMENSION_PROP_NO_ITEMS
            ),
        })
    )

const validateDimension = (dimension, error) => {
    if (!(dimension && dimensionIsValid(dimension, { requireItems: true }))) {
        throw error
    }
}

const validateAxis = (axis, error) => {
    if (!isAxisValid(axis)) {
        throw error
    }
}

// Layout validation
const validateDefaultLayout = (layout) => {
    validateAxis(layout.columns, new NoSeriesError(layout.type))
    validateAxis(layout.rows, new NoCategoryError(layout.type))
    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_PERIOD), // TODO: old validation rule, refactor
        new NoPeriodError(layout.type)
    )
}

const validatePivotTableLayout = (layout) => {
    if (!isAxisValid(layout.columns) && !isAxisValid(layout.rows)) {
        throw new NoSeriesOrCategoryError(layout.type)
    }
    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_PERIOD),
        new NoPeriodError(layout.type)
    )
}

const validateYearOverYearLayout = (layout) => {
    if (
        !(
            Array.isArray(layout[BASE_FIELD_YEARLY_SERIES]) &&
            typeof layout[BASE_FIELD_YEARLY_SERIES][0] === 'string'
        )
    ) {
        throw new NoSeriesError(layout.type)
    }

    validateAxis(layout.rows, new NoCategoryError(layout.type))
}

const validatePieLayout = (layout) => {
    validateAxis(layout.columns, new NoSeriesError(layout.type))
    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_PERIOD),
        new NoPeriodError(layout.type)
    )
}

const validateSingleValueLayout = (layout) => {
    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_DATA),
        new NoDataError(layout.type)
    )

    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_PERIOD),
        new NoPeriodError(layout.type)
    )
}

const validateScatterLayout = (layout) => {
    const verticalItems =
        layout.ui.itemAttributes?.filter(
            (item) => item.attribute === ITEM_ATTRIBUTE_VERTICAL
        ) || []
    const horizontalItems =
        layout.ui.itemAttributes?.filter(
            (item) => item.attribute === ITEM_ATTRIBUTE_HORIZONTAL
        ) || []
    if (!verticalItems.length) {
        throw new NoVerticalError()
    } else if (!horizontalItems.length) {
        throw new NoHorizontalError()
    } else if (verticalItems[0].id === horizontalItems[0].id) {
        throw new DuplicateItemsError()
    }
    validateAxis(layout.rows, new NoPointsError(layout.type))
    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_PERIOD),
        new NoPeriodError(layout.type)
    )
}

const validateOutlierTableLayout = (layout) => {
    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_DATA),
        new NoDataError(layout.type)
    )

    validateDimension(
        layoutGetDimension(layout, DIMENSION_ID_PERIOD),
        new NoPeriodError(layout.type)
    )
}

export const validateLayout = (layout) => {
    switch (layout.type) {
        case VIS_TYPE_PIE:
        case VIS_TYPE_DONUT:
            return validatePieLayout(layout)
        case VIS_TYPE_YEAR_OVER_YEAR_COLUMN:
        case VIS_TYPE_YEAR_OVER_YEAR_LINE:
            return validateYearOverYearLayout(layout)
        case VIS_TYPE_SINGLE_VALUE:
        case VIS_TYPE_GAUGE:
            return validateSingleValueLayout(layout)
        case VIS_TYPE_PIVOT_TABLE:
            return validatePivotTableLayout(layout)
        case VIS_TYPE_SCATTER:
            return validateScatterLayout(layout)
        case VIS_TYPE_OUTLIER_TABLE:
            return validateOutlierTableLayout(layout)
        default:
            return validateDefaultLayout(layout)
    }
}