@svgrid/grid 2.2.26 → 2.2.27

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