@svgrid/grid 3.0.0 → 3.0.2

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 (304) hide show
  1. package/CHANGELOG.md +116 -88
  2. package/README.md +199 -199
  3. package/dist/FlexRender.svelte +96 -96
  4. package/dist/GridFooter.svelte +190 -181
  5. package/dist/GridFooter.svelte.d.ts +8 -0
  6. package/dist/GridMenus.svelte +18 -10
  7. package/dist/GridMenus.svelte.d.ts +2 -1
  8. package/dist/SvAutoComplete.svelte +169 -169
  9. package/dist/SvAvatar.svelte +75 -75
  10. package/dist/SvCalendar.svelte +503 -503
  11. package/dist/SvCarousel.svelte +141 -141
  12. package/dist/SvCheckBox.svelte +102 -102
  13. package/dist/SvCircularProgress.svelte +109 -109
  14. package/dist/SvColorInput.svelte +181 -181
  15. package/dist/SvComboBox.svelte +279 -279
  16. package/dist/SvContextMenu.svelte +116 -116
  17. package/dist/SvCountryInput.svelte +163 -163
  18. package/dist/SvDrawer.svelte +254 -254
  19. package/dist/SvDropDownList.svelte +378 -378
  20. package/dist/SvDurationInput.svelte +126 -126
  21. package/dist/SvField.svelte +293 -293
  22. package/dist/SvForm.svelte +437 -437
  23. package/dist/SvGrid.controller.svelte.d.ts +17 -0
  24. package/dist/SvGrid.controller.svelte.js +128 -14
  25. package/dist/SvGrid.css +79 -10
  26. package/dist/SvGrid.svelte +191 -186
  27. package/dist/SvGrid.types.d.ts +42 -1
  28. package/dist/SvGridCellEditor.svelte +748 -744
  29. package/dist/SvGridChart.svelte +2246 -1716
  30. package/dist/SvGridChart.svelte.d.ts +63 -1
  31. package/dist/SvGridChartPanel.svelte +633 -485
  32. package/dist/SvGridChartView.svelte +79 -70
  33. package/dist/SvGridChartView.svelte.d.ts +7 -0
  34. package/dist/SvGridDropdown.svelte +728 -728
  35. package/dist/SvGridSelect.svelte +270 -270
  36. package/dist/SvGroupCell.svelte +141 -116
  37. package/dist/SvGroupCell.svelte.d.ts +8 -0
  38. package/dist/SvListBox.svelte +334 -334
  39. package/dist/SvMaskedInput.svelte +122 -122
  40. package/dist/SvMenu.svelte +124 -124
  41. package/dist/SvMenuList.svelte +146 -146
  42. package/dist/SvMultiSelect.svelte +293 -293
  43. package/dist/SvNumberInput.svelte +172 -172
  44. package/dist/SvOtpInput.svelte +158 -158
  45. package/dist/SvPasswordInput.svelte +151 -151
  46. package/dist/SvPhoneInput.svelte +133 -133
  47. package/dist/SvPopover.svelte +197 -197
  48. package/dist/SvProgress.svelte +116 -116
  49. package/dist/SvRadioGroup.svelte +107 -107
  50. package/dist/SvRating.svelte +112 -112
  51. package/dist/SvResult.svelte +73 -73
  52. package/dist/SvRichText.svelte +211 -211
  53. package/dist/SvRowGroupPanel.svelte +186 -170
  54. package/dist/SvRowGroupPanel.svelte.d.ts +8 -0
  55. package/dist/SvScrollArea.svelte +61 -61
  56. package/dist/SvSlider.svelte +203 -203
  57. package/dist/SvSwitchButton.svelte +108 -108
  58. package/dist/SvTagsInput.svelte +115 -115
  59. package/dist/SvTextInput.svelte +147 -147
  60. package/dist/SvTimePicker.svelte +245 -245
  61. package/dist/SvToaster.svelte +159 -159
  62. package/dist/SvToggleButton.svelte +85 -85
  63. package/dist/SvTooltip.svelte +161 -161
  64. package/dist/SvTour.svelte +208 -208
  65. package/dist/SvTree.svelte +444 -444
  66. package/dist/SvTreeSelect.svelte +239 -239
  67. package/dist/ai.d.ts +11 -2
  68. package/dist/ai.js +51 -7
  69. package/dist/cdn/GridMenus-DyFA-QxA.js +602 -0
  70. package/dist/cdn/GridMenus-M2XP9t0_.js +603 -0
  71. package/dist/cdn/{SvDateRangeInput-DflbiP7N.js → SvDateRangeInput-CaOuMs8O.js} +1 -1
  72. package/dist/cdn/{SvDateRangeInput-Bh0A0JkF.js → SvDateRangeInput-DMLKmGEc.js} +1 -1
  73. package/dist/cdn/{SvDateTimePicker-Bivn8dAP.js → SvDateTimePicker-CCbDZNZB.js} +1 -1
  74. package/dist/cdn/{SvDateTimePicker-BWwpfB_o.js → SvDateTimePicker-sonaH0oh.js} +1 -1
  75. package/dist/cdn/{SvGridCellEditor-Ba7rY3eu.js → SvGridCellEditor-BWnTi2N7.js} +2 -2
  76. package/dist/cdn/{SvGridCellEditor-AXL8cHGO.js → SvGridCellEditor-CjEJMJKc.js} +2 -2
  77. package/dist/cdn/SvGridChart-DAb9RbRs.js +1480 -0
  78. package/dist/cdn/SvGridChart-Yl-IXZFO.js +1481 -0
  79. package/dist/cdn/SvGridChartPanel-DayQpDsR.js +834 -0
  80. package/dist/cdn/SvGridChartPanel-aqf8n-vJ.js +810 -0
  81. package/dist/cdn/{SvGridChartView-eSPuJE6g.js → SvGridChartView-CxfakxR0.js} +5 -3
  82. package/dist/cdn/{SvGridChartView-SmPW10dI.js → SvGridChartView-Dm_YEx9L.js} +5 -3
  83. package/dist/cdn/{SvGridDropdown-B1ZcLpgs.js → SvGridDropdown-D0VdjeR8.js} +1 -1
  84. package/dist/cdn/{SvGridDropdown-CtdbHcIS.js → SvGridDropdown-D13MtJ2j.js} +1 -1
  85. package/dist/cdn/cell-formatting-C2Hf5gqd.js +86 -0
  86. package/dist/cdn/chart-CKJRCPOk.js +1652 -0
  87. package/dist/cdn/{date-format-DZT7T1wf.js → date-format-BNii4zeD.js} +2 -2
  88. package/dist/cdn/{date-format-CcP1tafP.js → date-format-BnnHlqGw.js} +2 -2
  89. package/dist/cdn/{export-format-Cv1Dll6k.js → export-format-CUDLy2yn.js} +84 -168
  90. package/dist/cdn/{src-B_YS5AOc.js → src-BJ2opd0j.js} +3642 -3450
  91. package/dist/cdn/{src-DYXXpuSk.js → src-DNbz94Ct.js} +8649 -8457
  92. package/dist/cdn/svgrid.js +16 -15
  93. package/dist/cdn/svgrid.svelte-external.js +16 -15
  94. package/dist/cell-formatting.d.ts +7 -0
  95. package/dist/cell-formatting.js +7 -1
  96. package/dist/chart-export.d.ts +23 -2
  97. package/dist/chart-export.js +88 -14
  98. package/dist/chart.d.ts +410 -18
  99. package/dist/chart.js +824 -24
  100. package/dist/editing.js +22 -13
  101. package/dist/grid-icons.d.ts +49 -0
  102. package/dist/grid-icons.js +86 -0
  103. package/dist/index.d.ts +3 -2
  104. package/dist/index.js +3 -2
  105. package/package.json +1 -1
  106. package/src/FlexRender.svelte +96 -96
  107. package/src/GridFooter.svelte +190 -181
  108. package/src/GridMenus.svelte +18 -10
  109. package/src/SvAutoComplete.svelte +169 -169
  110. package/src/SvAvatar.svelte +75 -75
  111. package/src/SvCalendar.svelte +503 -503
  112. package/src/SvCalendar.test.ts +226 -226
  113. package/src/SvCarousel.svelte +141 -141
  114. package/src/SvCheckBox.svelte +102 -102
  115. package/src/SvCircularProgress.svelte +109 -109
  116. package/src/SvColorInput.svelte +181 -181
  117. package/src/SvComboBox.svelte +279 -279
  118. package/src/SvContextMenu.svelte +116 -116
  119. package/src/SvCountryInput.svelte +163 -163
  120. package/src/SvDrawer.svelte +254 -254
  121. package/src/SvDropDownList.svelte +378 -378
  122. package/src/SvDurationInput.svelte +126 -126
  123. package/src/SvField.svelte +293 -293
  124. package/src/SvForm.svelte +437 -437
  125. package/src/SvForm.test.ts +411 -411
  126. package/src/SvGrid.controller.svelte.ts +146 -13
  127. package/src/SvGrid.css +79 -10
  128. package/src/SvGrid.svelte +191 -186
  129. package/src/SvGrid.types.ts +2133 -2092
  130. package/src/SvGridCellEditor.svelte +748 -744
  131. package/src/SvGridChart.svelte +2246 -1716
  132. package/src/SvGridChart.test.ts +243 -1
  133. package/src/SvGridChartPanel.svelte +633 -485
  134. package/src/SvGridChartView.svelte +79 -70
  135. package/src/SvGridDropdown.svelte +728 -728
  136. package/src/SvGridSelect.svelte +270 -270
  137. package/src/SvGroupCell.svelte +141 -116
  138. package/src/SvListBox.svelte +334 -334
  139. package/src/SvMaskedInput.svelte +122 -122
  140. package/src/SvMenu.svelte +124 -124
  141. package/src/SvMenu.test.ts +97 -97
  142. package/src/SvMenuList.svelte +146 -146
  143. package/src/SvMultiSelect.svelte +293 -293
  144. package/src/SvNumberInput.svelte +172 -172
  145. package/src/SvOtpInput.svelte +158 -158
  146. package/src/SvPasswordInput.svelte +151 -151
  147. package/src/SvPhoneInput.svelte +133 -133
  148. package/src/SvPopover.svelte +197 -197
  149. package/src/SvProgress.svelte +116 -116
  150. package/src/SvRadioGroup.svelte +107 -107
  151. package/src/SvRating.svelte +112 -112
  152. package/src/SvResult.svelte +73 -73
  153. package/src/SvRichText.svelte +211 -211
  154. package/src/SvRowGroupPanel.svelte +186 -170
  155. package/src/SvScrollArea.svelte +61 -61
  156. package/src/SvSlider.svelte +203 -203
  157. package/src/SvSwitchButton.svelte +108 -108
  158. package/src/SvTagsInput.svelte +115 -115
  159. package/src/SvTextInput.svelte +147 -147
  160. package/src/SvTimePicker.svelte +245 -245
  161. package/src/SvToaster.svelte +159 -159
  162. package/src/SvToaster.test.ts +95 -95
  163. package/src/SvToggleButton.svelte +85 -85
  164. package/src/SvTooltip.svelte +161 -161
  165. package/src/SvTour.svelte +208 -208
  166. package/src/SvTree.svelte +444 -444
  167. package/src/SvTreeSelect.svelte +239 -239
  168. package/src/a11y/dismissable.test.ts +119 -119
  169. package/src/a11y/dismissable.ts +114 -114
  170. package/src/a11y.contract.test.ts +49 -49
  171. package/src/a11y.test.ts +59 -59
  172. package/src/a11y.ts +61 -61
  173. package/src/ai.test.ts +561 -502
  174. package/src/ai.ts +1472 -1419
  175. package/src/build-api.coverage.test.ts +633 -633
  176. package/src/build-api.ts +846 -846
  177. package/src/builtin-editors.grid.test.ts +83 -83
  178. package/src/cell-formatting.ts +177 -171
  179. package/src/cell-render.test.ts +513 -513
  180. package/src/cell-render.ts +496 -496
  181. package/src/cell-values.ts +148 -148
  182. package/src/chart-export.test.ts +112 -0
  183. package/src/chart-export.ts +270 -202
  184. package/src/chart-view.svelte.ts +36 -36
  185. package/src/chart.test.ts +830 -1
  186. package/src/chart.ts +3342 -2321
  187. package/src/collaboration.test.ts +104 -104
  188. package/src/collaboration.ts +167 -167
  189. package/src/column-groups.ts +78 -78
  190. package/src/core.performance.test.ts +30 -30
  191. package/src/core.ts +1865 -1865
  192. package/src/createAutocomplete.svelte.ts +132 -132
  193. package/src/createCombobox.svelte.ts +191 -191
  194. package/src/createCountryInput.svelte.ts +157 -157
  195. package/src/createDropdownList.svelte.ts +168 -168
  196. package/src/createForm.svelte.ts +386 -386
  197. package/src/createGrid.svelte.ts +42 -42
  198. package/src/createGrid.test.ts +10 -10
  199. package/src/createGridState.svelte.ts +17 -17
  200. package/src/createListbox.svelte.ts +250 -250
  201. package/src/createMenu.svelte.ts +224 -224
  202. package/src/createPopoverSelect.svelte.ts +213 -213
  203. package/src/createSlider.svelte.ts +191 -191
  204. package/src/createTooltip.svelte.ts +144 -144
  205. package/src/createTree.svelte.ts +322 -322
  206. package/src/datetime/date-core.ts +206 -206
  207. package/src/datetime/date-restrict.ts +61 -61
  208. package/src/datetime/timezone.ts +135 -135
  209. package/src/dock-manager-model.ts +596 -596
  210. package/src/dock-model.ts +374 -374
  211. package/src/editing.test.ts +974 -974
  212. package/src/editing.ts +618 -609
  213. package/src/editor-contract.ts +171 -171
  214. package/src/editor-registry.grid.test.ts +144 -144
  215. package/src/editor-registry.ts +122 -122
  216. package/src/export-data-api.test.ts +126 -126
  217. package/src/export-format.test.ts +107 -107
  218. package/src/export-format.ts +601 -601
  219. package/src/filter-operators.ts +160 -160
  220. package/src/filtering/excel-filters.ts +325 -325
  221. package/src/flex-render.ts +3 -3
  222. package/src/form-field.ts +127 -127
  223. package/src/grid-icons.test.ts +46 -0
  224. package/src/grid-icons.ts +184 -0
  225. package/src/group-display.test.ts +167 -167
  226. package/src/group-display.ts +200 -200
  227. package/src/headless.ts +87 -87
  228. package/src/icon-overrides.grid.test.ts +188 -0
  229. package/src/icon-seam.test.ts +100 -0
  230. package/src/index.ts +19 -0
  231. package/src/js-scroller.svelte.ts +173 -173
  232. package/src/keyboard-handlers.ts +270 -270
  233. package/src/keyboard.test.ts +59 -59
  234. package/src/keyboard.ts +97 -97
  235. package/src/list-nav.test.ts +49 -49
  236. package/src/list-nav.ts +29 -29
  237. package/src/list-option.test.ts +56 -56
  238. package/src/list-option.ts +179 -179
  239. package/src/menus.ts +597 -597
  240. package/src/merge-objects.ts +48 -48
  241. package/src/overlays.test.ts +90 -90
  242. package/src/positioning.ts +268 -268
  243. package/src/render-component.ts +28 -28
  244. package/src/row-drag.test.ts +401 -401
  245. package/src/row-drag.ts +419 -419
  246. package/src/row-resize.test.ts +524 -524
  247. package/src/row-resize.ts +228 -228
  248. package/src/scheduler-ical.ts +181 -181
  249. package/src/scheduler-model.test.ts +562 -562
  250. package/src/scheduler-model.ts +873 -873
  251. package/src/selection.test.ts +885 -885
  252. package/src/server-data-source.test.ts +383 -383
  253. package/src/server-data-source.ts +469 -469
  254. package/src/sparkline.test.ts +68 -68
  255. package/src/sparkline.ts +169 -169
  256. package/src/spreadsheet.test.ts +488 -488
  257. package/src/spreadsheet.ts +312 -312
  258. package/src/static-functions.ts +11 -11
  259. package/src/subscribe.ts +38 -38
  260. package/src/summaries.ts +113 -113
  261. package/src/svgrid-wrapper.types.ts +563 -563
  262. package/src/svgrid.async-editor-options.test.ts +273 -273
  263. package/src/svgrid.auto-row-height.test.ts +204 -204
  264. package/src/svgrid.behavior.test.ts +910 -910
  265. package/src/svgrid.charting.test.ts +654 -534
  266. package/src/svgrid.comments-autocomplete.test.ts +127 -127
  267. package/src/svgrid.context-menu.test.ts +147 -147
  268. package/src/svgrid.features.test.ts +157 -157
  269. package/src/svgrid.filter-depth.test.ts +163 -163
  270. package/src/svgrid.filter-menu-listbox.svelte.test.ts +382 -377
  271. package/src/svgrid.filter-menu-scroll.test.ts +112 -112
  272. package/src/svgrid.grand-total.test.ts +188 -188
  273. package/src/svgrid.group-display-mode.test.ts +171 -171
  274. package/src/svgrid.group-footers.test.ts +121 -121
  275. package/src/svgrid.group-pagination.test.ts +153 -153
  276. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  277. package/src/svgrid.tree-data.test.ts +186 -186
  278. package/src/svgrid.wrapper.test.ts +63 -63
  279. package/src/svgriddropdown.async-panel.svelte.test.ts +195 -195
  280. package/src/test-setup.ts +62 -62
  281. package/src/themes/index.ts +288 -288
  282. package/src/toast-store.svelte.ts +250 -250
  283. package/src/toast-store.test.ts +147 -147
  284. package/src/tree-row-model.test.ts +168 -168
  285. package/src/ui-buttons.test.ts +144 -144
  286. package/src/ui-inputs.test.ts +118 -118
  287. package/src/ui-localization.test.ts +113 -113
  288. package/src/ui-range.test.ts +70 -70
  289. package/src/ui-selection.test.ts +155 -155
  290. package/src/ui-tier1.test.ts +142 -142
  291. package/src/virtual.test.ts +88 -88
  292. package/src/virtualization/column-virtualizer.test.ts +27 -27
  293. package/src/virtualization/column-virtualizer.ts +30 -30
  294. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  295. package/src/virtualization/types.ts +30 -30
  296. package/src/virtualization/virtualizer.test.ts +47 -47
  297. package/src/virtualization/virtualizer.ts +322 -322
  298. package/dist/cdn/GridMenus-DMihUtma.js +0 -600
  299. package/dist/cdn/GridMenus-nmNDj1a3.js +0 -601
  300. package/dist/cdn/SvGridChart-Bs2GIR2Q.js +0 -1202
  301. package/dist/cdn/SvGridChart-CwhFz7GV.js +0 -1203
  302. package/dist/cdn/SvGridChartPanel-1WXuStzM.js +0 -561
  303. package/dist/cdn/SvGridChartPanel-e5_nqNP9.js +0 -585
  304. package/dist/cdn/chart-i4XcXyHJ.js +0 -1214
package/src/build-api.ts CHANGED
@@ -1,846 +1,846 @@
1
- // build-api handlers extracted from the controller. Imperative event handlers
2
- // reading/writing controller state via the `ctx` handle; the reactive core
3
- // ($state/$derived/$effect) stays in the controller.
4
- import {
5
- type RowData,
6
- type SvGridApi,
7
- type TableFeatures,
8
- } from "./index";
9
- import "./sv-grid-scrollbar";
10
- import { untrack } from "svelte";
11
- // The export serializers load lazily (their own chunk) so export-format.ts stays
12
- // out of the base bundle - it is fetched only when an export/copy method is
13
- // actually invoked (an explicit, already-async user action).
14
- import type {
15
- GridExportColumn,
16
- GridExportScope,
17
- GridExportOptions,
18
- GridClipboardOptions,
19
- } from "./export-format";
20
- import type {
21
- FilterOperator,
22
- } from "./SvGrid.types";
23
- import {
24
- isGroupRow,
25
- getColumnAlign,
26
- columnDefMatchesId,
27
- } from "./cell-values";
28
- import { hasAdvancedFilterEngine } from "./advanced-filter.svelte";
29
-
30
- export function createGridApi<
31
- TFeatures extends TableFeatures = TableFeatures,
32
- TData extends RowData = RowData,
33
- >(ctx: any) {
34
- function buildApi(): SvGridApi<TFeatures, TData> {
35
- const findColumn = (columnId: string) =>
36
- ctx.grid.getAllColumns().find((column: any) => column.id === columnId);
37
-
38
- // --- Free data export (CSV / TSV / JSON + clipboard) helpers ----------
39
- // Snapshot the VISIBLE columns (field + label + format + align) so the
40
- // exporter reproduces on-screen values. Mirrors getColumns()'s visible set.
41
- const exportColumns = (): GridExportColumn[] =>
42
- ctx.allColumns
43
- .map((c: any) => ({
44
- field: (c.columnDef as { field?: string }).field as string,
45
- header:
46
- typeof c.columnDef.header === "string" ? c.columnDef.header : c.id,
47
- format: c.columnDef.format,
48
- align: getColumnAlign(c),
49
- }))
50
- .filter((c: GridExportColumn) => !!c.field);
51
- // Rows for the requested scope: current view / checked / full dataset.
52
- const exportScopeRows = (scope: GridExportScope): TData[] => {
53
- if (scope === "all") return ctx.internalData as TData[];
54
- const out: TData[] = [];
55
- for (const row of ctx.allRows) {
56
- if (isGroupRow(row)) continue;
57
- if (scope === "selected" && !ctx.rowSelectionState[row.id]) continue;
58
- out.push(row.original as TData);
59
- }
60
- return out;
61
- };
62
- const projectForExport = async (
63
- scope: GridExportScope,
64
- columns: ReadonlyArray<string> | undefined,
65
- rawValues: boolean | undefined,
66
- ) => {
67
- const { projectGridRows } = await import("./export-format");
68
- return projectGridRows(
69
- exportScopeRows(scope) as ReadonlyArray<Record<string, unknown>>,
70
- exportColumns(),
71
- { columns, rawValues },
72
- );
73
- };
74
-
75
- return {
76
- getCellValue(rowIndex, columnId) {
77
- const row = ctx.internalData[rowIndex];
78
- const column = findColumn(columnId);
79
- if (!row || !column) return undefined;
80
- if (column.columnDef.fieldFn)
81
- return column.columnDef.fieldFn(row);
82
- if (column.columnDef.field)
83
- return (row as Record<string, unknown>)[column.columnDef.field];
84
- return undefined;
85
- },
86
- setCellValue(rowIndex, columnId, value) {
87
- const row = ctx.internalData[rowIndex];
88
- const column = findColumn(columnId);
89
- if (!row || !column?.columnDef.field) return;
90
- const next = ctx.internalData.slice() as Array<TData>;
91
- next[rowIndex] = { ...row, [column.columnDef.field]: value } as TData;
92
- ctx.internalData = next;
93
- },
94
- startEditing(rowIndex, columnId) {
95
- return ctx.startEditing(rowIndex, columnId);
96
- },
97
- stopEditing(cancel) {
98
- return ctx.stopEditing(cancel ?? false);
99
- },
100
- selectCells(ranges) {
101
- // Multiple rectangles are supported. Empty array clears everything.
102
- if (!ranges || ranges.length === 0) {
103
- ctx.selectionRange = { anchor: null, focus: null };
104
- ctx.selectionRanges = [];
105
- return;
106
- }
107
- const rowCount = ctx.internalData.length;
108
- const colCount = ctx.allColumns.length;
109
- if (rowCount === 0 || colCount === 0) return;
110
- // Clamp to the visible grid bounds so callers can pass open-ended
111
- // values like `[0, 0, Infinity, Infinity]` to mean "select all".
112
- const toRange = ([r1, c1, r2, c2]: readonly [number, number, number, number]) => ({
113
- anchor: {
114
- rowIndex: Math.max(0, Math.min(rowCount - 1, Math.min(r1, r2))),
115
- colIndex: Math.max(0, Math.min(colCount - 1, Math.min(c1, c2))),
116
- },
117
- focus: {
118
- rowIndex: Math.max(0, Math.min(rowCount - 1, Math.max(r1, r2))),
119
- colIndex: Math.max(0, Math.min(colCount - 1, Math.max(c1, c2))),
120
- },
121
- });
122
- const built = ranges.map(toRange);
123
- // Last range is the active one; the rest are committed extras.
124
- ctx.selectionRanges = built.slice(0, -1);
125
- const active = built[built.length - 1]!;
126
- ctx.selectionRange = active;
127
- // Move the active cell to the last range's top-left so keyboard
128
- // navigation continues from there.
129
- ctx.setActiveCell(active.anchor.rowIndex, active.anchor.colIndex);
130
- },
131
- getSelected() {
132
- return ctx
133
- .getSelectionRects()
134
- .map((r: { minRow: number; minCol: number; maxRow: number; maxCol: number }) =>
135
- [r.minRow, r.minCol, r.maxRow, r.maxCol] as [number, number, number, number],
136
- );
137
- },
138
- openChart() {
139
- ctx.chartPanelOpen = true;
140
- },
141
- closeChart() {
142
- ctx.chartPanelOpen = false;
143
- },
144
- getChartSpec() {
145
- return ctx.chartSpec;
146
- },
147
- chartRange(ranges) {
148
- if (ranges && ranges.length) this.selectCells(ranges);
149
- ctx.chartPanelOpen = true;
150
- },
151
- configureChart(config) {
152
- if (ctx.chartingEnabled) ctx.applyChartConfig(config);
153
- },
154
- setChartAiHandler(handler) {
155
- ctx.chartAiHandler = handler ?? null;
156
- },
157
- addRow(row, position = "bottom") {
158
- this.addRows([row], position);
159
- },
160
- addRows(rows, position = "bottom") {
161
- const next = ctx.internalData.slice() as Array<TData>;
162
- if (position === "top") next.unshift(...rows);
163
- else if (position === "bottom") next.push(...rows);
164
- else if (typeof position === "number")
165
- next.splice(Math.max(0, Math.min(position, next.length)), 0, ...rows);
166
- ctx.internalData = next;
167
- },
168
- removeRow(rowIndex) {
169
- this.removeRows([rowIndex]);
170
- },
171
- removeRows(rowIndices) {
172
- const drop = new Set(rowIndices);
173
- ctx.internalData = ctx.internalData.filter((_: any, i: any) => !drop.has(i));
174
- },
175
- applyTransaction(tx) {
176
- const getId = ctx.props.getRowId;
177
- let next = ctx.internalData.slice() as Array<TData>;
178
- let added = 0;
179
- let updated = 0;
180
- let removed = 0;
181
-
182
- if (tx.remove?.length) {
183
- const removeIds = new Set<string>();
184
- const removeRefs = new Set<TData>();
185
- for (const r of tx.remove) {
186
- if (typeof r === "string") removeIds.add(r);
187
- else removeRefs.add(r as TData);
188
- }
189
- next = next.filter((row, i) => {
190
- const hit =
191
- removeRefs.has(row) ||
192
- (getId ? removeIds.has(getId(row, i)) : false);
193
- if (hit) removed += 1;
194
- return !hit;
195
- });
196
- }
197
-
198
- if (tx.update?.length && getId) {
199
- const byId = new Map<string, TData>();
200
- for (const u of tx.update) byId.set(getId(u, 0), u);
201
- next = next.map((row, i) => {
202
- const u = byId.get(getId(row, i));
203
- if (u) {
204
- updated += 1;
205
- return u;
206
- }
207
- return row;
208
- });
209
- }
210
-
211
- if (tx.add?.length) {
212
- next.push(...(tx.add as Array<TData>));
213
- added += tx.add.length;
214
- }
215
-
216
- ctx.internalData = next;
217
- return { added, updated, removed };
218
- },
219
- addColumn(column, position = "right") {
220
- this.addColumns([column], position);
221
- },
222
- addColumns(columns, position = "right") {
223
- const next = ctx.internalColumns.slice();
224
- if (position === "left") next.unshift(...columns);
225
- else if (position === "right") next.push(...columns);
226
- else if (typeof position === "number")
227
- next.splice(
228
- Math.max(0, Math.min(position, next.length)),
229
- 0,
230
- ...columns,
231
- );
232
- ctx.internalColumns = next;
233
- },
234
- removeColumn(columnId) {
235
- ctx.internalColumns = ctx.internalColumns.filter(
236
- (def: any) => !columnDefMatchesId(def, columnId),
237
- );
238
- },
239
- setColumnVisible(columnId, visible) {
240
- if (visible) {
241
- const next = { ...ctx.hiddenColumns };
242
- delete next[columnId];
243
- ctx.hiddenColumns = next;
244
- } else {
245
- ctx.hiddenColumns = { ...ctx.hiddenColumns, [columnId]: true };
246
- }
247
- },
248
- isColumnVisible(columnId) {
249
- return !ctx.hiddenColumns[columnId];
250
- },
251
- setSort(columnId, direction) {
252
- // Honour the column's `sortable` opt-out. Asking the engine
253
- // whether the column can sort folds in both the feature toggle
254
- // AND the per-column flag.
255
- const col = ctx.allColumns.find((c: any) => c.id === columnId);
256
- if (col && !col.getCanSort?.()) return;
257
- const clauses = direction
258
- ? [{ id: columnId, desc: direction === "desc" }]
259
- : (ctx.grid.getState().sorting ?? []).filter(
260
- (entry: { id: string }) => entry.id !== columnId,
261
- );
262
- ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: clauses }));
263
- },
264
- clearSort() {
265
- ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: [] }));
266
- },
267
- setGroupBy(columnIds) {
268
- ctx.grid.setGrouping([...columnIds]);
269
- },
270
- setOption(key, value) {
271
- // Runtime prop override. Writes into the controller's `optionOverrides`
272
- // store, which the effective-props proxy merges over the incoming prop, so
273
- // the grid re-renders exactly as if the parent had changed that prop.
274
- // `undefined` clears the override (falls back to the prop). Reassign the
275
- // whole object for reliable reactivity; `untrack` per the `setFilter` note.
276
- untrack(() => {
277
- const next: Record<string, unknown> = { ...ctx.optionOverrides };
278
- if (value === undefined) delete next[key as string];
279
- else next[key as string] = value;
280
- ctx.optionOverrides = next;
281
- });
282
- },
283
- getOption(key) {
284
- // The effective value: the override if set, otherwise the incoming prop.
285
- return (ctx.props as Record<string, unknown>)[key as string] as never;
286
- },
287
- resetOptions() {
288
- untrack(() => {
289
- ctx.optionOverrides = {};
290
- });
291
- },
292
- setFilter(columnId, filter) {
293
- // `untrack`: these imperative mutators read the same filter state they
294
- // write (read-modify-write on `filterMenuValues`). When a consumer
295
- // calls them from inside a reactive `$effect`, that internal read would
296
- // otherwise be captured as a dependency of the caller's effect, and the
297
- // write would re-dirty it - an infinite update loop. Untracking the
298
- // body keeps the API safe to drive from an effect.
299
- untrack(() => {
300
- // Honour the column's `filterable` opt-out. Same approach as
301
- // `setSort` - `getCanFilter()` already combines the feature flag
302
- // and the per-column field.
303
- const col = ctx.allColumns.find((c: any) => c.id === columnId);
304
- if (col && !col.getCanFilter?.()) return;
305
- if (!filter) {
306
- this.clearFilter(columnId);
307
- return;
308
- }
309
- ctx.filterMenuValues = {
310
- ...ctx.filterMenuValues,
311
- [columnId]: {
312
- operator: filter.operator,
313
- value: filter.value ?? "",
314
- ...(filter.operator === "between"
315
- ? { valueTo: filter.valueTo ?? "" }
316
- : {}),
317
- // Optional second condition + join (multi-condition filtering).
318
- ...(filter.operator2
319
- ? {
320
- operator2: filter.operator2,
321
- value2: filter.value2 ?? "",
322
- join: filter.join ?? "AND",
323
- ...(filter.operator2 === "between"
324
- ? { valueTo2: filter.valueTo2 ?? "" }
325
- : {}),
326
- }
327
- : {}),
328
- },
329
- };
330
- });
331
- },
332
- setFacetFilter(columnId, values) {
333
- // See `setFilter` for why the read-modify-write is untracked.
334
- untrack(() => {
335
- // Empty array OR null both mean "clear this column's facet" -
336
- // mirrors how the column menu treats unchecking the last value.
337
- if (!values || values.length === 0) {
338
- if (ctx.valueFilters[columnId]) {
339
- const next = { ...ctx.valueFilters };
340
- delete next[columnId];
341
- ctx.valueFilters = next;
342
- }
343
- return;
344
- }
345
- ctx.valueFilters = {
346
- ...ctx.valueFilters,
347
- [columnId]: new Set(values),
348
- };
349
- });
350
- },
351
- clearFilter(columnId) {
352
- ctx.clearColumnFilter(columnId);
353
- },
354
- refreshEditorOptions(columnId) {
355
- // Async `editorOptions` are cached per column (or per column+row for a
356
- // per-row source) so opening an editor twice does not refetch. This
357
- // drops those entries, so the next render re-runs the source - use it
358
- // when the underlying list changed server-side.
359
- if (columnId == null) {
360
- ctx.asyncEditorOptions = {};
361
- return;
362
- }
363
- const next = { ...ctx.asyncEditorOptions };
364
- for (const key of Object.keys(next)) {
365
- if (key === columnId || key.startsWith(`${columnId}::`)) delete next[key];
366
- }
367
- ctx.asyncEditorOptions = next;
368
- },
369
- clearAllFilters() {
370
- // See `setFilter` for why the read-modify-write is untracked.
371
- untrack(() => {
372
- // Wipe every filter surface in one go: column-menu, filter-row, set
373
- // filters, the global search box, and the advanced filter. This
374
- // promises "every filter surface", so leaving the advanced one set
375
- // would strand rows nobody can see a cause for.
376
- ctx.filterMenuValues = {};
377
- ctx.filterRowValues = {};
378
- ctx.valueFilters = {};
379
- if (ctx.globalFilter !== "") ctx.globalFilter = "";
380
- if (ctx.advancedFilter !== null) ctx.advancedFilter = null;
381
- });
382
- },
383
- setAdvancedFilter(expr) {
384
- // See `setFilter` for why the write is untracked.
385
- untrack(() => {
386
- ctx.advancedFilter = expr ?? null;
387
- });
388
- },
389
- getAdvancedFilter() {
390
- return ctx.advancedFilter ?? null;
391
- },
392
- clearAdvancedFilter() {
393
- untrack(() => {
394
- ctx.advancedFilter = null;
395
- });
396
- },
397
- isAdvancedFilterActive() {
398
- return ctx.advancedFilter != null && hasAdvancedFilterEngine();
399
- },
400
- getFilters() {
401
- // Return a defensive copy so callers can't mutate internal state.
402
- const out: Record<
403
- string,
404
- { operator: FilterOperator; value: string; valueTo?: string }
405
- > = {};
406
- for (const [columnId, filter] of Object.entries(ctx.filterMenuValues as Record<string, { operator: FilterOperator; value: string; valueTo?: string }>)) {
407
- out[columnId] = {
408
- operator: filter.operator,
409
- value: filter.value,
410
- ...(filter.operator === "between" && filter.valueTo
411
- ? { valueTo: filter.valueTo }
412
- : {}),
413
- };
414
- }
415
- return out;
416
- },
417
- getDisplayedRows() {
418
- // `allRows` is the final, post-filter, post-sort, post-group,
419
- // post-pagination list - exactly what the body renders. Skip group
420
- // header rows (they wrap an aggregate, not a TData row).
421
- //
422
- // `isGroupRow` rather than a `subRows.length` test: a TREE parent also
423
- // has subRows, but it is a real data row that renders its own cells, so
424
- // dropping it here silently truncated every tree read - including the
425
- // enterprise export, whose default row source is this method.
426
- const out: TData[] = [];
427
- for (const row of ctx.allRows) {
428
- if (isGroupRow(row)) continue;
429
- out.push(row.original as TData);
430
- }
431
- return out;
432
- },
433
- getData() {
434
- return ctx.internalData;
435
- },
436
- getColumns() {
437
- // Snapshot every column with its human-readable label and
438
- // visibility flag. Used by external code (exporters, column
439
- // pickers) so they don't have to re-walk the columnDef tree.
440
- // Hidden columns ARE included (with `visible: false`) so a column
441
- // picker can re-enable them - callers that only want what's
442
- // rendered filter by `.visible` (e.g. the exporter does).
443
- const describe = (c: any, visible: boolean) => ({
444
- id: c.id,
445
- field: (c.columnDef as { field?: string }).field,
446
- header:
447
- typeof c.columnDef.header === "string"
448
- ? c.columnDef.header
449
- : c.id,
450
- visible,
451
- // Surface the format + alignment so exporters can reproduce the
452
- // on-screen display value (currency symbol, date pattern, etc.)
453
- // instead of dumping raw values. `getColumnAlign` applies the same
454
- // editorType-based default the body uses.
455
- format: c.columnDef.format,
456
- align: getColumnAlign(c),
457
- // The column's declared value type. Lets a filter or expression UI
458
- // offer the right operators (numeric ranges vs text matching) without
459
- // re-walking the columnDef tree.
460
- editorType: (c.columnDef as { editorType?: string }).editorType,
461
- });
462
- // Visible columns first, in their current visual order...
463
- const out = ctx.allColumns.map((c: any) => describe(c, true));
464
- // ...then any column hidden via `visible: false` / setColumnVisible.
465
- // Those aren't in `allColumns` (that list is visible-only), so pull
466
- // them straight from the engine's leaf set.
467
- const visibleIds = new Set(out.map((c: { id: string }) => c.id));
468
- for (const c of ctx.grid.getAllColumns() as any[]) {
469
- if (!visibleIds.has(c.id)) out.push(describe(c, false));
470
- }
471
- return out;
472
- },
473
- // ---- Free data export (CSV / TSV / JSON + clipboard) -----------------
474
- async exportCsv(options: GridExportOptions = {}) {
475
- const { serializeDelimited, downloadTextFile } = await import("./export-format");
476
- const { records, fields } = await projectForExport(
477
- options.rows ?? "displayed",
478
- options.columns,
479
- options.rawValues,
480
- );
481
- const text = await serializeDelimited(records, fields, {
482
- csv: { delimiter: ",", bom: options.bom ?? true },
483
- signal: options.signal,
484
- onProgress: options.onProgress,
485
- });
486
- if (options.download !== false)
487
- downloadTextFile(text, `${options.filename ?? "grid"}.csv`, "text/csv;charset=utf-8");
488
- return text;
489
- },
490
- async exportTsv(options: GridExportOptions = {}) {
491
- const { serializeDelimited, downloadTextFile } = await import("./export-format");
492
- const { records, fields } = await projectForExport(
493
- options.rows ?? "displayed",
494
- options.columns,
495
- options.rawValues,
496
- );
497
- const text = await serializeDelimited(records, fields, {
498
- csv: { delimiter: "\t", bom: options.bom ?? true },
499
- signal: options.signal,
500
- onProgress: options.onProgress,
501
- });
502
- if (options.download !== false)
503
- downloadTextFile(text, `${options.filename ?? "grid"}.tsv`, "text/tab-separated-values;charset=utf-8");
504
- return text;
505
- },
506
- async exportJson(options: GridExportOptions = {}) {
507
- const { serializeJson, downloadTextFile } = await import("./export-format");
508
- const { records, fields } = await projectForExport(
509
- options.rows ?? "displayed",
510
- options.columns,
511
- options.rawValues,
512
- );
513
- const text = await serializeJson(records, fields, {
514
- signal: options.signal,
515
- onProgress: options.onProgress,
516
- });
517
- if (options.download !== false)
518
- downloadTextFile(text, `${options.filename ?? "grid"}.json`, "application/json");
519
- return text;
520
- },
521
- async copyToClipboard(options: GridClipboardOptions = {}) {
522
- const { serializeDelimited, serializeMarkdown, copyTextToClipboard } = await import("./export-format");
523
- const { records, fields, align } = await projectForExport(
524
- options.rows ?? "displayed",
525
- options.columns,
526
- options.rawValues,
527
- );
528
- const format = options.format ?? "tsv";
529
- const text =
530
- format === "markdown"
531
- ? await serializeMarkdown(records, fields, { align })
532
- : await serializeDelimited(records, fields, {
533
- csv: { delimiter: format === "csv" ? "," : "\t", bom: false },
534
- });
535
- await copyTextToClipboard(text);
536
- return text;
537
- },
538
- clearRowSelection() {
539
- // Wipe the internal selection map AND emit the change so any
540
- // consumer holding a derived `selectedRows` resets too.
541
- ctx.grid.setRowSelection(() => ({}));
542
- ctx.props.onRowSelectionChange?.({}, []);
543
- },
544
- setColumnWidth(columnId: string, width: number) {
545
- const clamped = Math.max(ctx.MIN_COLUMN_WIDTH, Math.floor(width));
546
- ctx.columnWidths = { ...ctx.columnWidths, [columnId]: clamped };
547
- },
548
- getColumnWidths() {
549
- // Resolve every column's effective width by consulting both the
550
- // resize overrides (`columnWidths`) AND the columnDef defaults,
551
- // so the snapshot is round-trippable through setColumnWidth.
552
- const out: Record<string, number> = {};
553
- for (const c of ctx.allColumns) out[c.id] = ctx.getColumnWidth(c.id);
554
- return out;
555
- },
556
- autosizeColumn(columnId: string) {
557
- ctx.autosizeColumn(columnId);
558
- },
559
- autosizeAllColumns() {
560
- ctx.autosizeAllColumns();
561
- },
562
- setColumnPinning(pinning) {
563
- // Defensive copy + dedupe so callers can't mutate our state.
564
- const left = Array.from(new Set(pinning.left ?? []));
565
- const right = Array.from(new Set(pinning.right ?? []));
566
- ctx.columnPinning = { left, right };
567
- },
568
- getColumnPinning() {
569
- return {
570
- left: ctx.columnPinning.left.slice(),
571
- right: ctx.columnPinning.right.slice(),
572
- };
573
- },
574
- // ---- Column reorder
575
- setColumnOrder(order) {
576
- ctx.setColumnOrderInternal(order);
577
- },
578
- getColumnOrder() {
579
- return ctx.getCurrentColumnOrder();
580
- },
581
- setRowExpanded(id, expanded) {
582
- ctx.grid.setExpanded((prev: any) => ({ ...prev, [id]: !!expanded }));
583
- },
584
- expandAllGroups() {
585
- // Walk the current grouped row model and flip every group node on.
586
- const next: Record<string, boolean> = {};
587
- const walk = (rows: ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>) => {
588
- for (const row of rows) {
589
- if (row.getCanExpand?.()) next[row.id] = true;
590
- const sub = row.subRows as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }> | undefined;
591
- if (sub && sub.length > 0) walk(sub);
592
- }
593
- };
594
- walk(ctx.grid.getRowModel().rows as unknown as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>);
595
- ctx.grid.setExpanded(() => next);
596
- },
597
- collapseAllGroups() {
598
- ctx.grid.setExpanded(() => ({}));
599
- },
600
- // ---- Undo / redo (history + pointer)
601
- undo() {
602
- if (ctx.historyPtr < 0) return false
603
- const step = ctx.history[ctx.historyPtr]
604
- if (!step) return false
605
- ctx.applyHistoryStep(step, 'undo')
606
- ctx.historyPtr -= 1
607
- ctx.historyVersion += 1
608
- return true
609
- },
610
- redo() {
611
- if (ctx.historyPtr >= ctx.history.length - 1) return false
612
- const step = ctx.history[ctx.historyPtr + 1]
613
- if (!step) return false
614
- ctx.applyHistoryStep(step, 'redo')
615
- ctx.historyPtr += 1
616
- ctx.historyVersion += 1
617
- return true
618
- },
619
- canUndo() { void ctx.historyVersion; return ctx.historyPtr >= 0 },
620
- canRedo() { void ctx.historyVersion; return ctx.historyPtr < ctx.history.length - 1 },
621
- clearHistory() { ctx.history = []; ctx.historyPtr = -1; ctx.historyVersion += 1 },
622
- // ---- Find
623
- openFind() { ctx.findOpen = true },
624
- closeFind() { ctx.findOpen = false; ctx.findQuery = '' },
625
- setFindQuery(q: string) { ctx.findQuery = q; ctx.findHitIndex = 0 },
626
- getFindHits() { return ctx.findHits.slice() },
627
- // ---- Row selection (read + write)
628
- getSelectedRows() {
629
- const out: TData[] = [];
630
- for (const row of ctx.allRows) {
631
- if (isGroupRow(row)) continue;
632
- if (ctx.rowSelectionState[row.id]) out.push(row.original as TData);
633
- }
634
- return out;
635
- },
636
- getSelectedRowIds() {
637
- const out: string[] = [];
638
- for (const row of ctx.allRows) {
639
- if (!isGroupRow(row) && ctx.rowSelectionState[row.id]) out.push(row.id);
640
- }
641
- return out;
642
- },
643
- selectRows(ids, additive = false) {
644
- const set = new Set(ids);
645
- ctx.grid.setRowSelection((prev: any) => {
646
- const next: Record<string, boolean> = additive ? { ...prev } : {};
647
- for (const id of set) next[id] = true;
648
- return next;
649
- });
650
- },
651
- selectAllRows() {
652
- const next: Record<string, boolean> = {};
653
- for (const row of ctx.allRows) if (!isGroupRow(row)) next[row.id] = true;
654
- ctx.grid.setRowSelection(() => next);
655
- },
656
- toggleRowSelected(id) {
657
- ctx.toggleRowSelectionById(id);
658
- },
659
- // ---- Pagination
660
- getPageInfo() {
661
- const { pageIndex, pageSize } = ctx.paginationState;
662
- const total = ctx.allRowsBeforePagination.length;
663
- const pageCount = Math.max(1, Math.ceil(total / Math.max(1, pageSize)));
664
- return { pageIndex, pageSize, pageCount, total };
665
- },
666
- setPage(pageIndex) {
667
- const total = ctx.allRowsBeforePagination.length;
668
- const pageCount = Math.max(
669
- 1,
670
- Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
671
- );
672
- ctx.goToPage(Math.max(0, Math.min(pageIndex, pageCount - 1)));
673
- },
674
- nextPage() {
675
- this.setPage(ctx.paginationState.pageIndex + 1);
676
- },
677
- prevPage() {
678
- this.setPage(ctx.paginationState.pageIndex - 1);
679
- },
680
- firstPage() {
681
- this.setPage(0);
682
- },
683
- lastPage() {
684
- const total = ctx.allRowsBeforePagination.length;
685
- const pageCount = Math.max(
686
- 1,
687
- Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
688
- );
689
- this.setPage(pageCount - 1);
690
- },
691
- setPageSize(size) {
692
- // Calls the component-level helper (lexical scope), not this method.
693
- ctx.setPageSize(Math.max(1, Math.floor(size)));
694
- },
695
- // ---- Navigation / scrolling
696
- scrollToRow(rowIndex) {
697
- if (!ctx.scrollContainer) return;
698
- const maxIndex = Math.max(0, ctx.allRows.length - 1);
699
- const clamped = Math.max(0, Math.min(rowIndex, maxIndex));
700
- // Logical offset from the virtualizer (honors uniform OR per-row
701
- // sizing), then mapped into the capped DOM scroll space so it lands
702
- // correctly on huge grids where the DOM height is scaled down.
703
- const logical = ctx.virtualizer.getOffsetForIndex(clamped);
704
- ctx.scrollContainer.scrollTop = ctx.logicalToDomRowOffset(logical);
705
- ctx.scheduleScrollSync(
706
- ctx.scrollContainer.scrollTop,
707
- ctx.scrollContainer.scrollLeft,
708
- );
709
- },
710
- getActiveCell() {
711
- const a = ctx.activeCell;
712
- if (!a || a.rowIndex < 0 || a.colIndex < 0) return null;
713
- const col = ctx.allColumns[a.colIndex];
714
- return {
715
- rowIndex: a.rowIndex,
716
- colIndex: a.colIndex,
717
- columnId: col?.id ?? "",
718
- };
719
- },
720
- setActiveCell(rowIndex, colIndex) {
721
- const r = Math.max(0, Math.min(rowIndex, Math.max(0, ctx.allRows.length - 1)));
722
- const c = Math.max(
723
- 0,
724
- Math.min(colIndex, Math.max(0, ctx.allColumns.length - 1)),
725
- );
726
- // Calls the component-level helper (lexical scope), not this method.
727
- ctx.setActiveCell(r, c);
728
- },
729
- // ---- View state (save / restore)
730
- getState() {
731
- return {
732
- sorting: (ctx.grid.getState().sorting ?? []).map(
733
- (s: { id: string; desc: boolean }) => ({ id: s.id, desc: s.desc }),
734
- ),
735
- grouping: [...(ctx.grid.getState().grouping ?? [])],
736
- pagination: {
737
- pageIndex: ctx.paginationState.pageIndex,
738
- pageSize: ctx.paginationState.pageSize,
739
- },
740
- columnWidths: this.getColumnWidths(),
741
- columnPinning: this.getColumnPinning(),
742
- columnOrder: ctx.getCurrentColumnOrder(),
743
- hiddenColumns: Object.keys(ctx.hiddenColumns).filter(
744
- (k) => ctx.hiddenColumns[k],
745
- ),
746
- globalFilter: ctx.globalFilter,
747
- columnFilters: this.getFilters(),
748
- facetFilters: Object.fromEntries(
749
- Object.entries(ctx.valueFilters).map(([k, set]: [string, any]) => [
750
- k,
751
- Array.from(set),
752
- ]),
753
- ),
754
- // Emitted only when set. `attachAutoSavedView` diffs
755
- // JSON.stringify(getState()) on a timer, so adding an always-present
756
- // key would change every existing snapshot and force one spurious
757
- // save in every app on upgrade.
758
- ...(ctx.advancedFilter ? { advancedFilter: ctx.advancedFilter } : {}),
759
- ...(ctx.chartingEnabled
760
- ? {
761
- chart: {
762
- open: ctx.chartPanelOpen,
763
- type: ctx.chartType,
764
- dimension: ctx.chartDimensionId,
765
- series: ctx.chartSeriesId,
766
- measure: ctx.chartMeasureId,
767
- reduce: ctx.chartReduce,
768
- stacked: ctx.chartStacked,
769
- },
770
- charts: ctx.getChartsState(),
771
- chartActive: ctx.activeChartIndex,
772
- }
773
- : {}),
774
- };
775
- },
776
- setState(state) {
777
- if (state.sorting) {
778
- const sorting = state.sorting.map((s) => ({ id: s.id, desc: s.desc }));
779
- ctx.grid.store.setState((prev: any) => ({ ...prev, sorting }));
780
- }
781
- if (state.grouping) {
782
- // Drop grouping by columns that no longer exist (#53) - otherwise a
783
- // saved view collapses every row into a group named 'undefined'.
784
- const existing = new Set((ctx.grid.getAllColumns() as any[]).map((c) => c.id));
785
- ctx.grid.setGrouping(state.grouping.filter((id: string) => existing.has(id)));
786
- }
787
- if (state.pagination) {
788
- const p = state.pagination;
789
- ctx.grid.setPagination((prev: any) => ({ ...prev, ...p }));
790
- }
791
- if (state.columnWidths) ctx.columnWidths = { ...state.columnWidths };
792
- if (state.columnPinning)
793
- ctx.columnPinning = {
794
- left: [...(state.columnPinning.left ?? [])],
795
- right: [...(state.columnPinning.right ?? [])],
796
- };
797
- if (state.columnOrder) ctx.setColumnOrderInternal(state.columnOrder);
798
- if (state.hiddenColumns) {
799
- // Seed from columns declared `visible: false` so a partial/empty saved
800
- // state never un-hides an app-declared-hidden column (#54); then layer
801
- // the saved user-driven hides on top.
802
- const next: Record<string, boolean> = { ...ctx.declaredHiddenColumns };
803
- for (const id of state.hiddenColumns) next[id] = true;
804
- ctx.hiddenColumns = next;
805
- }
806
- if (state.globalFilter !== undefined) ctx.globalFilter = state.globalFilter;
807
- if (state.columnFilters)
808
- ctx.filterMenuValues = { ...state.columnFilters };
809
- if (state.facetFilters) {
810
- const next: Record<string, Set<string>> = {};
811
- for (const [k, arr] of Object.entries(state.facetFilters))
812
- next[k] = new Set(arr);
813
- ctx.valueFilters = next;
814
- }
815
- // `in` rather than a truthiness check, so an explicit null clears while
816
- // an absent key leaves the current filter alone (the documented
817
- // "only the keys present are applied" contract).
818
- if ("advancedFilter" in state) {
819
- ctx.advancedFilter = state.advancedFilter ?? null;
820
- }
821
- if ((state.chart || state.charts) && ctx.chartingEnabled) {
822
- if (Array.isArray(state.charts) && state.charts.length) {
823
- ctx.applyChartsState(state.charts, state.chartActive);
824
- }
825
- if (state.chart) {
826
- const c = state.chart;
827
- ctx.chartPanelOpen = c.open;
828
- ctx.chartType = c.type;
829
- ctx.chartDimensionId = c.dimension;
830
- ctx.chartSeriesId = c.series;
831
- ctx.chartMeasureId = c.measure;
832
- ctx.chartReduce = c.reduce;
833
- ctx.chartStacked = c.stacked;
834
- }
835
- }
836
- },
837
- refresh() {
838
- ctx.grid.store.setState((prev: any) => ({ ...prev }));
839
- },
840
- };
841
- }
842
-
843
- return {
844
- buildApi,
845
- };
846
- }
1
+ // build-api handlers extracted from the controller. Imperative event handlers
2
+ // reading/writing controller state via the `ctx` handle; the reactive core
3
+ // ($state/$derived/$effect) stays in the controller.
4
+ import {
5
+ type RowData,
6
+ type SvGridApi,
7
+ type TableFeatures,
8
+ } from "./index";
9
+ import "./sv-grid-scrollbar";
10
+ import { untrack } from "svelte";
11
+ // The export serializers load lazily (their own chunk) so export-format.ts stays
12
+ // out of the base bundle - it is fetched only when an export/copy method is
13
+ // actually invoked (an explicit, already-async user action).
14
+ import type {
15
+ GridExportColumn,
16
+ GridExportScope,
17
+ GridExportOptions,
18
+ GridClipboardOptions,
19
+ } from "./export-format";
20
+ import type {
21
+ FilterOperator,
22
+ } from "./SvGrid.types";
23
+ import {
24
+ isGroupRow,
25
+ getColumnAlign,
26
+ columnDefMatchesId,
27
+ } from "./cell-values";
28
+ import { hasAdvancedFilterEngine } from "./advanced-filter.svelte";
29
+
30
+ export function createGridApi<
31
+ TFeatures extends TableFeatures = TableFeatures,
32
+ TData extends RowData = RowData,
33
+ >(ctx: any) {
34
+ function buildApi(): SvGridApi<TFeatures, TData> {
35
+ const findColumn = (columnId: string) =>
36
+ ctx.grid.getAllColumns().find((column: any) => column.id === columnId);
37
+
38
+ // --- Free data export (CSV / TSV / JSON + clipboard) helpers ----------
39
+ // Snapshot the VISIBLE columns (field + label + format + align) so the
40
+ // exporter reproduces on-screen values. Mirrors getColumns()'s visible set.
41
+ const exportColumns = (): GridExportColumn[] =>
42
+ ctx.allColumns
43
+ .map((c: any) => ({
44
+ field: (c.columnDef as { field?: string }).field as string,
45
+ header:
46
+ typeof c.columnDef.header === "string" ? c.columnDef.header : c.id,
47
+ format: c.columnDef.format,
48
+ align: getColumnAlign(c),
49
+ }))
50
+ .filter((c: GridExportColumn) => !!c.field);
51
+ // Rows for the requested scope: current view / checked / full dataset.
52
+ const exportScopeRows = (scope: GridExportScope): TData[] => {
53
+ if (scope === "all") return ctx.internalData as TData[];
54
+ const out: TData[] = [];
55
+ for (const row of ctx.allRows) {
56
+ if (isGroupRow(row)) continue;
57
+ if (scope === "selected" && !ctx.rowSelectionState[row.id]) continue;
58
+ out.push(row.original as TData);
59
+ }
60
+ return out;
61
+ };
62
+ const projectForExport = async (
63
+ scope: GridExportScope,
64
+ columns: ReadonlyArray<string> | undefined,
65
+ rawValues: boolean | undefined,
66
+ ) => {
67
+ const { projectGridRows } = await import("./export-format");
68
+ return projectGridRows(
69
+ exportScopeRows(scope) as ReadonlyArray<Record<string, unknown>>,
70
+ exportColumns(),
71
+ { columns, rawValues },
72
+ );
73
+ };
74
+
75
+ return {
76
+ getCellValue(rowIndex, columnId) {
77
+ const row = ctx.internalData[rowIndex];
78
+ const column = findColumn(columnId);
79
+ if (!row || !column) return undefined;
80
+ if (column.columnDef.fieldFn)
81
+ return column.columnDef.fieldFn(row);
82
+ if (column.columnDef.field)
83
+ return (row as Record<string, unknown>)[column.columnDef.field];
84
+ return undefined;
85
+ },
86
+ setCellValue(rowIndex, columnId, value) {
87
+ const row = ctx.internalData[rowIndex];
88
+ const column = findColumn(columnId);
89
+ if (!row || !column?.columnDef.field) return;
90
+ const next = ctx.internalData.slice() as Array<TData>;
91
+ next[rowIndex] = { ...row, [column.columnDef.field]: value } as TData;
92
+ ctx.internalData = next;
93
+ },
94
+ startEditing(rowIndex, columnId) {
95
+ return ctx.startEditing(rowIndex, columnId);
96
+ },
97
+ stopEditing(cancel) {
98
+ return ctx.stopEditing(cancel ?? false);
99
+ },
100
+ selectCells(ranges) {
101
+ // Multiple rectangles are supported. Empty array clears everything.
102
+ if (!ranges || ranges.length === 0) {
103
+ ctx.selectionRange = { anchor: null, focus: null };
104
+ ctx.selectionRanges = [];
105
+ return;
106
+ }
107
+ const rowCount = ctx.internalData.length;
108
+ const colCount = ctx.allColumns.length;
109
+ if (rowCount === 0 || colCount === 0) return;
110
+ // Clamp to the visible grid bounds so callers can pass open-ended
111
+ // values like `[0, 0, Infinity, Infinity]` to mean "select all".
112
+ const toRange = ([r1, c1, r2, c2]: readonly [number, number, number, number]) => ({
113
+ anchor: {
114
+ rowIndex: Math.max(0, Math.min(rowCount - 1, Math.min(r1, r2))),
115
+ colIndex: Math.max(0, Math.min(colCount - 1, Math.min(c1, c2))),
116
+ },
117
+ focus: {
118
+ rowIndex: Math.max(0, Math.min(rowCount - 1, Math.max(r1, r2))),
119
+ colIndex: Math.max(0, Math.min(colCount - 1, Math.max(c1, c2))),
120
+ },
121
+ });
122
+ const built = ranges.map(toRange);
123
+ // Last range is the active one; the rest are committed extras.
124
+ ctx.selectionRanges = built.slice(0, -1);
125
+ const active = built[built.length - 1]!;
126
+ ctx.selectionRange = active;
127
+ // Move the active cell to the last range's top-left so keyboard
128
+ // navigation continues from there.
129
+ ctx.setActiveCell(active.anchor.rowIndex, active.anchor.colIndex);
130
+ },
131
+ getSelected() {
132
+ return ctx
133
+ .getSelectionRects()
134
+ .map((r: { minRow: number; minCol: number; maxRow: number; maxCol: number }) =>
135
+ [r.minRow, r.minCol, r.maxRow, r.maxCol] as [number, number, number, number],
136
+ );
137
+ },
138
+ openChart() {
139
+ ctx.chartPanelOpen = true;
140
+ },
141
+ closeChart() {
142
+ ctx.chartPanelOpen = false;
143
+ },
144
+ getChartSpec() {
145
+ return ctx.chartSpec;
146
+ },
147
+ chartRange(ranges) {
148
+ if (ranges && ranges.length) this.selectCells(ranges);
149
+ ctx.chartPanelOpen = true;
150
+ },
151
+ configureChart(config) {
152
+ if (ctx.chartingEnabled) ctx.applyChartConfig(config);
153
+ },
154
+ setChartAiHandler(handler) {
155
+ ctx.chartAiHandler = handler ?? null;
156
+ },
157
+ addRow(row, position = "bottom") {
158
+ this.addRows([row], position);
159
+ },
160
+ addRows(rows, position = "bottom") {
161
+ const next = ctx.internalData.slice() as Array<TData>;
162
+ if (position === "top") next.unshift(...rows);
163
+ else if (position === "bottom") next.push(...rows);
164
+ else if (typeof position === "number")
165
+ next.splice(Math.max(0, Math.min(position, next.length)), 0, ...rows);
166
+ ctx.internalData = next;
167
+ },
168
+ removeRow(rowIndex) {
169
+ this.removeRows([rowIndex]);
170
+ },
171
+ removeRows(rowIndices) {
172
+ const drop = new Set(rowIndices);
173
+ ctx.internalData = ctx.internalData.filter((_: any, i: any) => !drop.has(i));
174
+ },
175
+ applyTransaction(tx) {
176
+ const getId = ctx.props.getRowId;
177
+ let next = ctx.internalData.slice() as Array<TData>;
178
+ let added = 0;
179
+ let updated = 0;
180
+ let removed = 0;
181
+
182
+ if (tx.remove?.length) {
183
+ const removeIds = new Set<string>();
184
+ const removeRefs = new Set<TData>();
185
+ for (const r of tx.remove) {
186
+ if (typeof r === "string") removeIds.add(r);
187
+ else removeRefs.add(r as TData);
188
+ }
189
+ next = next.filter((row, i) => {
190
+ const hit =
191
+ removeRefs.has(row) ||
192
+ (getId ? removeIds.has(getId(row, i)) : false);
193
+ if (hit) removed += 1;
194
+ return !hit;
195
+ });
196
+ }
197
+
198
+ if (tx.update?.length && getId) {
199
+ const byId = new Map<string, TData>();
200
+ for (const u of tx.update) byId.set(getId(u, 0), u);
201
+ next = next.map((row, i) => {
202
+ const u = byId.get(getId(row, i));
203
+ if (u) {
204
+ updated += 1;
205
+ return u;
206
+ }
207
+ return row;
208
+ });
209
+ }
210
+
211
+ if (tx.add?.length) {
212
+ next.push(...(tx.add as Array<TData>));
213
+ added += tx.add.length;
214
+ }
215
+
216
+ ctx.internalData = next;
217
+ return { added, updated, removed };
218
+ },
219
+ addColumn(column, position = "right") {
220
+ this.addColumns([column], position);
221
+ },
222
+ addColumns(columns, position = "right") {
223
+ const next = ctx.internalColumns.slice();
224
+ if (position === "left") next.unshift(...columns);
225
+ else if (position === "right") next.push(...columns);
226
+ else if (typeof position === "number")
227
+ next.splice(
228
+ Math.max(0, Math.min(position, next.length)),
229
+ 0,
230
+ ...columns,
231
+ );
232
+ ctx.internalColumns = next;
233
+ },
234
+ removeColumn(columnId) {
235
+ ctx.internalColumns = ctx.internalColumns.filter(
236
+ (def: any) => !columnDefMatchesId(def, columnId),
237
+ );
238
+ },
239
+ setColumnVisible(columnId, visible) {
240
+ if (visible) {
241
+ const next = { ...ctx.hiddenColumns };
242
+ delete next[columnId];
243
+ ctx.hiddenColumns = next;
244
+ } else {
245
+ ctx.hiddenColumns = { ...ctx.hiddenColumns, [columnId]: true };
246
+ }
247
+ },
248
+ isColumnVisible(columnId) {
249
+ return !ctx.hiddenColumns[columnId];
250
+ },
251
+ setSort(columnId, direction) {
252
+ // Honour the column's `sortable` opt-out. Asking the engine
253
+ // whether the column can sort folds in both the feature toggle
254
+ // AND the per-column flag.
255
+ const col = ctx.allColumns.find((c: any) => c.id === columnId);
256
+ if (col && !col.getCanSort?.()) return;
257
+ const clauses = direction
258
+ ? [{ id: columnId, desc: direction === "desc" }]
259
+ : (ctx.grid.getState().sorting ?? []).filter(
260
+ (entry: { id: string }) => entry.id !== columnId,
261
+ );
262
+ ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: clauses }));
263
+ },
264
+ clearSort() {
265
+ ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: [] }));
266
+ },
267
+ setGroupBy(columnIds) {
268
+ ctx.grid.setGrouping([...columnIds]);
269
+ },
270
+ setOption(key, value) {
271
+ // Runtime prop override. Writes into the controller's `optionOverrides`
272
+ // store, which the effective-props proxy merges over the incoming prop, so
273
+ // the grid re-renders exactly as if the parent had changed that prop.
274
+ // `undefined` clears the override (falls back to the prop). Reassign the
275
+ // whole object for reliable reactivity; `untrack` per the `setFilter` note.
276
+ untrack(() => {
277
+ const next: Record<string, unknown> = { ...ctx.optionOverrides };
278
+ if (value === undefined) delete next[key as string];
279
+ else next[key as string] = value;
280
+ ctx.optionOverrides = next;
281
+ });
282
+ },
283
+ getOption(key) {
284
+ // The effective value: the override if set, otherwise the incoming prop.
285
+ return (ctx.props as Record<string, unknown>)[key as string] as never;
286
+ },
287
+ resetOptions() {
288
+ untrack(() => {
289
+ ctx.optionOverrides = {};
290
+ });
291
+ },
292
+ setFilter(columnId, filter) {
293
+ // `untrack`: these imperative mutators read the same filter state they
294
+ // write (read-modify-write on `filterMenuValues`). When a consumer
295
+ // calls them from inside a reactive `$effect`, that internal read would
296
+ // otherwise be captured as a dependency of the caller's effect, and the
297
+ // write would re-dirty it - an infinite update loop. Untracking the
298
+ // body keeps the API safe to drive from an effect.
299
+ untrack(() => {
300
+ // Honour the column's `filterable` opt-out. Same approach as
301
+ // `setSort` - `getCanFilter()` already combines the feature flag
302
+ // and the per-column field.
303
+ const col = ctx.allColumns.find((c: any) => c.id === columnId);
304
+ if (col && !col.getCanFilter?.()) return;
305
+ if (!filter) {
306
+ this.clearFilter(columnId);
307
+ return;
308
+ }
309
+ ctx.filterMenuValues = {
310
+ ...ctx.filterMenuValues,
311
+ [columnId]: {
312
+ operator: filter.operator,
313
+ value: filter.value ?? "",
314
+ ...(filter.operator === "between"
315
+ ? { valueTo: filter.valueTo ?? "" }
316
+ : {}),
317
+ // Optional second condition + join (multi-condition filtering).
318
+ ...(filter.operator2
319
+ ? {
320
+ operator2: filter.operator2,
321
+ value2: filter.value2 ?? "",
322
+ join: filter.join ?? "AND",
323
+ ...(filter.operator2 === "between"
324
+ ? { valueTo2: filter.valueTo2 ?? "" }
325
+ : {}),
326
+ }
327
+ : {}),
328
+ },
329
+ };
330
+ });
331
+ },
332
+ setFacetFilter(columnId, values) {
333
+ // See `setFilter` for why the read-modify-write is untracked.
334
+ untrack(() => {
335
+ // Empty array OR null both mean "clear this column's facet" -
336
+ // mirrors how the column menu treats unchecking the last value.
337
+ if (!values || values.length === 0) {
338
+ if (ctx.valueFilters[columnId]) {
339
+ const next = { ...ctx.valueFilters };
340
+ delete next[columnId];
341
+ ctx.valueFilters = next;
342
+ }
343
+ return;
344
+ }
345
+ ctx.valueFilters = {
346
+ ...ctx.valueFilters,
347
+ [columnId]: new Set(values),
348
+ };
349
+ });
350
+ },
351
+ clearFilter(columnId) {
352
+ ctx.clearColumnFilter(columnId);
353
+ },
354
+ refreshEditorOptions(columnId) {
355
+ // Async `editorOptions` are cached per column (or per column+row for a
356
+ // per-row source) so opening an editor twice does not refetch. This
357
+ // drops those entries, so the next render re-runs the source - use it
358
+ // when the underlying list changed server-side.
359
+ if (columnId == null) {
360
+ ctx.asyncEditorOptions = {};
361
+ return;
362
+ }
363
+ const next = { ...ctx.asyncEditorOptions };
364
+ for (const key of Object.keys(next)) {
365
+ if (key === columnId || key.startsWith(`${columnId}::`)) delete next[key];
366
+ }
367
+ ctx.asyncEditorOptions = next;
368
+ },
369
+ clearAllFilters() {
370
+ // See `setFilter` for why the read-modify-write is untracked.
371
+ untrack(() => {
372
+ // Wipe every filter surface in one go: column-menu, filter-row, set
373
+ // filters, the global search box, and the advanced filter. This
374
+ // promises "every filter surface", so leaving the advanced one set
375
+ // would strand rows nobody can see a cause for.
376
+ ctx.filterMenuValues = {};
377
+ ctx.filterRowValues = {};
378
+ ctx.valueFilters = {};
379
+ if (ctx.globalFilter !== "") ctx.globalFilter = "";
380
+ if (ctx.advancedFilter !== null) ctx.advancedFilter = null;
381
+ });
382
+ },
383
+ setAdvancedFilter(expr) {
384
+ // See `setFilter` for why the write is untracked.
385
+ untrack(() => {
386
+ ctx.advancedFilter = expr ?? null;
387
+ });
388
+ },
389
+ getAdvancedFilter() {
390
+ return ctx.advancedFilter ?? null;
391
+ },
392
+ clearAdvancedFilter() {
393
+ untrack(() => {
394
+ ctx.advancedFilter = null;
395
+ });
396
+ },
397
+ isAdvancedFilterActive() {
398
+ return ctx.advancedFilter != null && hasAdvancedFilterEngine();
399
+ },
400
+ getFilters() {
401
+ // Return a defensive copy so callers can't mutate internal state.
402
+ const out: Record<
403
+ string,
404
+ { operator: FilterOperator; value: string; valueTo?: string }
405
+ > = {};
406
+ for (const [columnId, filter] of Object.entries(ctx.filterMenuValues as Record<string, { operator: FilterOperator; value: string; valueTo?: string }>)) {
407
+ out[columnId] = {
408
+ operator: filter.operator,
409
+ value: filter.value,
410
+ ...(filter.operator === "between" && filter.valueTo
411
+ ? { valueTo: filter.valueTo }
412
+ : {}),
413
+ };
414
+ }
415
+ return out;
416
+ },
417
+ getDisplayedRows() {
418
+ // `allRows` is the final, post-filter, post-sort, post-group,
419
+ // post-pagination list - exactly what the body renders. Skip group
420
+ // header rows (they wrap an aggregate, not a TData row).
421
+ //
422
+ // `isGroupRow` rather than a `subRows.length` test: a TREE parent also
423
+ // has subRows, but it is a real data row that renders its own cells, so
424
+ // dropping it here silently truncated every tree read - including the
425
+ // enterprise export, whose default row source is this method.
426
+ const out: TData[] = [];
427
+ for (const row of ctx.allRows) {
428
+ if (isGroupRow(row)) continue;
429
+ out.push(row.original as TData);
430
+ }
431
+ return out;
432
+ },
433
+ getData() {
434
+ return ctx.internalData;
435
+ },
436
+ getColumns() {
437
+ // Snapshot every column with its human-readable label and
438
+ // visibility flag. Used by external code (exporters, column
439
+ // pickers) so they don't have to re-walk the columnDef tree.
440
+ // Hidden columns ARE included (with `visible: false`) so a column
441
+ // picker can re-enable them - callers that only want what's
442
+ // rendered filter by `.visible` (e.g. the exporter does).
443
+ const describe = (c: any, visible: boolean) => ({
444
+ id: c.id,
445
+ field: (c.columnDef as { field?: string }).field,
446
+ header:
447
+ typeof c.columnDef.header === "string"
448
+ ? c.columnDef.header
449
+ : c.id,
450
+ visible,
451
+ // Surface the format + alignment so exporters can reproduce the
452
+ // on-screen display value (currency symbol, date pattern, etc.)
453
+ // instead of dumping raw values. `getColumnAlign` applies the same
454
+ // editorType-based default the body uses.
455
+ format: c.columnDef.format,
456
+ align: getColumnAlign(c),
457
+ // The column's declared value type. Lets a filter or expression UI
458
+ // offer the right operators (numeric ranges vs text matching) without
459
+ // re-walking the columnDef tree.
460
+ editorType: (c.columnDef as { editorType?: string }).editorType,
461
+ });
462
+ // Visible columns first, in their current visual order...
463
+ const out = ctx.allColumns.map((c: any) => describe(c, true));
464
+ // ...then any column hidden via `visible: false` / setColumnVisible.
465
+ // Those aren't in `allColumns` (that list is visible-only), so pull
466
+ // them straight from the engine's leaf set.
467
+ const visibleIds = new Set(out.map((c: { id: string }) => c.id));
468
+ for (const c of ctx.grid.getAllColumns() as any[]) {
469
+ if (!visibleIds.has(c.id)) out.push(describe(c, false));
470
+ }
471
+ return out;
472
+ },
473
+ // ---- Free data export (CSV / TSV / JSON + clipboard) -----------------
474
+ async exportCsv(options: GridExportOptions = {}) {
475
+ const { serializeDelimited, downloadTextFile } = await import("./export-format");
476
+ const { records, fields } = await projectForExport(
477
+ options.rows ?? "displayed",
478
+ options.columns,
479
+ options.rawValues,
480
+ );
481
+ const text = await serializeDelimited(records, fields, {
482
+ csv: { delimiter: ",", bom: options.bom ?? true },
483
+ signal: options.signal,
484
+ onProgress: options.onProgress,
485
+ });
486
+ if (options.download !== false)
487
+ downloadTextFile(text, `${options.filename ?? "grid"}.csv`, "text/csv;charset=utf-8");
488
+ return text;
489
+ },
490
+ async exportTsv(options: GridExportOptions = {}) {
491
+ const { serializeDelimited, downloadTextFile } = await import("./export-format");
492
+ const { records, fields } = await projectForExport(
493
+ options.rows ?? "displayed",
494
+ options.columns,
495
+ options.rawValues,
496
+ );
497
+ const text = await serializeDelimited(records, fields, {
498
+ csv: { delimiter: "\t", bom: options.bom ?? true },
499
+ signal: options.signal,
500
+ onProgress: options.onProgress,
501
+ });
502
+ if (options.download !== false)
503
+ downloadTextFile(text, `${options.filename ?? "grid"}.tsv`, "text/tab-separated-values;charset=utf-8");
504
+ return text;
505
+ },
506
+ async exportJson(options: GridExportOptions = {}) {
507
+ const { serializeJson, downloadTextFile } = await import("./export-format");
508
+ const { records, fields } = await projectForExport(
509
+ options.rows ?? "displayed",
510
+ options.columns,
511
+ options.rawValues,
512
+ );
513
+ const text = await serializeJson(records, fields, {
514
+ signal: options.signal,
515
+ onProgress: options.onProgress,
516
+ });
517
+ if (options.download !== false)
518
+ downloadTextFile(text, `${options.filename ?? "grid"}.json`, "application/json");
519
+ return text;
520
+ },
521
+ async copyToClipboard(options: GridClipboardOptions = {}) {
522
+ const { serializeDelimited, serializeMarkdown, copyTextToClipboard } = await import("./export-format");
523
+ const { records, fields, align } = await projectForExport(
524
+ options.rows ?? "displayed",
525
+ options.columns,
526
+ options.rawValues,
527
+ );
528
+ const format = options.format ?? "tsv";
529
+ const text =
530
+ format === "markdown"
531
+ ? await serializeMarkdown(records, fields, { align })
532
+ : await serializeDelimited(records, fields, {
533
+ csv: { delimiter: format === "csv" ? "," : "\t", bom: false },
534
+ });
535
+ await copyTextToClipboard(text);
536
+ return text;
537
+ },
538
+ clearRowSelection() {
539
+ // Wipe the internal selection map AND emit the change so any
540
+ // consumer holding a derived `selectedRows` resets too.
541
+ ctx.grid.setRowSelection(() => ({}));
542
+ ctx.props.onRowSelectionChange?.({}, []);
543
+ },
544
+ setColumnWidth(columnId: string, width: number) {
545
+ const clamped = Math.max(ctx.MIN_COLUMN_WIDTH, Math.floor(width));
546
+ ctx.columnWidths = { ...ctx.columnWidths, [columnId]: clamped };
547
+ },
548
+ getColumnWidths() {
549
+ // Resolve every column's effective width by consulting both the
550
+ // resize overrides (`columnWidths`) AND the columnDef defaults,
551
+ // so the snapshot is round-trippable through setColumnWidth.
552
+ const out: Record<string, number> = {};
553
+ for (const c of ctx.allColumns) out[c.id] = ctx.getColumnWidth(c.id);
554
+ return out;
555
+ },
556
+ autosizeColumn(columnId: string) {
557
+ ctx.autosizeColumn(columnId);
558
+ },
559
+ autosizeAllColumns() {
560
+ ctx.autosizeAllColumns();
561
+ },
562
+ setColumnPinning(pinning) {
563
+ // Defensive copy + dedupe so callers can't mutate our state.
564
+ const left = Array.from(new Set(pinning.left ?? []));
565
+ const right = Array.from(new Set(pinning.right ?? []));
566
+ ctx.columnPinning = { left, right };
567
+ },
568
+ getColumnPinning() {
569
+ return {
570
+ left: ctx.columnPinning.left.slice(),
571
+ right: ctx.columnPinning.right.slice(),
572
+ };
573
+ },
574
+ // ---- Column reorder
575
+ setColumnOrder(order) {
576
+ ctx.setColumnOrderInternal(order);
577
+ },
578
+ getColumnOrder() {
579
+ return ctx.getCurrentColumnOrder();
580
+ },
581
+ setRowExpanded(id, expanded) {
582
+ ctx.grid.setExpanded((prev: any) => ({ ...prev, [id]: !!expanded }));
583
+ },
584
+ expandAllGroups() {
585
+ // Walk the current grouped row model and flip every group node on.
586
+ const next: Record<string, boolean> = {};
587
+ const walk = (rows: ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>) => {
588
+ for (const row of rows) {
589
+ if (row.getCanExpand?.()) next[row.id] = true;
590
+ const sub = row.subRows as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }> | undefined;
591
+ if (sub && sub.length > 0) walk(sub);
592
+ }
593
+ };
594
+ walk(ctx.grid.getRowModel().rows as unknown as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>);
595
+ ctx.grid.setExpanded(() => next);
596
+ },
597
+ collapseAllGroups() {
598
+ ctx.grid.setExpanded(() => ({}));
599
+ },
600
+ // ---- Undo / redo (history + pointer)
601
+ undo() {
602
+ if (ctx.historyPtr < 0) return false
603
+ const step = ctx.history[ctx.historyPtr]
604
+ if (!step) return false
605
+ ctx.applyHistoryStep(step, 'undo')
606
+ ctx.historyPtr -= 1
607
+ ctx.historyVersion += 1
608
+ return true
609
+ },
610
+ redo() {
611
+ if (ctx.historyPtr >= ctx.history.length - 1) return false
612
+ const step = ctx.history[ctx.historyPtr + 1]
613
+ if (!step) return false
614
+ ctx.applyHistoryStep(step, 'redo')
615
+ ctx.historyPtr += 1
616
+ ctx.historyVersion += 1
617
+ return true
618
+ },
619
+ canUndo() { void ctx.historyVersion; return ctx.historyPtr >= 0 },
620
+ canRedo() { void ctx.historyVersion; return ctx.historyPtr < ctx.history.length - 1 },
621
+ clearHistory() { ctx.history = []; ctx.historyPtr = -1; ctx.historyVersion += 1 },
622
+ // ---- Find
623
+ openFind() { ctx.findOpen = true },
624
+ closeFind() { ctx.findOpen = false; ctx.findQuery = '' },
625
+ setFindQuery(q: string) { ctx.findQuery = q; ctx.findHitIndex = 0 },
626
+ getFindHits() { return ctx.findHits.slice() },
627
+ // ---- Row selection (read + write)
628
+ getSelectedRows() {
629
+ const out: TData[] = [];
630
+ for (const row of ctx.allRows) {
631
+ if (isGroupRow(row)) continue;
632
+ if (ctx.rowSelectionState[row.id]) out.push(row.original as TData);
633
+ }
634
+ return out;
635
+ },
636
+ getSelectedRowIds() {
637
+ const out: string[] = [];
638
+ for (const row of ctx.allRows) {
639
+ if (!isGroupRow(row) && ctx.rowSelectionState[row.id]) out.push(row.id);
640
+ }
641
+ return out;
642
+ },
643
+ selectRows(ids, additive = false) {
644
+ const set = new Set(ids);
645
+ ctx.grid.setRowSelection((prev: any) => {
646
+ const next: Record<string, boolean> = additive ? { ...prev } : {};
647
+ for (const id of set) next[id] = true;
648
+ return next;
649
+ });
650
+ },
651
+ selectAllRows() {
652
+ const next: Record<string, boolean> = {};
653
+ for (const row of ctx.allRows) if (!isGroupRow(row)) next[row.id] = true;
654
+ ctx.grid.setRowSelection(() => next);
655
+ },
656
+ toggleRowSelected(id) {
657
+ ctx.toggleRowSelectionById(id);
658
+ },
659
+ // ---- Pagination
660
+ getPageInfo() {
661
+ const { pageIndex, pageSize } = ctx.paginationState;
662
+ const total = ctx.allRowsBeforePagination.length;
663
+ const pageCount = Math.max(1, Math.ceil(total / Math.max(1, pageSize)));
664
+ return { pageIndex, pageSize, pageCount, total };
665
+ },
666
+ setPage(pageIndex) {
667
+ const total = ctx.allRowsBeforePagination.length;
668
+ const pageCount = Math.max(
669
+ 1,
670
+ Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
671
+ );
672
+ ctx.goToPage(Math.max(0, Math.min(pageIndex, pageCount - 1)));
673
+ },
674
+ nextPage() {
675
+ this.setPage(ctx.paginationState.pageIndex + 1);
676
+ },
677
+ prevPage() {
678
+ this.setPage(ctx.paginationState.pageIndex - 1);
679
+ },
680
+ firstPage() {
681
+ this.setPage(0);
682
+ },
683
+ lastPage() {
684
+ const total = ctx.allRowsBeforePagination.length;
685
+ const pageCount = Math.max(
686
+ 1,
687
+ Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
688
+ );
689
+ this.setPage(pageCount - 1);
690
+ },
691
+ setPageSize(size) {
692
+ // Calls the component-level helper (lexical scope), not this method.
693
+ ctx.setPageSize(Math.max(1, Math.floor(size)));
694
+ },
695
+ // ---- Navigation / scrolling
696
+ scrollToRow(rowIndex) {
697
+ if (!ctx.scrollContainer) return;
698
+ const maxIndex = Math.max(0, ctx.allRows.length - 1);
699
+ const clamped = Math.max(0, Math.min(rowIndex, maxIndex));
700
+ // Logical offset from the virtualizer (honors uniform OR per-row
701
+ // sizing), then mapped into the capped DOM scroll space so it lands
702
+ // correctly on huge grids where the DOM height is scaled down.
703
+ const logical = ctx.virtualizer.getOffsetForIndex(clamped);
704
+ ctx.scrollContainer.scrollTop = ctx.logicalToDomRowOffset(logical);
705
+ ctx.scheduleScrollSync(
706
+ ctx.scrollContainer.scrollTop,
707
+ ctx.scrollContainer.scrollLeft,
708
+ );
709
+ },
710
+ getActiveCell() {
711
+ const a = ctx.activeCell;
712
+ if (!a || a.rowIndex < 0 || a.colIndex < 0) return null;
713
+ const col = ctx.allColumns[a.colIndex];
714
+ return {
715
+ rowIndex: a.rowIndex,
716
+ colIndex: a.colIndex,
717
+ columnId: col?.id ?? "",
718
+ };
719
+ },
720
+ setActiveCell(rowIndex, colIndex) {
721
+ const r = Math.max(0, Math.min(rowIndex, Math.max(0, ctx.allRows.length - 1)));
722
+ const c = Math.max(
723
+ 0,
724
+ Math.min(colIndex, Math.max(0, ctx.allColumns.length - 1)),
725
+ );
726
+ // Calls the component-level helper (lexical scope), not this method.
727
+ ctx.setActiveCell(r, c);
728
+ },
729
+ // ---- View state (save / restore)
730
+ getState() {
731
+ return {
732
+ sorting: (ctx.grid.getState().sorting ?? []).map(
733
+ (s: { id: string; desc: boolean }) => ({ id: s.id, desc: s.desc }),
734
+ ),
735
+ grouping: [...(ctx.grid.getState().grouping ?? [])],
736
+ pagination: {
737
+ pageIndex: ctx.paginationState.pageIndex,
738
+ pageSize: ctx.paginationState.pageSize,
739
+ },
740
+ columnWidths: this.getColumnWidths(),
741
+ columnPinning: this.getColumnPinning(),
742
+ columnOrder: ctx.getCurrentColumnOrder(),
743
+ hiddenColumns: Object.keys(ctx.hiddenColumns).filter(
744
+ (k) => ctx.hiddenColumns[k],
745
+ ),
746
+ globalFilter: ctx.globalFilter,
747
+ columnFilters: this.getFilters(),
748
+ facetFilters: Object.fromEntries(
749
+ Object.entries(ctx.valueFilters).map(([k, set]: [string, any]) => [
750
+ k,
751
+ Array.from(set),
752
+ ]),
753
+ ),
754
+ // Emitted only when set. `attachAutoSavedView` diffs
755
+ // JSON.stringify(getState()) on a timer, so adding an always-present
756
+ // key would change every existing snapshot and force one spurious
757
+ // save in every app on upgrade.
758
+ ...(ctx.advancedFilter ? { advancedFilter: ctx.advancedFilter } : {}),
759
+ ...(ctx.chartingEnabled
760
+ ? {
761
+ chart: {
762
+ open: ctx.chartPanelOpen,
763
+ type: ctx.chartType,
764
+ dimension: ctx.chartDimensionId,
765
+ series: ctx.chartSeriesId,
766
+ measure: ctx.chartMeasureId,
767
+ reduce: ctx.chartReduce,
768
+ stacked: ctx.chartStacked,
769
+ },
770
+ charts: ctx.getChartsState(),
771
+ chartActive: ctx.activeChartIndex,
772
+ }
773
+ : {}),
774
+ };
775
+ },
776
+ setState(state) {
777
+ if (state.sorting) {
778
+ const sorting = state.sorting.map((s) => ({ id: s.id, desc: s.desc }));
779
+ ctx.grid.store.setState((prev: any) => ({ ...prev, sorting }));
780
+ }
781
+ if (state.grouping) {
782
+ // Drop grouping by columns that no longer exist (#53) - otherwise a
783
+ // saved view collapses every row into a group named 'undefined'.
784
+ const existing = new Set((ctx.grid.getAllColumns() as any[]).map((c) => c.id));
785
+ ctx.grid.setGrouping(state.grouping.filter((id: string) => existing.has(id)));
786
+ }
787
+ if (state.pagination) {
788
+ const p = state.pagination;
789
+ ctx.grid.setPagination((prev: any) => ({ ...prev, ...p }));
790
+ }
791
+ if (state.columnWidths) ctx.columnWidths = { ...state.columnWidths };
792
+ if (state.columnPinning)
793
+ ctx.columnPinning = {
794
+ left: [...(state.columnPinning.left ?? [])],
795
+ right: [...(state.columnPinning.right ?? [])],
796
+ };
797
+ if (state.columnOrder) ctx.setColumnOrderInternal(state.columnOrder);
798
+ if (state.hiddenColumns) {
799
+ // Seed from columns declared `visible: false` so a partial/empty saved
800
+ // state never un-hides an app-declared-hidden column (#54); then layer
801
+ // the saved user-driven hides on top.
802
+ const next: Record<string, boolean> = { ...ctx.declaredHiddenColumns };
803
+ for (const id of state.hiddenColumns) next[id] = true;
804
+ ctx.hiddenColumns = next;
805
+ }
806
+ if (state.globalFilter !== undefined) ctx.globalFilter = state.globalFilter;
807
+ if (state.columnFilters)
808
+ ctx.filterMenuValues = { ...state.columnFilters };
809
+ if (state.facetFilters) {
810
+ const next: Record<string, Set<string>> = {};
811
+ for (const [k, arr] of Object.entries(state.facetFilters))
812
+ next[k] = new Set(arr);
813
+ ctx.valueFilters = next;
814
+ }
815
+ // `in` rather than a truthiness check, so an explicit null clears while
816
+ // an absent key leaves the current filter alone (the documented
817
+ // "only the keys present are applied" contract).
818
+ if ("advancedFilter" in state) {
819
+ ctx.advancedFilter = state.advancedFilter ?? null;
820
+ }
821
+ if ((state.chart || state.charts) && ctx.chartingEnabled) {
822
+ if (Array.isArray(state.charts) && state.charts.length) {
823
+ ctx.applyChartsState(state.charts, state.chartActive);
824
+ }
825
+ if (state.chart) {
826
+ const c = state.chart;
827
+ ctx.chartPanelOpen = c.open;
828
+ ctx.chartType = c.type;
829
+ ctx.chartDimensionId = c.dimension;
830
+ ctx.chartSeriesId = c.series;
831
+ ctx.chartMeasureId = c.measure;
832
+ ctx.chartReduce = c.reduce;
833
+ ctx.chartStacked = c.stacked;
834
+ }
835
+ }
836
+ },
837
+ refresh() {
838
+ ctx.grid.store.setState((prev: any) => ({ ...prev }));
839
+ },
840
+ };
841
+ }
842
+
843
+ return {
844
+ buildApi,
845
+ };
846
+ }