@opendata-ai/openchart-engine 8.0.0-rc.10 → 8.0.0-rc.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (270) hide show
  1. package/dist/index.js +2 -3
  2. package/dist/index.js.map +1 -1
  3. package/package.json +3 -4
  4. package/src/__test-fixtures__/specs.ts +0 -182
  5. package/src/__tests__/__snapshots__/compile-snapshot.test.ts.snap +0 -2401
  6. package/src/__tests__/annotation-behavior.test.ts +0 -852
  7. package/src/__tests__/axes.test.ts +0 -1579
  8. package/src/__tests__/compile-animation.test.ts +0 -161
  9. package/src/__tests__/compile-chart.test.ts +0 -1303
  10. package/src/__tests__/compile-footnotes.test.ts +0 -277
  11. package/src/__tests__/compile-layer.test.ts +0 -969
  12. package/src/__tests__/compile-snapshot.test.ts +0 -156
  13. package/src/__tests__/compound-labels.test.ts +0 -147
  14. package/src/__tests__/dimensions.test.ts +0 -918
  15. package/src/__tests__/encoding-sugar.test.ts +0 -390
  16. package/src/__tests__/facet.test.ts +0 -359
  17. package/src/__tests__/helpers/invariants.ts +0 -299
  18. package/src/__tests__/known-bugs.test.ts +0 -566
  19. package/src/__tests__/layout-fuzz.test.ts +0 -358
  20. package/src/__tests__/layout-invariants.test.ts +0 -535
  21. package/src/__tests__/legend.test.ts +0 -721
  22. package/src/__tests__/mark-keys.test.ts +0 -294
  23. package/src/__tests__/ranking-recipes.test.ts +0 -260
  24. package/src/__tests__/rotation.test.ts +0 -83
  25. package/src/__tests__/scales.test.ts +0 -323
  26. package/src/__tests__/series-search.test.ts +0 -92
  27. package/src/__tests__/spec-sugar.test.ts +0 -801
  28. package/src/__tests__/you-draw-it.test.ts +0 -160
  29. package/src/annotations/__tests__/compute.test.ts +0 -1672
  30. package/src/annotations/__tests__/geometry.test.ts +0 -66
  31. package/src/annotations/__tests__/placement-fuzz.test.ts +0 -256
  32. package/src/annotations/__tests__/placement-invariants.test.ts +0 -345
  33. package/src/annotations/__tests__/placement.test.ts +0 -316
  34. package/src/annotations/__tests__/resolve-text.test.ts +0 -788
  35. package/src/annotations/__tests__/rich-text.test.ts +0 -91
  36. package/src/annotations/__tests__/thinning.test.ts +0 -285
  37. package/src/annotations/collisions.ts +0 -326
  38. package/src/annotations/compute.ts +0 -333
  39. package/src/annotations/constants.ts +0 -162
  40. package/src/annotations/geometry.ts +0 -376
  41. package/src/annotations/move.ts +0 -135
  42. package/src/annotations/placement.ts +0 -636
  43. package/src/annotations/position.ts +0 -131
  44. package/src/annotations/resolve-range.ts +0 -117
  45. package/src/annotations/resolve-refline.ts +0 -157
  46. package/src/annotations/resolve-text.ts +0 -545
  47. package/src/annotations/rich-text.ts +0 -65
  48. package/src/annotations/thinning.ts +0 -190
  49. package/src/barlist/__tests__/compile-barlist.test.ts +0 -200
  50. package/src/barlist/compile-barlist.ts +0 -391
  51. package/src/barlist/types.ts +0 -28
  52. package/src/charts/__tests__/post-process.test.ts +0 -237
  53. package/src/charts/__tests__/registry.test.ts +0 -116
  54. package/src/charts/__tests__/utils.test.ts +0 -195
  55. package/src/charts/_shared/__tests__/density-filter.test.ts +0 -32
  56. package/src/charts/_shared/density-filter.ts +0 -26
  57. package/src/charts/_shared/format-label-value.ts +0 -16
  58. package/src/charts/bar/__tests__/compute.test.ts +0 -934
  59. package/src/charts/bar/__tests__/gradient-orient.test.ts +0 -127
  60. package/src/charts/bar/__tests__/labels.test.ts +0 -292
  61. package/src/charts/bar/compute.ts +0 -539
  62. package/src/charts/bar/index.ts +0 -60
  63. package/src/charts/bar/labels.ts +0 -311
  64. package/src/charts/beeswarm/__tests__/compute.test.ts +0 -280
  65. package/src/charts/beeswarm/__tests__/dodge.test.ts +0 -148
  66. package/src/charts/beeswarm/compute.ts +0 -203
  67. package/src/charts/beeswarm/dodge.ts +0 -155
  68. package/src/charts/beeswarm/index.ts +0 -32
  69. package/src/charts/builtin.ts +0 -75
  70. package/src/charts/calendar/__tests__/compute.test.ts +0 -417
  71. package/src/charts/calendar/compute.ts +0 -319
  72. package/src/charts/calendar/index.ts +0 -32
  73. package/src/charts/column/__tests__/compute.test.ts +0 -540
  74. package/src/charts/column/__tests__/labels.test.ts +0 -179
  75. package/src/charts/column/compute.ts +0 -493
  76. package/src/charts/column/index.ts +0 -53
  77. package/src/charts/column/labels.ts +0 -229
  78. package/src/charts/dot/__tests__/compute.test.ts +0 -380
  79. package/src/charts/dot/__tests__/labels.test.ts +0 -98
  80. package/src/charts/dot/compute.ts +0 -285
  81. package/src/charts/dot/index.ts +0 -62
  82. package/src/charts/dot/labels.ts +0 -121
  83. package/src/charts/line/__tests__/compute.test.ts +0 -1194
  84. package/src/charts/line/__tests__/curves.test.ts +0 -51
  85. package/src/charts/line/__tests__/labels.test.ts +0 -94
  86. package/src/charts/line/__tests__/mark-options.test.ts +0 -175
  87. package/src/charts/line/area.ts +0 -484
  88. package/src/charts/line/compute.ts +0 -356
  89. package/src/charts/line/curves.ts +0 -85
  90. package/src/charts/line/index.ts +0 -176
  91. package/src/charts/line/labels.ts +0 -177
  92. package/src/charts/parliament/__tests__/compute.test.ts +0 -411
  93. package/src/charts/parliament/compute.ts +0 -313
  94. package/src/charts/parliament/index.ts +0 -32
  95. package/src/charts/pie/__tests__/compute.test.ts +0 -384
  96. package/src/charts/pie/__tests__/labels.test.ts +0 -132
  97. package/src/charts/pie/compute.ts +0 -324
  98. package/src/charts/pie/index.ts +0 -49
  99. package/src/charts/pie/labels.ts +0 -143
  100. package/src/charts/post-process.ts +0 -229
  101. package/src/charts/range/__tests__/compute.test.ts +0 -486
  102. package/src/charts/range/compute.ts +0 -273
  103. package/src/charts/range/index.ts +0 -82
  104. package/src/charts/range/labels.ts +0 -169
  105. package/src/charts/rect/__tests__/compute.test.ts +0 -120
  106. package/src/charts/rect/index.ts +0 -127
  107. package/src/charts/registry.ts +0 -72
  108. package/src/charts/rule/index.ts +0 -139
  109. package/src/charts/scatter/__tests__/compute.test.ts +0 -488
  110. package/src/charts/scatter/__tests__/trendline.test.ts +0 -191
  111. package/src/charts/scatter/compute.ts +0 -192
  112. package/src/charts/scatter/index.ts +0 -46
  113. package/src/charts/scatter/trendline.ts +0 -100
  114. package/src/charts/text/__tests__/compute.test.ts +0 -307
  115. package/src/charts/text/index.ts +0 -141
  116. package/src/charts/tick/__tests__/compute.test.ts +0 -75
  117. package/src/charts/tick/index.ts +0 -99
  118. package/src/charts/utils.ts +0 -170
  119. package/src/charts/waffle/__tests__/compute.test.ts +0 -305
  120. package/src/charts/waffle/compute.ts +0 -197
  121. package/src/charts/waffle/index.ts +0 -31
  122. package/src/compile/__tests__/color-scale-range.test.ts +0 -158
  123. package/src/compile/__tests__/color-scale-reverse.test.ts +0 -89
  124. package/src/compile/__tests__/data-clip.test.ts +0 -127
  125. package/src/compile/__tests__/fill-patterns.test.ts +0 -154
  126. package/src/compile/__tests__/size-scale.test.ts +0 -108
  127. package/src/compile/__tests__/watermark-obstacle.test.ts +0 -93
  128. package/src/compile/color-scale-range.ts +0 -101
  129. package/src/compile/data-clip.ts +0 -48
  130. package/src/compile/fill-patterns.ts +0 -74
  131. package/src/compile/layer.ts +0 -630
  132. package/src/compile/size-scale.ts +0 -141
  133. package/src/compile/spec-sugar.ts +0 -767
  134. package/src/compile/watermark-obstacle.ts +0 -54
  135. package/src/compile/you-draw-it.ts +0 -123
  136. package/src/compile.ts +0 -1548
  137. package/src/compiler/__tests__/a11y-warnings.test.ts +0 -148
  138. package/src/compiler/__tests__/animation.test.ts +0 -177
  139. package/src/compiler/__tests__/compile.test.ts +0 -87
  140. package/src/compiler/__tests__/fixtures/vl-parity/axis-null.json +0 -19
  141. package/src/compiler/__tests__/fixtures/vl-parity/color-value.json +0 -20
  142. package/src/compiler/__tests__/fixtures/vl-parity/count-aggregate.json +0 -22
  143. package/src/compiler/__tests__/fixtures/vl-parity/data-values.json +0 -19
  144. package/src/compiler/__tests__/fixtures/vl-parity/layer-axis-null.json +0 -14
  145. package/src/compiler/__tests__/fixtures/vl-parity/layer-count.json +0 -34
  146. package/src/compiler/__tests__/fixtures/vl-parity/layer-data-values.json +0 -22
  147. package/src/compiler/__tests__/fixtures/vl-parity/layer-legend-null.json +0 -41
  148. package/src/compiler/__tests__/fixtures/vl-parity/layer-scheme.json +0 -38
  149. package/src/compiler/__tests__/fixtures/vl-parity/layer-sort.json +0 -28
  150. package/src/compiler/__tests__/fixtures/vl-parity/layer-theta.json +0 -28
  151. package/src/compiler/__tests__/fixtures/vl-parity/layer-title.json +0 -30
  152. package/src/compiler/__tests__/fixtures/vl-parity/layer-value-def.json +0 -29
  153. package/src/compiler/__tests__/fixtures/vl-parity/legend-null.json +0 -32
  154. package/src/compiler/__tests__/fixtures/vl-parity/scheme.json +0 -25
  155. package/src/compiler/__tests__/fixtures/vl-parity/sort-by-value.json +0 -19
  156. package/src/compiler/__tests__/fixtures/vl-parity/theta-arc.json +0 -19
  157. package/src/compiler/__tests__/fixtures/vl-parity/title-subtitle.json +0 -21
  158. package/src/compiler/__tests__/fixtures/vl-parity/width-height.json +0 -23
  159. package/src/compiler/__tests__/keys.test.ts +0 -83
  160. package/src/compiler/__tests__/normalize-highlight.test.ts +0 -103
  161. package/src/compiler/__tests__/normalize.test.ts +0 -399
  162. package/src/compiler/__tests__/sparkline-defaults.test.ts +0 -153
  163. package/src/compiler/__tests__/validate-did-you-mean.test.ts +0 -170
  164. package/src/compiler/__tests__/validate-highlight.test.ts +0 -112
  165. package/src/compiler/__tests__/validate-near-miss.test.ts +0 -251
  166. package/src/compiler/__tests__/validate.test.ts +0 -731
  167. package/src/compiler/__tests__/vl-parity.test.ts +0 -68
  168. package/src/compiler/a11y-warnings.ts +0 -110
  169. package/src/compiler/animation.ts +0 -142
  170. package/src/compiler/index.ts +0 -47
  171. package/src/compiler/keys.ts +0 -55
  172. package/src/compiler/normalize.ts +0 -734
  173. package/src/compiler/sparkline-defaults.ts +0 -138
  174. package/src/compiler/types.ts +0 -241
  175. package/src/compiler/validate.ts +0 -2093
  176. package/src/endpoint-labels/__tests__/compute.test.ts +0 -587
  177. package/src/endpoint-labels/compute.ts +0 -621
  178. package/src/endpoint-labels/constants.ts +0 -54
  179. package/src/endpoint-labels/format.ts +0 -60
  180. package/src/endpoint-labels/predict.ts +0 -139
  181. package/src/format/__tests__/field-format.test.ts +0 -164
  182. package/src/format/field-format.ts +0 -27
  183. package/src/geo/__tests__/compile-map.test.ts +0 -1128
  184. package/src/geo/compile-map.ts +0 -1376
  185. package/src/geo/join.ts +0 -115
  186. package/src/geo/projections.ts +0 -65
  187. package/src/geo/types.ts +0 -26
  188. package/src/graphs/__tests__/community.test.ts +0 -228
  189. package/src/graphs/__tests__/compile-graph.test.ts +0 -396
  190. package/src/graphs/__tests__/encoding.test.ts +0 -415
  191. package/src/graphs/community.ts +0 -92
  192. package/src/graphs/compile-graph.ts +0 -329
  193. package/src/graphs/encoding.ts +0 -356
  194. package/src/graphs/types.ts +0 -106
  195. package/src/index.ts +0 -177
  196. package/src/layout/__tests__/metrics.test.ts +0 -97
  197. package/src/layout/__tests__/scales-highlight.test.ts +0 -192
  198. package/src/layout/axes/rotation.ts +0 -152
  199. package/src/layout/axes/thinning.ts +0 -98
  200. package/src/layout/axes/ticks.ts +0 -409
  201. package/src/layout/axes.ts +0 -757
  202. package/src/layout/dimensions.ts +0 -912
  203. package/src/layout/facet.ts +0 -91
  204. package/src/layout/gridlines.ts +0 -84
  205. package/src/layout/metrics.ts +0 -132
  206. package/src/layout/plan.ts +0 -631
  207. package/src/layout/scales.ts +0 -1053
  208. package/src/layout/shared.ts +0 -44
  209. package/src/legend/__tests__/continuous.test.ts +0 -318
  210. package/src/legend/__tests__/redundancy.test.ts +0 -108
  211. package/src/legend/__tests__/size.test.ts +0 -348
  212. package/src/legend/__tests__/suppression.test.ts +0 -382
  213. package/src/legend/compute.ts +0 -748
  214. package/src/legend/continuous.ts +0 -327
  215. package/src/legend/size.ts +0 -407
  216. package/src/legend/suppression.ts +0 -226
  217. package/src/legend/wrap.ts +0 -117
  218. package/src/sankey/__tests__/compile-sankey.test.ts +0 -458
  219. package/src/sankey/__tests__/layout.test.ts +0 -165
  220. package/src/sankey/__tests__/node-label-wrap.test.ts +0 -114
  221. package/src/sankey/__tests__/node-sort.test.ts +0 -45
  222. package/src/sankey/compile-sankey.ts +0 -706
  223. package/src/sankey/layout.ts +0 -184
  224. package/src/sankey/types.ts +0 -41
  225. package/src/tables/__tests__/bar-column.test.ts +0 -147
  226. package/src/tables/__tests__/category-colors.test.ts +0 -230
  227. package/src/tables/__tests__/compile-table.test.ts +0 -236
  228. package/src/tables/__tests__/format-cells.test.ts +0 -143
  229. package/src/tables/__tests__/heatmap.test.ts +0 -148
  230. package/src/tables/__tests__/pagination.test.ts +0 -78
  231. package/src/tables/__tests__/search.test.ts +0 -94
  232. package/src/tables/__tests__/sort.test.ts +0 -107
  233. package/src/tables/__tests__/sparkline.test.ts +0 -122
  234. package/src/tables/bar-column.ts +0 -94
  235. package/src/tables/category-colors.ts +0 -78
  236. package/src/tables/compile-table.ts +0 -427
  237. package/src/tables/format-cells.ts +0 -115
  238. package/src/tables/heatmap.ts +0 -141
  239. package/src/tables/pagination.ts +0 -46
  240. package/src/tables/search.ts +0 -66
  241. package/src/tables/sort.ts +0 -69
  242. package/src/tables/sparkline.ts +0 -113
  243. package/src/tables/utils.ts +0 -16
  244. package/src/tilemap/__tests__/compile-tilemap.test.ts +0 -576
  245. package/src/tilemap/compile-tilemap.ts +0 -755
  246. package/src/tilemap/layout.ts +0 -172
  247. package/src/tilemap/types.ts +0 -33
  248. package/src/tooltips/__tests__/compute.test.ts +0 -582
  249. package/src/tooltips/compute.ts +0 -700
  250. package/src/transforms/__tests__/aggregate.test.ts +0 -159
  251. package/src/transforms/__tests__/bin.test.ts +0 -88
  252. package/src/transforms/__tests__/calculate.test.ts +0 -146
  253. package/src/transforms/__tests__/conditional.test.ts +0 -127
  254. package/src/transforms/__tests__/filter-relative.test.ts +0 -202
  255. package/src/transforms/__tests__/filter.test.ts +0 -59
  256. package/src/transforms/__tests__/fold.test.ts +0 -79
  257. package/src/transforms/__tests__/index.test.ts +0 -93
  258. package/src/transforms/__tests__/predicates.test.ts +0 -193
  259. package/src/transforms/__tests__/timeunit.test.ts +0 -129
  260. package/src/transforms/__tests__/window.test.ts +0 -286
  261. package/src/transforms/aggregate.ts +0 -131
  262. package/src/transforms/bin.ts +0 -87
  263. package/src/transforms/calculate.ts +0 -60
  264. package/src/transforms/conditional.ts +0 -46
  265. package/src/transforms/filter.ts +0 -122
  266. package/src/transforms/fold.ts +0 -49
  267. package/src/transforms/index.ts +0 -60
  268. package/src/transforms/predicates.ts +0 -123
  269. package/src/transforms/timeunit.ts +0 -88
  270. package/src/transforms/window.ts +0 -185
@@ -1,731 +0,0 @@
1
- import { describe, expect, it } from 'vitest';
2
- import { validateSpec } from '../validate';
3
-
4
- // ---------------------------------------------------------------------------
5
- // Test data
6
- // ---------------------------------------------------------------------------
7
-
8
- const validLineData = [
9
- { date: '2020-01-01', value: 10, country: 'US' },
10
- { date: '2021-01-01', value: 20, country: 'US' },
11
- { date: '2022-01-01', value: 30, country: 'UK' },
12
- ];
13
-
14
- const validLineSpec = {
15
- mark: 'line',
16
- data: validLineData,
17
- encoding: {
18
- x: { field: 'date', type: 'temporal' },
19
- y: { field: 'value', type: 'quantitative' },
20
- color: { field: 'country', type: 'nominal' },
21
- },
22
- chrome: { title: 'GDP Growth' },
23
- };
24
-
25
- const validBarSpec = {
26
- mark: 'bar',
27
- data: [
28
- { category: 'A', count: 10 },
29
- { category: 'B', count: 20 },
30
- ],
31
- encoding: {
32
- x: { field: 'count', type: 'quantitative' },
33
- y: { field: 'category', type: 'nominal' },
34
- },
35
- };
36
-
37
- const validArcSpec = {
38
- mark: 'arc',
39
- data: [
40
- { label: 'Apples', amount: 30 },
41
- { label: 'Oranges', amount: 50 },
42
- { label: 'Bananas', amount: 20 },
43
- ],
44
- encoding: {
45
- y: { field: 'amount', type: 'quantitative' },
46
- color: { field: 'label', type: 'nominal' },
47
- },
48
- };
49
-
50
- // ---------------------------------------------------------------------------
51
- // Tests
52
- // ---------------------------------------------------------------------------
53
-
54
- describe('validateSpec', () => {
55
- describe('basic shape checks', () => {
56
- it('rejects null with INVALID_TYPE code', () => {
57
- const result = validateSpec(null);
58
- expect(result.valid).toBe(false);
59
- expect(result.errors[0].message).toContain('non-null object');
60
- expect(result.errors[0].code).toBe('INVALID_TYPE');
61
- expect(result.errors[0].suggestion).toBeDefined();
62
- });
63
-
64
- it('rejects arrays', () => {
65
- const result = validateSpec([1, 2, 3]);
66
- expect(result.valid).toBe(false);
67
- expect(result.errors[0].code).toBe('INVALID_TYPE');
68
- });
69
-
70
- it('rejects strings', () => {
71
- const result = validateSpec('hello');
72
- expect(result.valid).toBe(false);
73
- expect(result.errors[0].code).toBe('INVALID_TYPE');
74
- });
75
-
76
- it('rejects objects without mark or type with MISSING_FIELD code', () => {
77
- const result = validateSpec({ data: [] });
78
- expect(result.valid).toBe(false);
79
- expect(result.errors[0].code).toBe('MISSING_FIELD');
80
- expect(result.errors[0].suggestion).toContain('bar');
81
- });
82
-
83
- it('rejects invalid mark values with INVALID_VALUE code', () => {
84
- const result = validateSpec({ mark: 'waterfall' });
85
- expect(result.valid).toBe(false);
86
- expect(result.errors[0].message).toContain('"waterfall" is not a valid mark type');
87
- expect(result.errors[0].code).toBe('INVALID_VALUE');
88
- expect(result.errors[0].suggestion).toContain('line');
89
- });
90
- });
91
-
92
- describe('chart specs', () => {
93
- it('accepts a valid line spec', () => {
94
- const result = validateSpec(validLineSpec);
95
- expect(result.valid).toBe(true);
96
- expect(result.errors).toHaveLength(0);
97
- expect(result.normalized).not.toBeNull();
98
- });
99
-
100
- it('accepts a valid bar spec', () => {
101
- const result = validateSpec(validBarSpec);
102
- expect(result.valid).toBe(true);
103
- });
104
-
105
- it('accepts a valid arc spec', () => {
106
- const result = validateSpec(validArcSpec);
107
- expect(result.valid).toBe(true);
108
- });
109
-
110
- it('rejects empty data with EMPTY_DATA code and suggestion', () => {
111
- const result = validateSpec({ ...validLineSpec, data: [] });
112
- expect(result.valid).toBe(false);
113
- expect(result.errors[0].message).toContain('non-empty array');
114
- expect(result.errors[0].code).toBe('EMPTY_DATA');
115
- expect(result.errors[0].suggestion).toContain('Add at least one data row');
116
- });
117
-
118
- it('rejects non-array data with INVALID_TYPE code', () => {
119
- const result = validateSpec({ ...validLineSpec, data: 'not an array' });
120
- expect(result.valid).toBe(false);
121
- expect(result.errors[0].message).toContain('must be an array');
122
- expect(result.errors[0].code).toBe('INVALID_TYPE');
123
- });
124
-
125
- it('rejects missing encoding with MISSING_FIELD code and channel suggestion', () => {
126
- const result = validateSpec({
127
- mark: 'line',
128
- data: validLineData,
129
- });
130
- expect(result.valid).toBe(false);
131
- expect(result.errors[0].message).toContain('requires an "encoding" object');
132
- expect(result.errors[0].code).toBe('MISSING_FIELD');
133
- // Should suggest the required channels for this chart type
134
- expect(result.errors[0].suggestion).toContain('encoding');
135
- });
136
-
137
- it('rejects missing required channel with MISSING_FIELD code', () => {
138
- const result = validateSpec({
139
- mark: 'line',
140
- data: validLineData,
141
- encoding: {
142
- x: { field: 'date', type: 'temporal' },
143
- // Missing y, which is required for line charts
144
- },
145
- });
146
- expect(result.valid).toBe(false);
147
- const yError = result.errors.find((e) => e.message.includes('encoding.y'));
148
- expect(yError).toBeDefined();
149
- expect(yError!.code).toBe('MISSING_FIELD');
150
- expect(yError!.suggestion).toBeDefined();
151
- // Suggestion should mention available data columns
152
- expect(yError!.suggestion).toContain('date');
153
- });
154
-
155
- it('rejects field referencing non-existent column with DATA_FIELD_MISSING code', () => {
156
- const result = validateSpec({
157
- mark: 'line',
158
- data: validLineData,
159
- encoding: {
160
- x: { field: 'nonexistent', type: 'temporal' },
161
- y: { field: 'value', type: 'quantitative' },
162
- },
163
- });
164
- expect(result.valid).toBe(false);
165
- const fieldError = result.errors.find((e) =>
166
- e.message.includes('"nonexistent" does not exist'),
167
- );
168
- expect(fieldError).toBeDefined();
169
- expect(fieldError!.code).toBe('DATA_FIELD_MISSING');
170
- expect(fieldError!.suggestion).toContain('date');
171
- expect(fieldError!.suggestion).toContain('value');
172
- expect(fieldError!.suggestion).toContain('country');
173
- });
174
-
175
- it('rejects invalid field type with INVALID_VALUE code', () => {
176
- const result = validateSpec({
177
- mark: 'line',
178
- data: validLineData,
179
- encoding: {
180
- x: { field: 'date', type: 'bogus' },
181
- y: { field: 'value', type: 'quantitative' },
182
- },
183
- });
184
- expect(result.valid).toBe(false);
185
- const typeError = result.errors.find((e) => e.message.includes('"bogus" is not valid'));
186
- expect(typeError).toBeDefined();
187
- expect(typeError!.code).toBe('INVALID_VALUE');
188
- expect(typeError!.suggestion).toContain('quantitative');
189
- expect(typeError!.suggestion).toContain('temporal');
190
- });
191
-
192
- it('rejects disallowed type for channel with ENCODING_MISMATCH code', () => {
193
- const result = validateSpec({
194
- mark: 'line',
195
- data: validLineData,
196
- encoding: {
197
- x: { field: 'date', type: 'quantitative' },
198
- y: { field: 'value', type: 'quantitative' },
199
- },
200
- });
201
- expect(result.valid).toBe(false);
202
- const mismatchError = result.errors.find((e) => e.message.includes('does not accept type'));
203
- expect(mismatchError).toBeDefined();
204
- expect(mismatchError!.code).toBe('ENCODING_MISMATCH');
205
- expect(mismatchError!.suggestion).toContain('Change');
206
- });
207
-
208
- it('catches temporal field with non-date values with ENCODING_MISMATCH', () => {
209
- const result = validateSpec({
210
- mark: 'line',
211
- data: [
212
- { x: 'not-a-date', y: 10 },
213
- { x: 'also-not-a-date', y: 20 },
214
- ],
215
- encoding: {
216
- x: { field: 'x', type: 'temporal' },
217
- y: { field: 'y', type: 'quantitative' },
218
- },
219
- });
220
- expect(result.valid).toBe(false);
221
- const dateError = result.errors.find((e) => e.message.includes('non-date values'));
222
- expect(dateError).toBeDefined();
223
- expect(dateError!.code).toBe('ENCODING_MISMATCH');
224
- expect(dateError!.suggestion).toContain('nominal');
225
- });
226
-
227
- it('catches quantitative field with non-numeric values with ENCODING_MISMATCH', () => {
228
- const result = validateSpec({
229
- mark: 'point',
230
- data: [
231
- { x: 'hello', y: 10 },
232
- { x: 'world', y: 20 },
233
- ],
234
- encoding: {
235
- x: { field: 'x', type: 'quantitative' },
236
- y: { field: 'y', type: 'quantitative' },
237
- },
238
- });
239
- expect(result.valid).toBe(false);
240
- const numError = result.errors.find((e) => e.message.includes('non-numeric values'));
241
- expect(numError).toBeDefined();
242
- expect(numError!.code).toBe('ENCODING_MISMATCH');
243
- expect(numError!.suggestion).toContain('nominal');
244
- });
245
-
246
- it('rejects invalid darkMode with INVALID_VALUE code', () => {
247
- const result = validateSpec({
248
- ...validLineSpec,
249
- darkMode: 'maybe',
250
- });
251
- expect(result.valid).toBe(false);
252
- const dmError = result.errors.find((e) => e.message.includes('darkMode'));
253
- expect(dmError).toBeDefined();
254
- expect(dmError!.code).toBe('INVALID_VALUE');
255
- expect(dmError!.suggestion).toContain('auto');
256
- });
257
-
258
- it('rejects missing encoding channel field with MISSING_FIELD code', () => {
259
- const result = validateSpec({
260
- mark: 'bar',
261
- data: [{ a: 1, b: 2 }],
262
- encoding: {
263
- x: { type: 'quantitative' },
264
- y: { field: 'a', type: 'nominal' },
265
- },
266
- });
267
- expect(result.valid).toBe(false);
268
- const fieldError = result.errors.find((e) =>
269
- e.message.includes('must have a "field" string'),
270
- );
271
- expect(fieldError).toBeDefined();
272
- expect(fieldError!.code).toBe('MISSING_FIELD');
273
- expect(fieldError!.suggestion).toContain('a');
274
- });
275
-
276
- it('accepts tooltip as an array of valid encoding channels', () => {
277
- const result = validateSpec({
278
- mark: 'bar',
279
- data: [{ a: 1, b: 2, c: 3 }],
280
- encoding: {
281
- x: { field: 'a', type: 'quantitative' },
282
- y: { field: 'b', type: 'nominal' },
283
- tooltip: [
284
- { field: 'a', type: 'quantitative' },
285
- { field: 'c', type: 'quantitative' },
286
- ],
287
- },
288
- });
289
- expect(result.valid).toBe(true);
290
- expect(result.errors).toHaveLength(0);
291
- });
292
-
293
- it('rejects tooltip array element with missing field', () => {
294
- const result = validateSpec({
295
- mark: 'bar',
296
- data: [{ a: 1, b: 2 }],
297
- encoding: {
298
- x: { field: 'a', type: 'quantitative' },
299
- y: { field: 'b', type: 'nominal' },
300
- tooltip: [{ field: 'a', type: 'quantitative' }, { type: 'quantitative' }],
301
- },
302
- });
303
- expect(result.valid).toBe(false);
304
- const err = result.errors.find((e) => e.message.includes('tooltip[1]'));
305
- expect(err).toBeDefined();
306
- expect(err!.code).toBe('MISSING_FIELD');
307
- expect(err!.path).toBe('encoding.tooltip[1].field');
308
- });
309
- });
310
-
311
- describe('range marks', () => {
312
- const rangeData = [
313
- { country: 'Japan', y2000: 81.1, y2024: 87.9 },
314
- { country: 'USA', y2000: 79.5, y2024: 81.3 },
315
- ];
316
-
317
- it('accepts a valid horizontal range spec (x + x2, nominal y)', () => {
318
- const result = validateSpec({
319
- mark: 'range',
320
- data: rangeData,
321
- encoding: {
322
- y: { field: 'country', type: 'nominal' },
323
- x: { field: 'y2000', type: 'quantitative' },
324
- x2: { field: 'y2024' },
325
- },
326
- });
327
- expect(result.valid).toBe(true);
328
- expect(result.errors).toHaveLength(0);
329
- });
330
-
331
- it('accepts a valid vertical range spec (y + y2, nominal x)', () => {
332
- const result = validateSpec({
333
- mark: 'range',
334
- data: [{ month: 'Jan', lo: 27, hi: 39 }],
335
- encoding: {
336
- x: { field: 'month', type: 'nominal' },
337
- y: { field: 'lo', type: 'quantitative' },
338
- y2: { field: 'hi' },
339
- },
340
- });
341
- expect(result.valid).toBe(true);
342
- });
343
-
344
- it('rejects a horizontal range spec without x2, naming encoding.x2', () => {
345
- const result = validateSpec({
346
- mark: 'range',
347
- data: rangeData,
348
- encoding: {
349
- y: { field: 'country', type: 'nominal' },
350
- x: { field: 'y2000', type: 'quantitative' },
351
- },
352
- });
353
- expect(result.valid).toBe(false);
354
- const err = result.errors.find((e) => e.path === 'encoding.x2');
355
- expect(err).toBeDefined();
356
- expect(err!.code).toBe('MISSING_FIELD');
357
- expect(err!.message).toContain('encoding.x2');
358
- expect(err!.suggestion).toContain('x2: { field:');
359
- });
360
-
361
- it('rejects a vertical range spec without y2, naming encoding.y2', () => {
362
- const result = validateSpec({
363
- mark: 'range',
364
- data: [{ month: 'Jan', lo: 27, hi: 39 }],
365
- encoding: {
366
- x: { field: 'month', type: 'nominal' },
367
- y: { field: 'lo', type: 'quantitative' },
368
- },
369
- });
370
- expect(result.valid).toBe(false);
371
- const err = result.errors.find((e) => e.path === 'encoding.y2');
372
- expect(err).toBeDefined();
373
- expect(err!.code).toBe('MISSING_FIELD');
374
- expect(err!.message).toContain('encoding.y2');
375
- });
376
-
377
- it('rejects y2 on a horizontal range spec', () => {
378
- const result = validateSpec({
379
- mark: 'range',
380
- data: rangeData,
381
- encoding: {
382
- y: { field: 'country', type: 'nominal' },
383
- x: { field: 'y2000', type: 'quantitative' },
384
- x2: { field: 'y2024' },
385
- y2: { field: 'y2024' },
386
- },
387
- });
388
- expect(result.valid).toBe(false);
389
- const err = result.errors.find((e) => e.path === 'encoding.y2');
390
- expect(err).toBeDefined();
391
- expect(err!.code).toBe('INVALID_VALUE');
392
- });
393
-
394
- it('rejects a range spec without any categorical axis', () => {
395
- const result = validateSpec({
396
- mark: 'range',
397
- data: rangeData,
398
- encoding: {
399
- y: { field: 'y2000', type: 'quantitative' },
400
- x: { field: 'y2024', type: 'quantitative' },
401
- },
402
- });
403
- expect(result.valid).toBe(false);
404
- const err = result.errors.find((e) => e.code === 'ENCODING_MISMATCH');
405
- expect(err).toBeDefined();
406
- expect(err!.message).toContain('category axis');
407
- });
408
-
409
- it('rejects an unknown mark.style value', () => {
410
- const result = validateSpec({
411
- mark: { type: 'range', style: 'ribbon' },
412
- data: rangeData,
413
- encoding: {
414
- y: { field: 'country', type: 'nominal' },
415
- x: { field: 'y2000', type: 'quantitative' },
416
- x2: { field: 'y2024' },
417
- },
418
- });
419
- expect(result.valid).toBe(false);
420
- const err = result.errors.find((e) => e.path === 'mark.style');
421
- expect(err).toBeDefined();
422
- expect(err!.code).toBe('INVALID_VALUE');
423
- expect(err!.message).toContain('dumbbell, arrow, bar');
424
- });
425
- });
426
-
427
- describe('table specs', () => {
428
- it('accepts a valid table spec', () => {
429
- const result = validateSpec({
430
- type: 'table',
431
- data: [{ name: 'Alice', age: 30 }],
432
- columns: [{ key: 'name' }, { key: 'age' }],
433
- });
434
- expect(result.valid).toBe(true);
435
- });
436
-
437
- it('rejects table without data', () => {
438
- const result = validateSpec({
439
- type: 'table',
440
- columns: [{ key: 'name' }],
441
- });
442
- expect(result.valid).toBe(false);
443
- expect(result.errors[0].code).toBe('INVALID_TYPE');
444
- });
445
-
446
- it('rejects table with empty data with EMPTY_DATA code', () => {
447
- const result = validateSpec({
448
- type: 'table',
449
- data: [],
450
- columns: [{ key: 'name' }],
451
- });
452
- expect(result.valid).toBe(false);
453
- expect(result.errors[0].code).toBe('EMPTY_DATA');
454
- expect(result.errors[0].suggestion).toBeDefined();
455
- });
456
-
457
- it('rejects table without columns with MISSING_FIELD code', () => {
458
- const result = validateSpec({
459
- type: 'table',
460
- data: [{ name: 'Alice' }],
461
- });
462
- expect(result.valid).toBe(false);
463
- expect(result.errors.some((e) => e.message.includes('"columns" array'))).toBe(true);
464
- expect(result.errors[0].code).toBe('MISSING_FIELD');
465
- expect(result.errors[0].suggestion).toContain('columns');
466
- });
467
-
468
- it('rejects table column referencing non-existent field with DATA_FIELD_MISSING', () => {
469
- const result = validateSpec({
470
- type: 'table',
471
- data: [{ name: 'Alice', age: 30 }],
472
- columns: [{ key: 'nonexistent' }],
473
- });
474
- expect(result.valid).toBe(false);
475
- const colError = result.errors.find((e) =>
476
- e.message.includes('"nonexistent" does not exist'),
477
- );
478
- expect(colError).toBeDefined();
479
- expect(colError!.code).toBe('DATA_FIELD_MISSING');
480
- expect(colError!.suggestion).toContain('name');
481
- expect(colError!.suggestion).toContain('age');
482
- });
483
- });
484
-
485
- describe('graph specs', () => {
486
- it('accepts a valid graph spec', () => {
487
- const result = validateSpec({
488
- type: 'graph',
489
- nodes: [{ id: 'a' }, { id: 'b' }],
490
- edges: [{ source: 'a', target: 'b' }],
491
- });
492
- expect(result.valid).toBe(true);
493
- });
494
-
495
- it('rejects graph without nodes with MISSING_FIELD code', () => {
496
- const result = validateSpec({
497
- type: 'graph',
498
- edges: [],
499
- });
500
- expect(result.valid).toBe(false);
501
- const nodeError = result.errors.find((e) => e.message.includes('"nodes"'));
502
- expect(nodeError).toBeDefined();
503
- expect(nodeError!.code).toBe('MISSING_FIELD');
504
- expect(nodeError!.suggestion).toContain('id');
505
- });
506
-
507
- it('rejects graph with empty nodes with EMPTY_DATA code', () => {
508
- const result = validateSpec({
509
- type: 'graph',
510
- nodes: [],
511
- edges: [],
512
- });
513
- expect(result.valid).toBe(false);
514
- const emptyError = result.errors.find((e) => e.message.includes('non-empty'));
515
- expect(emptyError).toBeDefined();
516
- expect(emptyError!.code).toBe('EMPTY_DATA');
517
- });
518
-
519
- it('rejects graph without edges with MISSING_FIELD code', () => {
520
- const result = validateSpec({
521
- type: 'graph',
522
- nodes: [{ id: 'a' }],
523
- });
524
- expect(result.valid).toBe(false);
525
- const edgeError = result.errors.find((e) => e.message.includes('"edges"'));
526
- expect(edgeError).toBeDefined();
527
- expect(edgeError!.code).toBe('MISSING_FIELD');
528
- expect(edgeError!.suggestion).toContain('edges');
529
- });
530
- });
531
-
532
- describe('error codes and suggestions', () => {
533
- it('every error has a code', () => {
534
- // Test several invalid specs and verify all errors have codes
535
- const results = [
536
- validateSpec(null),
537
- validateSpec({ data: [] }),
538
- validateSpec({ mark: 'waterfall' }),
539
- validateSpec({ mark: 'line', data: [] }),
540
- validateSpec({
541
- mark: 'line',
542
- data: [{ x: 1 }],
543
- encoding: { x: { field: 'missing', type: 'quantitative' } },
544
- }),
545
- ];
546
-
547
- for (const result of results) {
548
- for (const error of result.errors) {
549
- expect(error.code).toBeDefined();
550
- expect(typeof error.code).toBe('string');
551
- }
552
- }
553
- });
554
-
555
- it('every error has a suggestion', () => {
556
- const results = [
557
- validateSpec(null),
558
- validateSpec({ data: [] }),
559
- validateSpec({ mark: 'waterfall' }),
560
- validateSpec({ mark: 'line', data: [] }),
561
- ];
562
-
563
- for (const result of results) {
564
- for (const error of result.errors) {
565
- expect(error.suggestion).toBeDefined();
566
- expect(typeof error.suggestion).toBe('string');
567
- expect(error.suggestion!.length).toBeGreaterThan(0);
568
- }
569
- }
570
- });
571
-
572
- it('DATA_FIELD_MISSING suggestion lists available fields', () => {
573
- const result = validateSpec({
574
- mark: 'bar',
575
- data: [{ alpha: 1, beta: 2, gamma: 3 }],
576
- encoding: {
577
- x: { field: 'nonexistent', type: 'quantitative' },
578
- y: { field: 'alpha', type: 'nominal' },
579
- },
580
- });
581
-
582
- const fieldError = result.errors.find((e) => e.code === 'DATA_FIELD_MISSING');
583
- expect(fieldError).toBeDefined();
584
- expect(fieldError!.suggestion).toContain('alpha');
585
- expect(fieldError!.suggestion).toContain('beta');
586
- expect(fieldError!.suggestion).toContain('gamma');
587
- });
588
- });
589
-
590
- describe('transform-created fields', () => {
591
- it('accepts encoding fields produced by a chained bin + aggregate (histogram)', () => {
592
- const result = validateSpec({
593
- mark: 'bar',
594
- data: [{ hours: 3.1 }, { hours: 3.4 }, { hours: 4.0 }],
595
- transform: [
596
- { bin: { step: 0.5 }, field: 'hours', as: 'binStart' },
597
- { aggregate: [{ op: 'count', field: 'hours', as: 'finishers' }], groupby: ['binStart'] },
598
- ],
599
- encoding: {
600
- x: { field: 'binStart', type: 'ordinal' },
601
- y: { field: 'finishers', type: 'quantitative' },
602
- },
603
- });
604
-
605
- expect(result.valid).toBe(true);
606
- expect(result.errors.find((e) => e.code === 'DATA_FIELD_MISSING')).toBeUndefined();
607
- });
608
-
609
- it('accepts an encoding field produced by a window transform', () => {
610
- const result = validateSpec({
611
- mark: 'bar',
612
- data: [
613
- { day: '1', value: 10 },
614
- { day: '2', value: 20 },
615
- ],
616
- transform: [
617
- { window: [{ op: 'cumsum', field: 'value', as: 'running' }], sort: [{ field: 'day' }] },
618
- ],
619
- encoding: {
620
- x: { field: 'day', type: 'ordinal' },
621
- y: { field: 'running', type: 'quantitative' },
622
- },
623
- });
624
-
625
- expect(result.valid).toBe(true);
626
- expect(result.errors.find((e) => e.code === 'DATA_FIELD_MISSING')).toBeUndefined();
627
- });
628
- });
629
-
630
- describe('row/column facet validation', () => {
631
- it('validates row channel field and type', () => {
632
- const result = validateSpec({
633
- mark: 'bar',
634
- data: validLineData,
635
- encoding: {
636
- x: { field: 'value', type: 'quantitative' },
637
- y: { field: 'country', type: 'nominal' },
638
- row: { field: 'nonexistent', type: 'nominal' },
639
- },
640
- });
641
- expect(result.errors.some((e) => e.path === 'encoding.row.field')).toBe(true);
642
- });
643
-
644
- it('rejects row with invalid type', () => {
645
- const result = validateSpec({
646
- mark: 'bar',
647
- data: validLineData,
648
- encoding: {
649
- x: { field: 'value', type: 'quantitative' },
650
- y: { field: 'country', type: 'nominal' },
651
- row: { field: 'country', type: 'quantitative' as 'nominal' },
652
- },
653
- });
654
- expect(result.errors.some((e) => e.path === 'encoding.row.type')).toBe(true);
655
- });
656
-
657
- it('rejects row + facet together', () => {
658
- const result = validateSpec({
659
- mark: 'bar',
660
- data: validLineData,
661
- encoding: {
662
- x: { field: 'value', type: 'quantitative' },
663
- y: { field: 'country', type: 'nominal' },
664
- row: { field: 'country', type: 'nominal' },
665
- facet: { field: 'country', type: 'nominal' },
666
- },
667
- });
668
- expect(result.errors.some((e) => e.message.includes('encoding.row and encoding.facet'))).toBe(
669
- true,
670
- );
671
- });
672
-
673
- it('rejects row + column together', () => {
674
- const result = validateSpec({
675
- mark: 'bar',
676
- data: validLineData,
677
- encoding: {
678
- x: { field: 'value', type: 'quantitative' },
679
- y: { field: 'country', type: 'nominal' },
680
- row: { field: 'country', type: 'nominal' },
681
- column: { field: 'date', type: 'ordinal' },
682
- },
683
- });
684
- expect(
685
- result.errors.some((e) => e.message.includes('encoding.row and encoding.column')),
686
- ).toBe(true);
687
- });
688
-
689
- it('accepts valid row channel', () => {
690
- const result = validateSpec({
691
- mark: 'bar',
692
- data: validLineData,
693
- encoding: {
694
- x: { field: 'value', type: 'quantitative' },
695
- y: { field: 'country', type: 'nominal' },
696
- row: { field: 'country', type: 'nominal' },
697
- },
698
- });
699
- expect(result.errors.filter((e) => e.path?.startsWith('encoding.row'))).toHaveLength(0);
700
- });
701
-
702
- it('rejects column + facet together', () => {
703
- const result = validateSpec({
704
- mark: 'bar',
705
- data: validLineData,
706
- encoding: {
707
- x: { field: 'value', type: 'quantitative' },
708
- y: { field: 'country', type: 'nominal' },
709
- column: { field: 'country', type: 'nominal' },
710
- facet: { field: 'country', type: 'nominal' },
711
- },
712
- });
713
- expect(
714
- result.errors.some((e) => e.message.includes('encoding.column and encoding.facet')),
715
- ).toBe(true);
716
- });
717
-
718
- it('accepts valid column channel', () => {
719
- const result = validateSpec({
720
- mark: 'bar',
721
- data: validLineData,
722
- encoding: {
723
- x: { field: 'country', type: 'nominal' },
724
- y: { field: 'value', type: 'quantitative' },
725
- column: { field: 'country', type: 'nominal' },
726
- },
727
- });
728
- expect(result.errors.filter((e) => e.path?.startsWith('encoding.column'))).toHaveLength(0);
729
- });
730
- });
731
- });