@svgrid/grid 2.2.27 → 2.2.28

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 (212) hide show
  1. package/README.md +199 -199
  2. package/dist/FlexRender.svelte +96 -96
  3. package/dist/GridFooter.svelte +179 -179
  4. package/dist/GridMenus.svelte +734 -734
  5. package/dist/SvAutoComplete.svelte +165 -165
  6. package/dist/SvCalendar.svelte +503 -503
  7. package/dist/SvCarousel.svelte +141 -141
  8. package/dist/SvCheckBox.svelte +101 -101
  9. package/dist/SvColorInput.svelte +181 -181
  10. package/dist/SvComboBox.svelte +275 -275
  11. package/dist/SvContextMenu.svelte +116 -116
  12. package/dist/SvCountryInput.svelte +160 -160
  13. package/dist/SvDrawer.svelte +254 -250
  14. package/dist/SvDropDownList.svelte +374 -374
  15. package/dist/SvDurationInput.svelte +126 -126
  16. package/dist/SvField.svelte +293 -293
  17. package/dist/SvForm.svelte +437 -437
  18. package/dist/SvGrid.css +2723 -2723
  19. package/dist/SvGrid.svelte +3333 -3333
  20. package/dist/SvGridChart.svelte +1724 -1724
  21. package/dist/SvGridChartPanel.svelte +485 -485
  22. package/dist/SvGridChartView.svelte +70 -70
  23. package/dist/SvGridDropdown.svelte +696 -696
  24. package/dist/SvGridSelect.svelte +259 -259
  25. package/dist/SvGroupCell.svelte +109 -109
  26. package/dist/SvListBox.svelte +287 -287
  27. package/dist/SvMaskedInput.svelte +122 -122
  28. package/dist/SvMenu.svelte +124 -124
  29. package/dist/SvMenuList.svelte +146 -146
  30. package/dist/SvMultiSelect.svelte +281 -281
  31. package/dist/SvNumberInput.svelte +168 -168
  32. package/dist/SvOtpInput.svelte +158 -158
  33. package/dist/SvPasswordInput.svelte +151 -151
  34. package/dist/SvPhoneInput.svelte +133 -131
  35. package/dist/SvPopover.svelte +197 -197
  36. package/dist/SvRadioGroup.svelte +107 -107
  37. package/dist/SvRowGroupPanel.svelte +170 -170
  38. package/dist/SvScrollArea.svelte +61 -61
  39. package/dist/SvSlider.svelte +200 -200
  40. package/dist/SvSwitchButton.svelte +107 -107
  41. package/dist/SvTagsInput.svelte +112 -112
  42. package/dist/SvTextInput.svelte +147 -147
  43. package/dist/SvTimePicker.svelte +245 -245
  44. package/dist/SvToaster.svelte +159 -159
  45. package/dist/SvToggleButton.svelte +85 -85
  46. package/dist/SvTooltip.svelte +161 -161
  47. package/dist/SvTour.svelte +204 -204
  48. package/dist/SvTree.svelte +437 -437
  49. package/dist/SvTreeSelect.svelte +233 -233
  50. package/dist/cdn/{GridMenus-BzxEYNtW.js → GridMenus-BbzEvTYO.js} +2 -2
  51. package/dist/cdn/{GridMenus-Dr-nGEXn.js → GridMenus-E220X2kM.js} +2 -2
  52. package/dist/cdn/{SvDateTimePicker-B1sDc9Pz.js → SvDateTimePicker-B8GopjhC.js} +2 -2
  53. package/dist/cdn/{SvDateTimePicker-Bh0FTs1E.js → SvDateTimePicker-DB0aIEk8.js} +2 -2
  54. package/dist/cdn/{SvGridChart-Bgk4hDs8.js → SvGridChart-BcLCYvw9.js} +1 -1
  55. package/dist/cdn/{SvGridChart-BKQsO5fZ.js → SvGridChart-BhnFdLd0.js} +1 -1
  56. package/dist/cdn/{SvGridChartPanel-DkCc2Z7b.js → SvGridChartPanel-Cmx9DHAS.js} +1 -1
  57. package/dist/cdn/{SvGridChartPanel-DSkHIQDd.js → SvGridChartPanel-DvjwxLvK.js} +1 -1
  58. package/dist/cdn/{SvGridChartView-BrbVaELm.js → SvGridChartView-B40DTJSX.js} +1 -1
  59. package/dist/cdn/{SvGridChartView-i9rWvSKg.js → SvGridChartView-PwqI4s02.js} +1 -1
  60. package/dist/cdn/{SvGridDropdown-D08sVmAy.js → SvGridDropdown-DjALc_4f.js} +1 -1
  61. package/dist/cdn/{SvGridDropdown-CGxxopQ4.js → SvGridDropdown-hpnHvOGt.js} +1 -1
  62. package/dist/cdn/{src-cgs1wcUS.js → src-BxNEslEo.js} +25 -25
  63. package/dist/cdn/{src-Cw8d9U8j.js → src-C4yKQZ5t.js} +26 -26
  64. package/dist/cdn/svgrid.js +5 -5
  65. package/dist/cdn/svgrid.svelte-external.js +5 -5
  66. package/dist/chart-export.js +8 -8
  67. package/package.json +10 -10
  68. package/src/FlexRender.svelte +96 -96
  69. package/src/GridFooter.svelte +179 -179
  70. package/src/GridMenus.svelte +734 -734
  71. package/src/SvAutoComplete.svelte +165 -165
  72. package/src/SvCalendar.svelte +503 -503
  73. package/src/SvCalendar.test.ts +226 -226
  74. package/src/SvCarousel.svelte +141 -141
  75. package/src/SvCheckBox.svelte +101 -101
  76. package/src/SvColorInput.svelte +181 -181
  77. package/src/SvComboBox.svelte +275 -275
  78. package/src/SvContextMenu.svelte +116 -116
  79. package/src/SvCountryInput.svelte +160 -160
  80. package/src/SvDrawer.svelte +254 -250
  81. package/src/SvDrawer.test.ts +18 -1
  82. package/src/SvDropDownList.svelte +374 -374
  83. package/src/SvDurationInput.svelte +126 -126
  84. package/src/SvField.svelte +293 -293
  85. package/src/SvForm.svelte +437 -437
  86. package/src/SvForm.test.ts +411 -411
  87. package/src/SvGrid.controller.svelte.ts +3239 -3239
  88. package/src/SvGrid.css +2723 -2723
  89. package/src/SvGrid.svelte +3333 -3333
  90. package/src/SvGrid.types.ts +1613 -1613
  91. package/src/SvGridChart.svelte +1724 -1724
  92. package/src/SvGridChartPanel.svelte +485 -485
  93. package/src/SvGridChartView.svelte +70 -70
  94. package/src/SvGridDropdown.svelte +696 -696
  95. package/src/SvGridSelect.svelte +259 -259
  96. package/src/SvGroupCell.svelte +109 -109
  97. package/src/SvListBox.svelte +287 -287
  98. package/src/SvMaskedInput.svelte +122 -122
  99. package/src/SvMenu.svelte +124 -124
  100. package/src/SvMenu.test.ts +97 -97
  101. package/src/SvMenuList.svelte +146 -146
  102. package/src/SvMultiSelect.svelte +281 -281
  103. package/src/SvNavPane.test.ts +15 -4
  104. package/src/SvNumberInput.svelte +168 -168
  105. package/src/SvOtpInput.svelte +158 -158
  106. package/src/SvPasswordInput.svelte +151 -151
  107. package/src/SvPhoneInput.svelte +133 -131
  108. package/src/SvPopover.svelte +197 -197
  109. package/src/SvRadioGroup.svelte +107 -107
  110. package/src/SvRowGroupPanel.svelte +170 -170
  111. package/src/SvScrollArea.svelte +61 -61
  112. package/src/SvSlider.svelte +200 -200
  113. package/src/SvSwitchButton.svelte +107 -107
  114. package/src/SvTagsInput.svelte +112 -112
  115. package/src/SvTextInput.svelte +147 -147
  116. package/src/SvTimePicker.svelte +245 -245
  117. package/src/SvToaster.svelte +159 -159
  118. package/src/SvToaster.test.ts +95 -95
  119. package/src/SvToggleButton.svelte +85 -85
  120. package/src/SvTooltip.svelte +161 -161
  121. package/src/SvTour.svelte +204 -204
  122. package/src/SvTree.svelte +437 -437
  123. package/src/SvTreeSelect.svelte +233 -233
  124. package/src/a11y/dismissable.test.ts +119 -119
  125. package/src/a11y/dismissable.ts +114 -114
  126. package/src/a11y.contract.test.ts +49 -49
  127. package/src/a11y.test.ts +59 -59
  128. package/src/a11y.ts +61 -61
  129. package/src/ai.test.ts +502 -502
  130. package/src/ai.ts +1391 -1391
  131. package/src/build-api.coverage.test.ts +633 -633
  132. package/src/build-api.ts +895 -895
  133. package/src/builtin-editors.grid.test.ts +85 -85
  134. package/src/cell-formatting.ts +169 -169
  135. package/src/cell-render.ts +469 -469
  136. package/src/chart-export.ts +201 -201
  137. package/src/chart-view.svelte.ts +36 -36
  138. package/src/chart.ts +2296 -2296
  139. package/src/collaboration.test.ts +104 -104
  140. package/src/collaboration.ts +167 -167
  141. package/src/core.performance.test.ts +30 -30
  142. package/src/core.ts +1111 -1111
  143. package/src/createAutocomplete.svelte.ts +132 -132
  144. package/src/createCombobox.svelte.ts +191 -191
  145. package/src/createCountryInput.svelte.ts +157 -157
  146. package/src/createDropdownList.svelte.ts +168 -168
  147. package/src/createForm.svelte.ts +386 -386
  148. package/src/createGrid.svelte.ts +42 -42
  149. package/src/createGrid.test.ts +10 -10
  150. package/src/createGridState.svelte.ts +17 -17
  151. package/src/createMenu.svelte.ts +225 -225
  152. package/src/createPopoverSelect.svelte.ts +213 -213
  153. package/src/createSlider.svelte.ts +191 -191
  154. package/src/createTooltip.svelte.ts +144 -144
  155. package/src/createTree.svelte.ts +319 -319
  156. package/src/editing.test.ts +859 -859
  157. package/src/editing.ts +675 -675
  158. package/src/editor-contract.ts +157 -157
  159. package/src/export-data-api.test.ts +126 -126
  160. package/src/export-format.test.ts +107 -107
  161. package/src/export-format.ts +598 -598
  162. package/src/filter-operators.ts +157 -157
  163. package/src/flex-render.ts +3 -3
  164. package/src/form-field.ts +127 -127
  165. package/src/index.ts +713 -713
  166. package/src/js-scroller.svelte.ts +173 -173
  167. package/src/keyboard.test.ts +59 -59
  168. package/src/keyboard.ts +97 -97
  169. package/src/list-nav.test.ts +49 -49
  170. package/src/list-nav.ts +29 -29
  171. package/src/list-option.test.ts +56 -56
  172. package/src/list-option.ts +172 -172
  173. package/src/menus.test.ts +700 -700
  174. package/src/menus.ts +652 -652
  175. package/src/merge-objects.ts +48 -48
  176. package/src/overlays.test.ts +90 -90
  177. package/src/render-component.ts +28 -28
  178. package/src/scheduler-model.test.ts +562 -562
  179. package/src/scheduler-model.ts +872 -872
  180. package/src/selection.test.ts +754 -754
  181. package/src/selection.ts +600 -600
  182. package/src/server-data-source.test.ts +289 -289
  183. package/src/server-data-source.ts +413 -413
  184. package/src/sparkline.test.ts +68 -68
  185. package/src/sparkline.ts +169 -169
  186. package/src/spreadsheet.test.ts +489 -489
  187. package/src/spreadsheet.ts +312 -312
  188. package/src/static-functions.ts +11 -11
  189. package/src/subscribe.ts +38 -38
  190. package/src/svgrid-wrapper.types.ts +524 -524
  191. package/src/svgrid.behavior.test.ts +706 -706
  192. package/src/svgrid.charting.test.ts +534 -534
  193. package/src/svgrid.features.test.ts +157 -157
  194. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  195. package/src/svgrid.wrapper.test.ts +40 -40
  196. package/src/test-setup.ts +62 -62
  197. package/src/themes/index.ts +215 -215
  198. package/src/toast-store.svelte.ts +246 -246
  199. package/src/toast-store.test.ts +147 -147
  200. package/src/ui-buttons.test.ts +144 -144
  201. package/src/ui-inputs.test.ts +118 -118
  202. package/src/ui-range.test.ts +70 -70
  203. package/src/ui-selection.test.ts +155 -155
  204. package/src/ui-tier1.test.ts +142 -142
  205. package/src/virtual.test.ts +88 -88
  206. package/src/virtualization/column-virtualizer.test.ts +27 -27
  207. package/src/virtualization/column-virtualizer.ts +30 -30
  208. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  209. package/src/virtualization/types.ts +30 -30
  210. package/src/virtualization/virtualizer.test.ts +47 -47
  211. package/src/virtualization/virtualizer.ts +296 -296
  212. package/themes/ember.css +71 -71
@@ -1,633 +1,633 @@
1
- /**
2
- * Coverage-focused behavioral tests for the SvGridApi assembled in
3
- * `build-api.ts`. The existing `svgrid.api.test.ts` / `svgrid.api-extensions
4
- * .test.ts` cover filters, row selection, pagination, navigation, and
5
- * getState/setState. This file exercises the remaining surface:
6
- * - getCellValue / setCellValue
7
- * - selectCells / getSelected
8
- * - addRow(s) / removeRow(s) / applyTransaction
9
- * - addColumn(s) / removeColumn / setColumnVisible / getColumns
10
- * - setColumnWidth / setColumnPinning / setColumnOrder
11
- * - setFacetFilter
12
- * - undo / redo / canUndo / canRedo / clearHistory
13
- * - find (open/close/query/hits)
14
- * - grouping (setGroupBy / expandAllGroups / collapseAllGroups)
15
- * - autosizeColumn / refresh
16
- *
17
- * All tests mount the real <SvGrid /> in jsdom and drive the api handed back
18
- * from onApiReady.
19
- */
20
-
21
- import { describe, expect, it } from "vitest";
22
- import { mount, unmount } from "svelte";
23
- import SvGrid from "./SvGrid.svelte";
24
- import {
25
- columnFilteringFeature,
26
- columnGroupingFeature,
27
- rowExpandingFeature,
28
- rowSelectionFeature,
29
- rowSortingFeature,
30
- tableFeatures,
31
- } from "./index";
32
- import type { ColumnDef, SvGridApi } from "./index";
33
-
34
- type Row = { id: number; name: string; team: string; salary: number };
35
-
36
- const baseRows: Row[] = [
37
- { id: 1, name: "Ada Lovelace", team: "Research", salary: 142_000 },
38
- { id: 2, name: "Grace Hopper", team: "Compilers", salary: 158_000 },
39
- { id: 3, name: "Alan Turing", team: "Research", salary: 138_000 },
40
- { id: 4, name: "Margaret Hamilton", team: "Apollo", salary: 165_000 },
41
- { id: 5, name: "Linus Torvalds", team: "Kernel", salary: 175_000 },
42
- ];
43
-
44
- const baseColumns: ColumnDef<any, Row>[] = [
45
- { field: "name", header: "Name", width: 200 },
46
- { field: "team", header: "Team", width: 160 },
47
- { field: "salary", header: "Salary", width: 140 },
48
- ];
49
-
50
- const flush = () => Promise.resolve();
51
-
52
- function mountGrid(
53
- extraProps: Record<string, unknown> = {},
54
- features: any = tableFeatures({
55
- columnFilteringFeature,
56
- rowSortingFeature,
57
- rowSelectionFeature,
58
- columnGroupingFeature,
59
- rowExpandingFeature,
60
- }),
61
- ): Promise<{ api: SvGridApi<any, Row>; target: HTMLElement; destroy: () => void }> {
62
- return new Promise((resolveApi, rejectApi) => {
63
- const target = document.createElement("div");
64
- document.body.appendChild(target);
65
- let captured: SvGridApi<any, Row> | null = null;
66
- const app = mount(SvGrid, {
67
- target,
68
- props: {
69
- data: baseRows.map((r) => ({ ...r })),
70
- columns: baseColumns.map((c) => ({ ...c })),
71
- features,
72
- getRowId: (r: Row) => String(r.id),
73
- rowHeight: 36,
74
- containerHeight: 480,
75
- virtualization: false,
76
- enableCellSelection: true,
77
- onApiReady(api: SvGridApi<any, Row>) {
78
- captured = api;
79
- resolveApi({
80
- api,
81
- target,
82
- destroy: () => {
83
- unmount(app);
84
- target.remove();
85
- },
86
- });
87
- },
88
- ...extraProps,
89
- } as any,
90
- });
91
- queueMicrotask(() => {
92
- if (!captured) rejectApi(new Error("onApiReady never fired"));
93
- });
94
- });
95
- }
96
-
97
- describe("SvGridApi - cell read / write", () => {
98
- it("getCellValue reads through the column field", async () => {
99
- const { api, destroy } = await mountGrid();
100
- try {
101
- expect(api.getCellValue(0, "name")).toBe("Ada Lovelace");
102
- expect(api.getCellValue(3, "team")).toBe("Apollo");
103
- } finally {
104
- destroy();
105
- }
106
- });
107
-
108
- it("getCellValue returns undefined for out-of-range row or unknown column", async () => {
109
- const { api, destroy } = await mountGrid();
110
- try {
111
- expect(api.getCellValue(999, "name")).toBeUndefined();
112
- expect(api.getCellValue(0, "nope")).toBeUndefined();
113
- } finally {
114
- destroy();
115
- }
116
- });
117
-
118
- it("setCellValue writes a new immutable row and reads back", async () => {
119
- const { api, destroy } = await mountGrid();
120
- try {
121
- api.setCellValue(0, "name", "Ada L.");
122
- await flush();
123
- expect(api.getCellValue(0, "name")).toBe("Ada L.");
124
- // other rows untouched
125
- expect(api.getCellValue(1, "name")).toBe("Grace Hopper");
126
- } finally {
127
- destroy();
128
- }
129
- });
130
-
131
- it("setCellValue is a no-op for an invalid target", async () => {
132
- const { api, destroy } = await mountGrid();
133
- try {
134
- expect(() => api.setCellValue(999, "name", "x")).not.toThrow();
135
- expect(() => api.setCellValue(0, "unknown", "x")).not.toThrow();
136
- } finally {
137
- destroy();
138
- }
139
- });
140
- });
141
-
142
- describe("SvGridApi - cell selection", () => {
143
- it("selectCells sets a rectangle; getSelected reads it back normalized", async () => {
144
- const { api, destroy } = await mountGrid();
145
- try {
146
- api.selectCells([[2, 1, 0, 0]]); // unsorted corners
147
- await flush();
148
- expect(api.getSelected()).toEqual([[0, 0, 2, 1]]);
149
- } finally {
150
- destroy();
151
- }
152
- });
153
-
154
- it("selectCells clamps open-ended (Infinity) coordinates to grid bounds", async () => {
155
- const { api, destroy } = await mountGrid();
156
- try {
157
- api.selectCells([[0, 0, Infinity, Infinity]]);
158
- await flush();
159
- // 5 rows (0..4), 3 cols (0..2)
160
- expect(api.getSelected()).toEqual([[0, 0, 4, 2]]);
161
- } finally {
162
- destroy();
163
- }
164
- });
165
-
166
- it("empty selectCells clears the range; getSelected returns []", async () => {
167
- const { api, destroy } = await mountGrid();
168
- try {
169
- api.selectCells([[0, 0, 1, 1]]);
170
- await flush();
171
- api.selectCells([]);
172
- await flush();
173
- expect(api.getSelected()).toEqual([]);
174
- } finally {
175
- destroy();
176
- }
177
- });
178
- });
179
-
180
- describe("SvGridApi - row mutations", () => {
181
- it("addRow appends to the bottom by default", async () => {
182
- const { api, destroy } = await mountGrid();
183
- try {
184
- api.addRow({ id: 6, name: "New", team: "QA", salary: 1 } as Row);
185
- await flush();
186
- const data = api.getData() as Row[];
187
- expect(data.length).toBe(6);
188
- expect(data[5]!.id).toBe(6);
189
- } finally {
190
- destroy();
191
- }
192
- });
193
-
194
- it("addRows at top / numeric index insert in place", async () => {
195
- const { api, destroy } = await mountGrid();
196
- try {
197
- api.addRows([{ id: 7, name: "Top", team: "T", salary: 1 } as Row], "top");
198
- await flush();
199
- expect((api.getData() as Row[])[0]!.id).toBe(7);
200
-
201
- api.addRows([{ id: 8, name: "Mid", team: "M", salary: 1 } as Row], 2);
202
- await flush();
203
- expect((api.getData() as Row[])[2]!.id).toBe(8);
204
- } finally {
205
- destroy();
206
- }
207
- });
208
-
209
- it("removeRow / removeRows drop by index", async () => {
210
- const { api, destroy } = await mountGrid();
211
- try {
212
- api.removeRow(0);
213
- await flush();
214
- expect((api.getData() as Row[]).map((r) => r.id)).toEqual([2, 3, 4, 5]);
215
-
216
- api.removeRows([0, 2]); // drops ids 2 and 4
217
- await flush();
218
- expect((api.getData() as Row[]).map((r) => r.id)).toEqual([3, 5]);
219
- } finally {
220
- destroy();
221
- }
222
- });
223
-
224
- it("applyTransaction adds, updates (by id), and removes; returns counts", async () => {
225
- const { api, destroy } = await mountGrid();
226
- try {
227
- const result = api.applyTransaction({
228
- add: [{ id: 9, name: "Added", team: "X", salary: 1 } as Row],
229
- update: [
230
- { id: 2, name: "Grace H.", team: "Compilers", salary: 999 } as Row,
231
- ],
232
- remove: ["3"], // by getRowId string
233
- });
234
- await flush();
235
- expect(result).toEqual({ added: 1, updated: 1, removed: 1 });
236
- const data = api.getData() as Row[];
237
- expect(data.find((r) => r.id === 3)).toBeUndefined();
238
- expect(data.find((r) => r.id === 2)!.salary).toBe(999);
239
- expect(data.find((r) => r.id === 9)).toBeTruthy();
240
- } finally {
241
- destroy();
242
- }
243
- });
244
-
245
- it("applyTransaction removes by object reference too", async () => {
246
- const { api, destroy } = await mountGrid();
247
- try {
248
- const target = (api.getData() as Row[])[0]!;
249
- const result = api.applyTransaction({ remove: [target] });
250
- await flush();
251
- expect(result.removed).toBe(1);
252
- expect((api.getData() as Row[]).find((r) => r === target)).toBeUndefined();
253
- } finally {
254
- destroy();
255
- }
256
- });
257
- });
258
-
259
- describe("SvGridApi - column mutations", () => {
260
- it("addColumn left / right / numeric position, then getColumns reflects it", async () => {
261
- const { api, destroy } = await mountGrid();
262
- try {
263
- api.addColumn({ field: "id", header: "ID" } as any, "left");
264
- await flush();
265
- expect(api.getColumns()[0]!.id).toBe("id");
266
-
267
- api.addColumns([{ field: "extra", header: "Extra" } as any], "right");
268
- await flush();
269
- const cols = api.getColumns();
270
- expect(cols[cols.length - 1]!.id).toBe("extra");
271
- } finally {
272
- destroy();
273
- }
274
- });
275
-
276
- it("removeColumn drops a column from the visible set", async () => {
277
- const { api, destroy } = await mountGrid();
278
- try {
279
- api.removeColumn("team");
280
- await flush();
281
- expect(api.getColumns().find((c) => c.id === "team")).toBeUndefined();
282
- } finally {
283
- destroy();
284
- }
285
- });
286
-
287
- it("setColumnVisible toggles visibility; getColumns lists hidden as visible:false", async () => {
288
- const { api, destroy } = await mountGrid();
289
- try {
290
- api.setColumnVisible("team", false);
291
- await flush();
292
- expect(api.isColumnVisible("team")).toBe(false);
293
- const hidden = api.getColumns().find((c) => c.id === "team");
294
- expect(hidden!.visible).toBe(false);
295
-
296
- api.setColumnVisible("team", true);
297
- await flush();
298
- expect(api.isColumnVisible("team")).toBe(true);
299
- } finally {
300
- destroy();
301
- }
302
- });
303
-
304
- it("setColumnWidth clamps + getColumnWidths round-trips", async () => {
305
- const { api, destroy } = await mountGrid();
306
- try {
307
- api.setColumnWidth("name", 333.7);
308
- await flush();
309
- expect(api.getColumnWidths().name).toBe(333);
310
- } finally {
311
- destroy();
312
- }
313
- });
314
-
315
- it("setColumnPinning dedupes; getColumnPinning returns copies", async () => {
316
- const { api, destroy } = await mountGrid();
317
- try {
318
- api.setColumnPinning({ left: ["name", "name"], right: ["salary"] });
319
- await flush();
320
- const pin = api.getColumnPinning();
321
- expect(pin.left).toEqual(["name"]);
322
- expect(pin.right).toEqual(["salary"]);
323
- // mutating the returned copy doesn't affect internal state
324
- pin.left.push("hacked");
325
- expect(api.getColumnPinning().left).toEqual(["name"]);
326
- } finally {
327
- destroy();
328
- }
329
- });
330
-
331
- it("setColumnOrder + getColumnOrder round-trip", async () => {
332
- const { api, destroy } = await mountGrid();
333
- try {
334
- api.setColumnOrder(["salary", "name", "team"]);
335
- await flush();
336
- expect(api.getColumnOrder().slice(0, 3)).toEqual([
337
- "salary",
338
- "name",
339
- "team",
340
- ]);
341
- } finally {
342
- destroy();
343
- }
344
- });
345
-
346
- // Note: autosizeColumn / autosizeAllColumns are intentionally not asserted
347
- // here - they measure text via real DOM layout (canvas/escape), which jsdom
348
- // does not provide, so they throw in this environment. They are exercised by
349
- // the demo gallery / Playwright suite per the coverage config notes.
350
- });
351
-
352
- describe("SvGridApi - facet filter", () => {
353
- it("setFacetFilter narrows displayed rows; null clears it", async () => {
354
- const { api, destroy } = await mountGrid();
355
- try {
356
- api.setFacetFilter("team", ["Research"]);
357
- await flush();
358
- const displayed = api.getDisplayedRows() as Row[];
359
- expect(displayed.every((r) => r.team === "Research")).toBe(true);
360
- expect(displayed.length).toBe(2);
361
-
362
- api.setFacetFilter("team", null);
363
- await flush();
364
- expect((api.getDisplayedRows() as Row[]).length).toBe(5);
365
- } finally {
366
- destroy();
367
- }
368
- });
369
-
370
- it("setFacetFilter with an empty array also clears", async () => {
371
- const { api, destroy } = await mountGrid();
372
- try {
373
- api.setFacetFilter("team", ["Apollo"]);
374
- await flush();
375
- api.setFacetFilter("team", []);
376
- await flush();
377
- expect((api.getDisplayedRows() as Row[]).length).toBe(5);
378
- } finally {
379
- destroy();
380
- }
381
- });
382
- });
383
-
384
- describe("SvGridApi - find", () => {
385
- it("openFind / setFindQuery / getFindHits / closeFind", async () => {
386
- const { api, destroy } = await mountGrid();
387
- try {
388
- api.openFind();
389
- api.setFindQuery("Research");
390
- await flush();
391
- const hits = api.getFindHits();
392
- expect(Array.isArray(hits)).toBe(true);
393
- // two cells contain "Research"
394
- expect(hits.length).toBeGreaterThanOrEqual(2);
395
-
396
- api.closeFind();
397
- await flush();
398
- expect(api.getFindHits()).toEqual([]);
399
- } finally {
400
- destroy();
401
- }
402
- });
403
- });
404
-
405
- describe("SvGridApi - undo / redo / history", () => {
406
- it("canUndo is false before any history; undo/redo are no-ops then", async () => {
407
- const { api, destroy } = await mountGrid();
408
- try {
409
- expect(api.canUndo()).toBe(false);
410
- expect(api.canRedo()).toBe(false);
411
- expect(api.undo()).toBe(false);
412
- expect(api.redo()).toBe(false);
413
- } finally {
414
- destroy();
415
- }
416
- });
417
-
418
- it("clearHistory resets the stacks without throwing", async () => {
419
- const { api, destroy } = await mountGrid();
420
- try {
421
- expect(() => api.clearHistory()).not.toThrow();
422
- expect(api.canUndo()).toBe(false);
423
- expect(api.canRedo()).toBe(false);
424
- } finally {
425
- destroy();
426
- }
427
- });
428
- });
429
-
430
- describe("SvGridApi - grouping / expansion", () => {
431
- it("setGroupBy groups rows; the underlying data is unchanged", async () => {
432
- const { api, destroy } = await mountGrid();
433
- try {
434
- api.setGroupBy(["team"]);
435
- await flush();
436
- // Grouping reshapes the display pipeline; the source data is intact.
437
- expect((api.getData() as Row[]).length).toBe(5);
438
- expect(api.getState().grouping).toContain("team");
439
- } finally {
440
- destroy();
441
- }
442
- });
443
-
444
- it("expandAllGroups / collapseAllGroups run without error", async () => {
445
- const { api, destroy } = await mountGrid();
446
- try {
447
- api.setGroupBy(["team"]);
448
- await flush();
449
- expect(() => api.expandAllGroups()).not.toThrow();
450
- await flush();
451
- expect(() => api.collapseAllGroups()).not.toThrow();
452
- await flush();
453
- // un-group
454
- api.setGroupBy([]);
455
- await flush();
456
- expect((api.getData() as Row[]).length).toBe(5);
457
- } finally {
458
- destroy();
459
- }
460
- });
461
-
462
- it("setRowExpanded toggles a row's expanded flag", async () => {
463
- const { api, destroy } = await mountGrid();
464
- try {
465
- expect(() => api.setRowExpanded("1", true)).not.toThrow();
466
- await flush();
467
- expect(() => api.setRowExpanded("1", false)).not.toThrow();
468
- } finally {
469
- destroy();
470
- }
471
- });
472
- });
473
-
474
- describe("SvGridApi - sort opt-out + refresh", () => {
475
- it("setSort with a direction sets a single active clause", async () => {
476
- const { api, destroy } = await mountGrid();
477
- try {
478
- api.setSort("salary", "asc");
479
- await flush();
480
- expect(api.getState().sorting).toEqual([{ id: "salary", desc: false }]);
481
-
482
- api.setSort("name", "desc");
483
- await flush();
484
- // Setting a direction replaces the active sort clause.
485
- expect(api.getState().sorting).toEqual([{ id: "name", desc: true }]);
486
- } finally {
487
- destroy();
488
- }
489
- });
490
-
491
- it("setSort with a falsy direction removes that column's clause", async () => {
492
- const { api, destroy } = await mountGrid();
493
- try {
494
- api.setSort("salary", "asc");
495
- await flush();
496
- api.setSort("salary", null as any);
497
- await flush();
498
- expect(
499
- api.getState().sorting.find((s) => s.id === "salary"),
500
- ).toBeUndefined();
501
- } finally {
502
- destroy();
503
- }
504
- });
505
-
506
- it("setSort is ignored for a non-sortable column", async () => {
507
- const { api, destroy } = await mountGrid({
508
- columns: [
509
- { field: "name", header: "Name", width: 200, sortable: false },
510
- { field: "team", header: "Team", width: 160 },
511
- ],
512
- });
513
- try {
514
- api.setSort("name", "asc");
515
- await flush();
516
- expect(api.getState().sorting.find((s) => s.id === "name")).toBeUndefined();
517
- } finally {
518
- destroy();
519
- }
520
- });
521
-
522
- it("refresh re-runs the pipeline without throwing or losing data", async () => {
523
- const { api, destroy } = await mountGrid();
524
- try {
525
- expect(() => api.refresh()).not.toThrow();
526
- await flush();
527
- expect((api.getData() as Row[]).length).toBe(5);
528
- } finally {
529
- destroy();
530
- }
531
- });
532
- });
533
-
534
- describe("SvGridApi - setOption / getOption (runtime prop overrides)", () => {
535
- it("getOption returns the incoming prop when no override is set", async () => {
536
- const { api, destroy } = await mountGrid();
537
- try {
538
- expect(api.getOption("rowHeight")).toBe(36);
539
- expect(api.getOption("zebraRows")).toBeUndefined();
540
- } finally {
541
- destroy();
542
- }
543
- });
544
-
545
- it("setOption overrides a prop, getOption reflects it, undefined clears it", async () => {
546
- const { api, destroy } = await mountGrid();
547
- try {
548
- api.setOption("rowHeight", 48);
549
- await flush();
550
- expect(api.getOption("rowHeight")).toBe(48);
551
-
552
- api.setOption("zebraRows", true);
553
- await flush();
554
- expect(api.getOption("zebraRows")).toBe(true);
555
-
556
- // Clearing an override falls back to the incoming prop.
557
- api.setOption("rowHeight", undefined);
558
- await flush();
559
- expect(api.getOption("rowHeight")).toBe(36);
560
- } finally {
561
- destroy();
562
- }
563
- });
564
-
565
- it("setOption('sortable', true) turns sorting on at runtime; false turns it off", async () => {
566
- // Mount with NO features so sorting starts disabled - only the runtime
567
- // override can inject rowSortingFeature (mirrors resolveEffectiveFeatures).
568
- const { api, destroy } = await mountGrid({}, tableFeatures({}));
569
- try {
570
- // Off by default: setSort is guarded to a no-op.
571
- api.setSort("salary", "asc");
572
- await flush();
573
- expect(api.getState().sorting).toEqual([]);
574
-
575
- // Turn sorting on via the override, then setSort takes effect.
576
- api.setOption("sortable", true);
577
- await flush();
578
- api.setSort("salary", "asc");
579
- await flush();
580
- expect(api.getState().sorting).toEqual([{ id: "salary", desc: false }]);
581
-
582
- // Turn it back off: setSort is guarded again.
583
- api.setOption("sortable", false);
584
- await flush();
585
- api.clearSort();
586
- await flush();
587
- api.setSort("team", "asc");
588
- await flush();
589
- expect(api.getState().sorting).toEqual([]);
590
- } finally {
591
- destroy();
592
- }
593
- });
594
-
595
- it("a view-direct prop (zebraRows) visually re-renders on override", async () => {
596
- const { api, target, destroy } = await mountGrid();
597
- try {
598
- // No striping to start.
599
- expect(target.querySelectorAll(".sv-grid-row-alt").length).toBe(0);
600
-
601
- api.setOption("zebraRows", true);
602
- await flush();
603
- await flush();
604
- // Odd rows now carry the alternate-row class (view reads props.zebraRows,
605
- // which is the effective proxy).
606
- expect(target.querySelectorAll(".sv-grid-row-alt").length).toBeGreaterThan(0);
607
-
608
- api.setOption("zebraRows", undefined);
609
- await flush();
610
- await flush();
611
- expect(target.querySelectorAll(".sv-grid-row-alt").length).toBe(0);
612
- } finally {
613
- destroy();
614
- }
615
- });
616
-
617
- it("resetOptions clears every override", async () => {
618
- const { api, destroy } = await mountGrid();
619
- try {
620
- api.setOption("rowHeight", 60);
621
- api.setOption("zebraRows", true);
622
- await flush();
623
- expect(api.getOption("rowHeight")).toBe(60);
624
-
625
- api.resetOptions();
626
- await flush();
627
- expect(api.getOption("rowHeight")).toBe(36);
628
- expect(api.getOption("zebraRows")).toBeUndefined();
629
- } finally {
630
- destroy();
631
- }
632
- });
633
- });
1
+ /**
2
+ * Coverage-focused behavioral tests for the SvGridApi assembled in
3
+ * `build-api.ts`. The existing `svgrid.api.test.ts` / `svgrid.api-extensions
4
+ * .test.ts` cover filters, row selection, pagination, navigation, and
5
+ * getState/setState. This file exercises the remaining surface:
6
+ * - getCellValue / setCellValue
7
+ * - selectCells / getSelected
8
+ * - addRow(s) / removeRow(s) / applyTransaction
9
+ * - addColumn(s) / removeColumn / setColumnVisible / getColumns
10
+ * - setColumnWidth / setColumnPinning / setColumnOrder
11
+ * - setFacetFilter
12
+ * - undo / redo / canUndo / canRedo / clearHistory
13
+ * - find (open/close/query/hits)
14
+ * - grouping (setGroupBy / expandAllGroups / collapseAllGroups)
15
+ * - autosizeColumn / refresh
16
+ *
17
+ * All tests mount the real <SvGrid /> in jsdom and drive the api handed back
18
+ * from onApiReady.
19
+ */
20
+
21
+ import { describe, expect, it } from "vitest";
22
+ import { mount, unmount } from "svelte";
23
+ import SvGrid from "./SvGrid.svelte";
24
+ import {
25
+ columnFilteringFeature,
26
+ columnGroupingFeature,
27
+ rowExpandingFeature,
28
+ rowSelectionFeature,
29
+ rowSortingFeature,
30
+ tableFeatures,
31
+ } from "./index";
32
+ import type { ColumnDef, SvGridApi } from "./index";
33
+
34
+ type Row = { id: number; name: string; team: string; salary: number };
35
+
36
+ const baseRows: Row[] = [
37
+ { id: 1, name: "Ada Lovelace", team: "Research", salary: 142_000 },
38
+ { id: 2, name: "Grace Hopper", team: "Compilers", salary: 158_000 },
39
+ { id: 3, name: "Alan Turing", team: "Research", salary: 138_000 },
40
+ { id: 4, name: "Margaret Hamilton", team: "Apollo", salary: 165_000 },
41
+ { id: 5, name: "Linus Torvalds", team: "Kernel", salary: 175_000 },
42
+ ];
43
+
44
+ const baseColumns: ColumnDef<any, Row>[] = [
45
+ { field: "name", header: "Name", width: 200 },
46
+ { field: "team", header: "Team", width: 160 },
47
+ { field: "salary", header: "Salary", width: 140 },
48
+ ];
49
+
50
+ const flush = () => Promise.resolve();
51
+
52
+ function mountGrid(
53
+ extraProps: Record<string, unknown> = {},
54
+ features: any = tableFeatures({
55
+ columnFilteringFeature,
56
+ rowSortingFeature,
57
+ rowSelectionFeature,
58
+ columnGroupingFeature,
59
+ rowExpandingFeature,
60
+ }),
61
+ ): Promise<{ api: SvGridApi<any, Row>; target: HTMLElement; destroy: () => void }> {
62
+ return new Promise((resolveApi, rejectApi) => {
63
+ const target = document.createElement("div");
64
+ document.body.appendChild(target);
65
+ let captured: SvGridApi<any, Row> | null = null;
66
+ const app = mount(SvGrid, {
67
+ target,
68
+ props: {
69
+ data: baseRows.map((r) => ({ ...r })),
70
+ columns: baseColumns.map((c) => ({ ...c })),
71
+ features,
72
+ getRowId: (r: Row) => String(r.id),
73
+ rowHeight: 36,
74
+ containerHeight: 480,
75
+ virtualization: false,
76
+ enableCellSelection: true,
77
+ onApiReady(api: SvGridApi<any, Row>) {
78
+ captured = api;
79
+ resolveApi({
80
+ api,
81
+ target,
82
+ destroy: () => {
83
+ unmount(app);
84
+ target.remove();
85
+ },
86
+ });
87
+ },
88
+ ...extraProps,
89
+ } as any,
90
+ });
91
+ queueMicrotask(() => {
92
+ if (!captured) rejectApi(new Error("onApiReady never fired"));
93
+ });
94
+ });
95
+ }
96
+
97
+ describe("SvGridApi - cell read / write", () => {
98
+ it("getCellValue reads through the column field", async () => {
99
+ const { api, destroy } = await mountGrid();
100
+ try {
101
+ expect(api.getCellValue(0, "name")).toBe("Ada Lovelace");
102
+ expect(api.getCellValue(3, "team")).toBe("Apollo");
103
+ } finally {
104
+ destroy();
105
+ }
106
+ });
107
+
108
+ it("getCellValue returns undefined for out-of-range row or unknown column", async () => {
109
+ const { api, destroy } = await mountGrid();
110
+ try {
111
+ expect(api.getCellValue(999, "name")).toBeUndefined();
112
+ expect(api.getCellValue(0, "nope")).toBeUndefined();
113
+ } finally {
114
+ destroy();
115
+ }
116
+ });
117
+
118
+ it("setCellValue writes a new immutable row and reads back", async () => {
119
+ const { api, destroy } = await mountGrid();
120
+ try {
121
+ api.setCellValue(0, "name", "Ada L.");
122
+ await flush();
123
+ expect(api.getCellValue(0, "name")).toBe("Ada L.");
124
+ // other rows untouched
125
+ expect(api.getCellValue(1, "name")).toBe("Grace Hopper");
126
+ } finally {
127
+ destroy();
128
+ }
129
+ });
130
+
131
+ it("setCellValue is a no-op for an invalid target", async () => {
132
+ const { api, destroy } = await mountGrid();
133
+ try {
134
+ expect(() => api.setCellValue(999, "name", "x")).not.toThrow();
135
+ expect(() => api.setCellValue(0, "unknown", "x")).not.toThrow();
136
+ } finally {
137
+ destroy();
138
+ }
139
+ });
140
+ });
141
+
142
+ describe("SvGridApi - cell selection", () => {
143
+ it("selectCells sets a rectangle; getSelected reads it back normalized", async () => {
144
+ const { api, destroy } = await mountGrid();
145
+ try {
146
+ api.selectCells([[2, 1, 0, 0]]); // unsorted corners
147
+ await flush();
148
+ expect(api.getSelected()).toEqual([[0, 0, 2, 1]]);
149
+ } finally {
150
+ destroy();
151
+ }
152
+ });
153
+
154
+ it("selectCells clamps open-ended (Infinity) coordinates to grid bounds", async () => {
155
+ const { api, destroy } = await mountGrid();
156
+ try {
157
+ api.selectCells([[0, 0, Infinity, Infinity]]);
158
+ await flush();
159
+ // 5 rows (0..4), 3 cols (0..2)
160
+ expect(api.getSelected()).toEqual([[0, 0, 4, 2]]);
161
+ } finally {
162
+ destroy();
163
+ }
164
+ });
165
+
166
+ it("empty selectCells clears the range; getSelected returns []", async () => {
167
+ const { api, destroy } = await mountGrid();
168
+ try {
169
+ api.selectCells([[0, 0, 1, 1]]);
170
+ await flush();
171
+ api.selectCells([]);
172
+ await flush();
173
+ expect(api.getSelected()).toEqual([]);
174
+ } finally {
175
+ destroy();
176
+ }
177
+ });
178
+ });
179
+
180
+ describe("SvGridApi - row mutations", () => {
181
+ it("addRow appends to the bottom by default", async () => {
182
+ const { api, destroy } = await mountGrid();
183
+ try {
184
+ api.addRow({ id: 6, name: "New", team: "QA", salary: 1 } as Row);
185
+ await flush();
186
+ const data = api.getData() as Row[];
187
+ expect(data.length).toBe(6);
188
+ expect(data[5]!.id).toBe(6);
189
+ } finally {
190
+ destroy();
191
+ }
192
+ });
193
+
194
+ it("addRows at top / numeric index insert in place", async () => {
195
+ const { api, destroy } = await mountGrid();
196
+ try {
197
+ api.addRows([{ id: 7, name: "Top", team: "T", salary: 1 } as Row], "top");
198
+ await flush();
199
+ expect((api.getData() as Row[])[0]!.id).toBe(7);
200
+
201
+ api.addRows([{ id: 8, name: "Mid", team: "M", salary: 1 } as Row], 2);
202
+ await flush();
203
+ expect((api.getData() as Row[])[2]!.id).toBe(8);
204
+ } finally {
205
+ destroy();
206
+ }
207
+ });
208
+
209
+ it("removeRow / removeRows drop by index", async () => {
210
+ const { api, destroy } = await mountGrid();
211
+ try {
212
+ api.removeRow(0);
213
+ await flush();
214
+ expect((api.getData() as Row[]).map((r) => r.id)).toEqual([2, 3, 4, 5]);
215
+
216
+ api.removeRows([0, 2]); // drops ids 2 and 4
217
+ await flush();
218
+ expect((api.getData() as Row[]).map((r) => r.id)).toEqual([3, 5]);
219
+ } finally {
220
+ destroy();
221
+ }
222
+ });
223
+
224
+ it("applyTransaction adds, updates (by id), and removes; returns counts", async () => {
225
+ const { api, destroy } = await mountGrid();
226
+ try {
227
+ const result = api.applyTransaction({
228
+ add: [{ id: 9, name: "Added", team: "X", salary: 1 } as Row],
229
+ update: [
230
+ { id: 2, name: "Grace H.", team: "Compilers", salary: 999 } as Row,
231
+ ],
232
+ remove: ["3"], // by getRowId string
233
+ });
234
+ await flush();
235
+ expect(result).toEqual({ added: 1, updated: 1, removed: 1 });
236
+ const data = api.getData() as Row[];
237
+ expect(data.find((r) => r.id === 3)).toBeUndefined();
238
+ expect(data.find((r) => r.id === 2)!.salary).toBe(999);
239
+ expect(data.find((r) => r.id === 9)).toBeTruthy();
240
+ } finally {
241
+ destroy();
242
+ }
243
+ });
244
+
245
+ it("applyTransaction removes by object reference too", async () => {
246
+ const { api, destroy } = await mountGrid();
247
+ try {
248
+ const target = (api.getData() as Row[])[0]!;
249
+ const result = api.applyTransaction({ remove: [target] });
250
+ await flush();
251
+ expect(result.removed).toBe(1);
252
+ expect((api.getData() as Row[]).find((r) => r === target)).toBeUndefined();
253
+ } finally {
254
+ destroy();
255
+ }
256
+ });
257
+ });
258
+
259
+ describe("SvGridApi - column mutations", () => {
260
+ it("addColumn left / right / numeric position, then getColumns reflects it", async () => {
261
+ const { api, destroy } = await mountGrid();
262
+ try {
263
+ api.addColumn({ field: "id", header: "ID" } as any, "left");
264
+ await flush();
265
+ expect(api.getColumns()[0]!.id).toBe("id");
266
+
267
+ api.addColumns([{ field: "extra", header: "Extra" } as any], "right");
268
+ await flush();
269
+ const cols = api.getColumns();
270
+ expect(cols[cols.length - 1]!.id).toBe("extra");
271
+ } finally {
272
+ destroy();
273
+ }
274
+ });
275
+
276
+ it("removeColumn drops a column from the visible set", async () => {
277
+ const { api, destroy } = await mountGrid();
278
+ try {
279
+ api.removeColumn("team");
280
+ await flush();
281
+ expect(api.getColumns().find((c) => c.id === "team")).toBeUndefined();
282
+ } finally {
283
+ destroy();
284
+ }
285
+ });
286
+
287
+ it("setColumnVisible toggles visibility; getColumns lists hidden as visible:false", async () => {
288
+ const { api, destroy } = await mountGrid();
289
+ try {
290
+ api.setColumnVisible("team", false);
291
+ await flush();
292
+ expect(api.isColumnVisible("team")).toBe(false);
293
+ const hidden = api.getColumns().find((c) => c.id === "team");
294
+ expect(hidden!.visible).toBe(false);
295
+
296
+ api.setColumnVisible("team", true);
297
+ await flush();
298
+ expect(api.isColumnVisible("team")).toBe(true);
299
+ } finally {
300
+ destroy();
301
+ }
302
+ });
303
+
304
+ it("setColumnWidth clamps + getColumnWidths round-trips", async () => {
305
+ const { api, destroy } = await mountGrid();
306
+ try {
307
+ api.setColumnWidth("name", 333.7);
308
+ await flush();
309
+ expect(api.getColumnWidths().name).toBe(333);
310
+ } finally {
311
+ destroy();
312
+ }
313
+ });
314
+
315
+ it("setColumnPinning dedupes; getColumnPinning returns copies", async () => {
316
+ const { api, destroy } = await mountGrid();
317
+ try {
318
+ api.setColumnPinning({ left: ["name", "name"], right: ["salary"] });
319
+ await flush();
320
+ const pin = api.getColumnPinning();
321
+ expect(pin.left).toEqual(["name"]);
322
+ expect(pin.right).toEqual(["salary"]);
323
+ // mutating the returned copy doesn't affect internal state
324
+ pin.left.push("hacked");
325
+ expect(api.getColumnPinning().left).toEqual(["name"]);
326
+ } finally {
327
+ destroy();
328
+ }
329
+ });
330
+
331
+ it("setColumnOrder + getColumnOrder round-trip", async () => {
332
+ const { api, destroy } = await mountGrid();
333
+ try {
334
+ api.setColumnOrder(["salary", "name", "team"]);
335
+ await flush();
336
+ expect(api.getColumnOrder().slice(0, 3)).toEqual([
337
+ "salary",
338
+ "name",
339
+ "team",
340
+ ]);
341
+ } finally {
342
+ destroy();
343
+ }
344
+ });
345
+
346
+ // Note: autosizeColumn / autosizeAllColumns are intentionally not asserted
347
+ // here - they measure text via real DOM layout (canvas/escape), which jsdom
348
+ // does not provide, so they throw in this environment. They are exercised by
349
+ // the demo gallery / Playwright suite per the coverage config notes.
350
+ });
351
+
352
+ describe("SvGridApi - facet filter", () => {
353
+ it("setFacetFilter narrows displayed rows; null clears it", async () => {
354
+ const { api, destroy } = await mountGrid();
355
+ try {
356
+ api.setFacetFilter("team", ["Research"]);
357
+ await flush();
358
+ const displayed = api.getDisplayedRows() as Row[];
359
+ expect(displayed.every((r) => r.team === "Research")).toBe(true);
360
+ expect(displayed.length).toBe(2);
361
+
362
+ api.setFacetFilter("team", null);
363
+ await flush();
364
+ expect((api.getDisplayedRows() as Row[]).length).toBe(5);
365
+ } finally {
366
+ destroy();
367
+ }
368
+ });
369
+
370
+ it("setFacetFilter with an empty array also clears", async () => {
371
+ const { api, destroy } = await mountGrid();
372
+ try {
373
+ api.setFacetFilter("team", ["Apollo"]);
374
+ await flush();
375
+ api.setFacetFilter("team", []);
376
+ await flush();
377
+ expect((api.getDisplayedRows() as Row[]).length).toBe(5);
378
+ } finally {
379
+ destroy();
380
+ }
381
+ });
382
+ });
383
+
384
+ describe("SvGridApi - find", () => {
385
+ it("openFind / setFindQuery / getFindHits / closeFind", async () => {
386
+ const { api, destroy } = await mountGrid();
387
+ try {
388
+ api.openFind();
389
+ api.setFindQuery("Research");
390
+ await flush();
391
+ const hits = api.getFindHits();
392
+ expect(Array.isArray(hits)).toBe(true);
393
+ // two cells contain "Research"
394
+ expect(hits.length).toBeGreaterThanOrEqual(2);
395
+
396
+ api.closeFind();
397
+ await flush();
398
+ expect(api.getFindHits()).toEqual([]);
399
+ } finally {
400
+ destroy();
401
+ }
402
+ });
403
+ });
404
+
405
+ describe("SvGridApi - undo / redo / history", () => {
406
+ it("canUndo is false before any history; undo/redo are no-ops then", async () => {
407
+ const { api, destroy } = await mountGrid();
408
+ try {
409
+ expect(api.canUndo()).toBe(false);
410
+ expect(api.canRedo()).toBe(false);
411
+ expect(api.undo()).toBe(false);
412
+ expect(api.redo()).toBe(false);
413
+ } finally {
414
+ destroy();
415
+ }
416
+ });
417
+
418
+ it("clearHistory resets the stacks without throwing", async () => {
419
+ const { api, destroy } = await mountGrid();
420
+ try {
421
+ expect(() => api.clearHistory()).not.toThrow();
422
+ expect(api.canUndo()).toBe(false);
423
+ expect(api.canRedo()).toBe(false);
424
+ } finally {
425
+ destroy();
426
+ }
427
+ });
428
+ });
429
+
430
+ describe("SvGridApi - grouping / expansion", () => {
431
+ it("setGroupBy groups rows; the underlying data is unchanged", async () => {
432
+ const { api, destroy } = await mountGrid();
433
+ try {
434
+ api.setGroupBy(["team"]);
435
+ await flush();
436
+ // Grouping reshapes the display pipeline; the source data is intact.
437
+ expect((api.getData() as Row[]).length).toBe(5);
438
+ expect(api.getState().grouping).toContain("team");
439
+ } finally {
440
+ destroy();
441
+ }
442
+ });
443
+
444
+ it("expandAllGroups / collapseAllGroups run without error", async () => {
445
+ const { api, destroy } = await mountGrid();
446
+ try {
447
+ api.setGroupBy(["team"]);
448
+ await flush();
449
+ expect(() => api.expandAllGroups()).not.toThrow();
450
+ await flush();
451
+ expect(() => api.collapseAllGroups()).not.toThrow();
452
+ await flush();
453
+ // un-group
454
+ api.setGroupBy([]);
455
+ await flush();
456
+ expect((api.getData() as Row[]).length).toBe(5);
457
+ } finally {
458
+ destroy();
459
+ }
460
+ });
461
+
462
+ it("setRowExpanded toggles a row's expanded flag", async () => {
463
+ const { api, destroy } = await mountGrid();
464
+ try {
465
+ expect(() => api.setRowExpanded("1", true)).not.toThrow();
466
+ await flush();
467
+ expect(() => api.setRowExpanded("1", false)).not.toThrow();
468
+ } finally {
469
+ destroy();
470
+ }
471
+ });
472
+ });
473
+
474
+ describe("SvGridApi - sort opt-out + refresh", () => {
475
+ it("setSort with a direction sets a single active clause", async () => {
476
+ const { api, destroy } = await mountGrid();
477
+ try {
478
+ api.setSort("salary", "asc");
479
+ await flush();
480
+ expect(api.getState().sorting).toEqual([{ id: "salary", desc: false }]);
481
+
482
+ api.setSort("name", "desc");
483
+ await flush();
484
+ // Setting a direction replaces the active sort clause.
485
+ expect(api.getState().sorting).toEqual([{ id: "name", desc: true }]);
486
+ } finally {
487
+ destroy();
488
+ }
489
+ });
490
+
491
+ it("setSort with a falsy direction removes that column's clause", async () => {
492
+ const { api, destroy } = await mountGrid();
493
+ try {
494
+ api.setSort("salary", "asc");
495
+ await flush();
496
+ api.setSort("salary", null as any);
497
+ await flush();
498
+ expect(
499
+ api.getState().sorting.find((s) => s.id === "salary"),
500
+ ).toBeUndefined();
501
+ } finally {
502
+ destroy();
503
+ }
504
+ });
505
+
506
+ it("setSort is ignored for a non-sortable column", async () => {
507
+ const { api, destroy } = await mountGrid({
508
+ columns: [
509
+ { field: "name", header: "Name", width: 200, sortable: false },
510
+ { field: "team", header: "Team", width: 160 },
511
+ ],
512
+ });
513
+ try {
514
+ api.setSort("name", "asc");
515
+ await flush();
516
+ expect(api.getState().sorting.find((s) => s.id === "name")).toBeUndefined();
517
+ } finally {
518
+ destroy();
519
+ }
520
+ });
521
+
522
+ it("refresh re-runs the pipeline without throwing or losing data", async () => {
523
+ const { api, destroy } = await mountGrid();
524
+ try {
525
+ expect(() => api.refresh()).not.toThrow();
526
+ await flush();
527
+ expect((api.getData() as Row[]).length).toBe(5);
528
+ } finally {
529
+ destroy();
530
+ }
531
+ });
532
+ });
533
+
534
+ describe("SvGridApi - setOption / getOption (runtime prop overrides)", () => {
535
+ it("getOption returns the incoming prop when no override is set", async () => {
536
+ const { api, destroy } = await mountGrid();
537
+ try {
538
+ expect(api.getOption("rowHeight")).toBe(36);
539
+ expect(api.getOption("zebraRows")).toBeUndefined();
540
+ } finally {
541
+ destroy();
542
+ }
543
+ });
544
+
545
+ it("setOption overrides a prop, getOption reflects it, undefined clears it", async () => {
546
+ const { api, destroy } = await mountGrid();
547
+ try {
548
+ api.setOption("rowHeight", 48);
549
+ await flush();
550
+ expect(api.getOption("rowHeight")).toBe(48);
551
+
552
+ api.setOption("zebraRows", true);
553
+ await flush();
554
+ expect(api.getOption("zebraRows")).toBe(true);
555
+
556
+ // Clearing an override falls back to the incoming prop.
557
+ api.setOption("rowHeight", undefined);
558
+ await flush();
559
+ expect(api.getOption("rowHeight")).toBe(36);
560
+ } finally {
561
+ destroy();
562
+ }
563
+ });
564
+
565
+ it("setOption('sortable', true) turns sorting on at runtime; false turns it off", async () => {
566
+ // Mount with NO features so sorting starts disabled - only the runtime
567
+ // override can inject rowSortingFeature (mirrors resolveEffectiveFeatures).
568
+ const { api, destroy } = await mountGrid({}, tableFeatures({}));
569
+ try {
570
+ // Off by default: setSort is guarded to a no-op.
571
+ api.setSort("salary", "asc");
572
+ await flush();
573
+ expect(api.getState().sorting).toEqual([]);
574
+
575
+ // Turn sorting on via the override, then setSort takes effect.
576
+ api.setOption("sortable", true);
577
+ await flush();
578
+ api.setSort("salary", "asc");
579
+ await flush();
580
+ expect(api.getState().sorting).toEqual([{ id: "salary", desc: false }]);
581
+
582
+ // Turn it back off: setSort is guarded again.
583
+ api.setOption("sortable", false);
584
+ await flush();
585
+ api.clearSort();
586
+ await flush();
587
+ api.setSort("team", "asc");
588
+ await flush();
589
+ expect(api.getState().sorting).toEqual([]);
590
+ } finally {
591
+ destroy();
592
+ }
593
+ });
594
+
595
+ it("a view-direct prop (zebraRows) visually re-renders on override", async () => {
596
+ const { api, target, destroy } = await mountGrid();
597
+ try {
598
+ // No striping to start.
599
+ expect(target.querySelectorAll(".sv-grid-row-alt").length).toBe(0);
600
+
601
+ api.setOption("zebraRows", true);
602
+ await flush();
603
+ await flush();
604
+ // Odd rows now carry the alternate-row class (view reads props.zebraRows,
605
+ // which is the effective proxy).
606
+ expect(target.querySelectorAll(".sv-grid-row-alt").length).toBeGreaterThan(0);
607
+
608
+ api.setOption("zebraRows", undefined);
609
+ await flush();
610
+ await flush();
611
+ expect(target.querySelectorAll(".sv-grid-row-alt").length).toBe(0);
612
+ } finally {
613
+ destroy();
614
+ }
615
+ });
616
+
617
+ it("resetOptions clears every override", async () => {
618
+ const { api, destroy } = await mountGrid();
619
+ try {
620
+ api.setOption("rowHeight", 60);
621
+ api.setOption("zebraRows", true);
622
+ await flush();
623
+ expect(api.getOption("rowHeight")).toBe(60);
624
+
625
+ api.resetOptions();
626
+ await flush();
627
+ expect(api.getOption("rowHeight")).toBe(36);
628
+ expect(api.getOption("zebraRows")).toBeUndefined();
629
+ } finally {
630
+ destroy();
631
+ }
632
+ });
633
+ });