@svgrid/grid 2.1.0 → 2.1.1

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 (64) hide show
  1. package/dist/FlexRender.svelte +96 -96
  2. package/dist/GridFooter.svelte +178 -178
  3. package/dist/SvGrid.css +2377 -2377
  4. package/dist/SvGrid.svelte +2764 -2764
  5. package/dist/SvGridBoard.svelte +2281 -2281
  6. package/dist/SvGridDropdown.svelte +666 -666
  7. package/dist/cdn/svgrid.js +2 -2
  8. package/dist/cdn/svgrid.svelte-external.js +2 -2
  9. package/package.json +92 -92
  10. package/src/FlexRender.svelte +96 -96
  11. package/src/GridFooter.svelte +178 -178
  12. package/src/SvGrid.controller.svelte.ts +2553 -2553
  13. package/src/SvGrid.css +2377 -2377
  14. package/src/SvGrid.svelte +2764 -2764
  15. package/src/SvGrid.types.ts +944 -944
  16. package/src/SvGridBoard.svelte +2281 -2281
  17. package/src/SvGridDropdown.svelte +666 -666
  18. package/src/a11y.contract.test.ts +49 -49
  19. package/src/a11y.test.ts +59 -59
  20. package/src/a11y.ts +61 -61
  21. package/src/build-api.ts +798 -798
  22. package/src/cell-formatting.ts +169 -169
  23. package/src/cell-render.ts +469 -469
  24. package/src/collaboration.test.ts +104 -104
  25. package/src/collaboration.ts +167 -167
  26. package/src/core.performance.test.ts +30 -30
  27. package/src/core.ts +1111 -1111
  28. package/src/createGrid.svelte.ts +42 -42
  29. package/src/createGrid.test.ts +10 -10
  30. package/src/createGridState.svelte.ts +17 -17
  31. package/src/editing.test.ts +859 -859
  32. package/src/editing.ts +675 -675
  33. package/src/export-data-api.test.ts +126 -126
  34. package/src/export-format.test.ts +107 -107
  35. package/src/export-format.ts +598 -598
  36. package/src/flex-render.ts +3 -3
  37. package/src/index.ts +463 -463
  38. package/src/keyboard.test.ts +59 -59
  39. package/src/keyboard.ts +97 -97
  40. package/src/menus.ts +582 -582
  41. package/src/merge-objects.ts +48 -48
  42. package/src/render-component.ts +28 -28
  43. package/src/selection.test.ts +754 -754
  44. package/src/selection.ts +600 -600
  45. package/src/server-data-source.test.ts +289 -289
  46. package/src/server-data-source.ts +413 -413
  47. package/src/sparkline.test.ts +68 -68
  48. package/src/sparkline.ts +169 -169
  49. package/src/spreadsheet.test.ts +489 -489
  50. package/src/spreadsheet.ts +304 -304
  51. package/src/static-functions.ts +11 -11
  52. package/src/subscribe.ts +38 -38
  53. package/src/svgrid-wrapper.types.ts +439 -439
  54. package/src/svgrid.behavior.test.ts +706 -706
  55. package/src/svgrid.features.test.ts +157 -157
  56. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  57. package/src/svgrid.wrapper.test.ts +40 -40
  58. package/src/themes/index.ts +159 -159
  59. package/src/virtualization/column-virtualizer.test.ts +27 -27
  60. package/src/virtualization/column-virtualizer.ts +30 -30
  61. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  62. package/src/virtualization/types.ts +30 -30
  63. package/src/virtualization/virtualizer.test.ts +47 -47
  64. package/src/virtualization/virtualizer.ts +296 -296
package/src/build-api.ts CHANGED
@@ -1,798 +1,798 @@
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 type { Snippet } from "svelte";
44
- import { getKeyboardIntent, getNextActiveCell } from "./keyboard";
45
- import {
46
- formatNumericWithConfig,
47
- getDateFormatter,
48
- resolveDatePattern,
49
- } from "./cell-formatting";
50
- import {
51
- projectGridRows,
52
- serializeDelimited,
53
- serializeJson,
54
- serializeMarkdown,
55
- downloadTextFile,
56
- copyTextToClipboard,
57
- type GridExportColumn,
58
- type GridExportScope,
59
- type GridExportOptions,
60
- type GridClipboardOptions,
61
- } from "./export-format";
62
- import {
63
- RenderSnippetConfig,
64
- RenderComponentConfig,
65
- } from "./render-component";
66
- import { buildFillPattern } from "./fill-patterns";
67
- import { buildSparkline, toSparklineValues } from "./sparkline";
68
- import {
69
- resolveCellFormat,
70
- computeColumnStat,
71
- formatsNeedingStats,
72
- type ColumnStat,
73
- type ResolvedCellFormat,
74
- } from "./conditional-formatting";
75
- import SvGridDropdown from "./SvGridDropdown.svelte";
76
- import type {
77
- Props,
78
- SelectionPoint,
79
- SelectionRange,
80
- CellEditState,
81
- FilterOperator,
82
- FilterOption,
83
- MenuPosition,
84
- } from "./SvGrid.types";
85
- import {
86
- cfTextStyle,
87
- fmtStat,
88
- getCellKey,
89
- resolveClassList,
90
- toDateInputValue,
91
- toDateTimeLocalInputValue,
92
- getEditableInputValue,
93
- getEditorInputType,
94
- toValueArray,
95
- getOptionLabel,
96
- getOptionColor,
97
- colorfulChipStyle,
98
- getEditorClass,
99
- asDate,
100
- clampMenuX,
101
- cssEscape,
102
- rawToNumber,
103
- formatFacetNumber,
104
- formatFacetDate,
105
- } from "./SvGrid.helpers";
106
- import { createClipboard } from "./clipboard";
107
- import {
108
- filterOperatorOptions,
109
- fallbackOperatorOption,
110
- TEXT_OPERATORS,
111
- NUMBER_OPERATORS,
112
- DATE_OPERATORS,
113
- CHECKBOX_OPERATORS,
114
- operatorOption,
115
- operatorsForColumn,
116
- defaultOperatorFor,
117
- operatorLabelFor,
118
- } from "./filter-operators";
119
- import {
120
- type FacetBucket,
121
- isBucketableColumn,
122
- buildBuckets,
123
- isInBucket,
124
- } from "./facet-buckets";
125
- import {
126
- getColumnBaseValue,
127
- isGroupRow,
128
- toolPanelHeaderLabel,
129
- formatSummaryNumeric,
130
- getColumnAlign,
131
- getPinnedCellValue,
132
- getColumnAccessorValue,
133
- columnDefMatchesId,
134
- } from "./cell-values";
135
-
136
- export function createGridApi<
137
- TFeatures extends TableFeatures = TableFeatures,
138
- TData extends RowData = RowData,
139
- >(ctx: any) {
140
- function buildApi(): SvGridApi<TFeatures, TData> {
141
- const findColumn = (columnId: string) =>
142
- ctx.grid.getAllColumns().find((column: any) => column.id === columnId);
143
-
144
- // --- Free data export (CSV / TSV / JSON + clipboard) helpers ----------
145
- // Snapshot the VISIBLE columns (field + label + format + align) so the
146
- // exporter reproduces on-screen values. Mirrors getColumns()'s visible set.
147
- const exportColumns = (): GridExportColumn[] =>
148
- ctx.allColumns
149
- .map((c: any) => ({
150
- field: (c.columnDef as { field?: string }).field as string,
151
- header:
152
- typeof c.columnDef.header === "string" ? c.columnDef.header : c.id,
153
- format: c.columnDef.format,
154
- align: getColumnAlign(c),
155
- }))
156
- .filter((c: GridExportColumn) => !!c.field);
157
- // Rows for the requested scope: current view / checked / full dataset.
158
- const exportScopeRows = (scope: GridExportScope): TData[] => {
159
- if (scope === "all") return ctx.internalData as TData[];
160
- const out: TData[] = [];
161
- for (const row of ctx.allRows) {
162
- if (isGroupRow(row)) continue;
163
- if (scope === "selected" && !ctx.rowSelectionState[row.id]) continue;
164
- out.push(row.original as TData);
165
- }
166
- return out;
167
- };
168
- const projectForExport = (
169
- scope: GridExportScope,
170
- columns: ReadonlyArray<string> | undefined,
171
- rawValues: boolean | undefined,
172
- ) =>
173
- projectGridRows(
174
- exportScopeRows(scope) as ReadonlyArray<Record<string, unknown>>,
175
- exportColumns(),
176
- { columns, rawValues },
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
- addRow(row, position = "bottom") {
243
- this.addRows([row], position);
244
- },
245
- addRows(rows, position = "bottom") {
246
- const next = ctx.internalData.slice() as Array<TData>;
247
- if (position === "top") next.unshift(...rows);
248
- else if (position === "bottom") next.push(...rows);
249
- else if (typeof position === "number")
250
- next.splice(Math.max(0, Math.min(position, next.length)), 0, ...rows);
251
- ctx.internalData = next;
252
- },
253
- removeRow(rowIndex) {
254
- this.removeRows([rowIndex]);
255
- },
256
- removeRows(rowIndices) {
257
- const drop = new Set(rowIndices);
258
- ctx.internalData = ctx.internalData.filter((_: any, i: any) => !drop.has(i));
259
- },
260
- applyTransaction(tx) {
261
- const getId = ctx.props.getRowId;
262
- let next = ctx.internalData.slice() as Array<TData>;
263
- let added = 0;
264
- let updated = 0;
265
- let removed = 0;
266
-
267
- if (tx.remove?.length) {
268
- const removeIds = new Set<string>();
269
- const removeRefs = new Set<TData>();
270
- for (const r of tx.remove) {
271
- if (typeof r === "string") removeIds.add(r);
272
- else removeRefs.add(r as TData);
273
- }
274
- next = next.filter((row, i) => {
275
- const hit =
276
- removeRefs.has(row) ||
277
- (getId ? removeIds.has(getId(row, i)) : false);
278
- if (hit) removed += 1;
279
- return !hit;
280
- });
281
- }
282
-
283
- if (tx.update?.length && getId) {
284
- const byId = new Map<string, TData>();
285
- for (const u of tx.update) byId.set(getId(u, 0), u);
286
- next = next.map((row, i) => {
287
- const u = byId.get(getId(row, i));
288
- if (u) {
289
- updated += 1;
290
- return u;
291
- }
292
- return row;
293
- });
294
- }
295
-
296
- if (tx.add?.length) {
297
- next.push(...(tx.add as Array<TData>));
298
- added += tx.add.length;
299
- }
300
-
301
- ctx.internalData = next;
302
- return { added, updated, removed };
303
- },
304
- addColumn(column, position = "right") {
305
- this.addColumns([column], position);
306
- },
307
- addColumns(columns, position = "right") {
308
- const next = ctx.internalColumns.slice();
309
- if (position === "left") next.unshift(...columns);
310
- else if (position === "right") next.push(...columns);
311
- else if (typeof position === "number")
312
- next.splice(
313
- Math.max(0, Math.min(position, next.length)),
314
- 0,
315
- ...columns,
316
- );
317
- ctx.internalColumns = next;
318
- },
319
- removeColumn(columnId) {
320
- ctx.internalColumns = ctx.internalColumns.filter(
321
- (def: any) => !columnDefMatchesId(def, columnId),
322
- );
323
- },
324
- setColumnVisible(columnId, visible) {
325
- if (visible) {
326
- const next = { ...ctx.hiddenColumns };
327
- delete next[columnId];
328
- ctx.hiddenColumns = next;
329
- } else {
330
- ctx.hiddenColumns = { ...ctx.hiddenColumns, [columnId]: true };
331
- }
332
- },
333
- isColumnVisible(columnId) {
334
- return !ctx.hiddenColumns[columnId];
335
- },
336
- setSort(columnId, direction) {
337
- // Honour the column's `sortable` opt-out. Asking the engine
338
- // whether the column can sort folds in both the feature toggle
339
- // AND the per-column flag.
340
- const col = ctx.allColumns.find((c: any) => c.id === columnId);
341
- if (col && !col.getCanSort?.()) return;
342
- const clauses = direction
343
- ? [{ id: columnId, desc: direction === "desc" }]
344
- : (ctx.grid.getState().sorting ?? []).filter(
345
- (entry: { id: string }) => entry.id !== columnId,
346
- );
347
- ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: clauses }));
348
- },
349
- clearSort() {
350
- ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: [] }));
351
- },
352
- setGroupBy(columnIds) {
353
- ctx.grid.setGrouping([...columnIds]);
354
- },
355
- setFilter(columnId, filter) {
356
- // Honour the column's `filterable` opt-out. Same approach as
357
- // `setSort` - `getCanFilter()` already combines the feature flag
358
- // and the per-column field.
359
- const col = ctx.allColumns.find((c: any) => c.id === columnId);
360
- if (col && !col.getCanFilter?.()) return;
361
- if (!filter) {
362
- this.clearFilter(columnId);
363
- return;
364
- }
365
- ctx.filterMenuValues = {
366
- ...ctx.filterMenuValues,
367
- [columnId]: {
368
- operator: filter.operator,
369
- value: filter.value ?? "",
370
- ...(filter.operator === "between"
371
- ? { valueTo: filter.valueTo ?? "" }
372
- : {}),
373
- // Optional second condition + join (multi-condition filtering).
374
- ...(filter.operator2
375
- ? {
376
- operator2: filter.operator2,
377
- value2: filter.value2 ?? "",
378
- join: filter.join ?? "AND",
379
- ...(filter.operator2 === "between"
380
- ? { valueTo2: filter.valueTo2 ?? "" }
381
- : {}),
382
- }
383
- : {}),
384
- },
385
- };
386
- },
387
- setFacetFilter(columnId, values) {
388
- // Empty array OR null both mean "clear this column's facet" -
389
- // mirrors how the column menu treats unchecking the last value.
390
- if (!values || values.length === 0) {
391
- if (ctx.valueFilters[columnId]) {
392
- const next = { ...ctx.valueFilters };
393
- delete next[columnId];
394
- ctx.valueFilters = next;
395
- }
396
- return;
397
- }
398
- ctx.valueFilters = {
399
- ...ctx.valueFilters,
400
- [columnId]: new Set(values),
401
- };
402
- },
403
- clearFilter(columnId) {
404
- ctx.clearColumnFilter(columnId);
405
- },
406
- clearAllFilters() {
407
- // Wipe every filter surface in one go: column-menu, filter-row, set
408
- // filters, and the global search box.
409
- ctx.filterMenuValues = {};
410
- ctx.filterRowValues = {};
411
- ctx.valueFilters = {};
412
- if (ctx.globalFilter !== "") ctx.globalFilter = "";
413
- },
414
- getFilters() {
415
- // Return a defensive copy so callers can't mutate internal state.
416
- const out: Record<
417
- string,
418
- { operator: FilterOperator; value: string; valueTo?: string }
419
- > = {};
420
- for (const [columnId, filter] of Object.entries(ctx.filterMenuValues as Record<string, { operator: FilterOperator; value: string; valueTo?: string }>)) {
421
- out[columnId] = {
422
- operator: filter.operator,
423
- value: filter.value,
424
- ...(filter.operator === "between" && filter.valueTo
425
- ? { valueTo: filter.valueTo }
426
- : {}),
427
- };
428
- }
429
- return out;
430
- },
431
- getDisplayedRows() {
432
- // `allRows` is the final, post-filter, post-sort, post-group,
433
- // post-pagination list - exactly what the body renders. Skip group
434
- // header rows (they wrap an aggregate, not a TData row).
435
- const out: TData[] = [];
436
- for (const row of ctx.allRows) {
437
- if (row.subRows && row.subRows.length > 0) continue;
438
- out.push(row.original as TData);
439
- }
440
- return out;
441
- },
442
- getData() {
443
- return ctx.internalData;
444
- },
445
- getColumns() {
446
- // Snapshot every column with its human-readable label and
447
- // visibility flag. Used by external code (exporters, column
448
- // pickers) so they don't have to re-walk the columnDef tree.
449
- // Hidden columns ARE included (with `visible: false`) so a column
450
- // picker can re-enable them - callers that only want what's
451
- // rendered filter by `.visible` (e.g. the exporter does).
452
- const describe = (c: any, visible: boolean) => ({
453
- id: c.id,
454
- field: (c.columnDef as { field?: string }).field,
455
- header:
456
- typeof c.columnDef.header === "string"
457
- ? c.columnDef.header
458
- : c.id,
459
- visible,
460
- // Surface the format + alignment so exporters can reproduce the
461
- // on-screen display value (currency symbol, date pattern, etc.)
462
- // instead of dumping raw values. `getColumnAlign` applies the same
463
- // editorType-based default the body uses.
464
- format: c.columnDef.format,
465
- align: getColumnAlign(c),
466
- });
467
- // Visible columns first, in their current visual order...
468
- const out = ctx.allColumns.map((c: any) => describe(c, true));
469
- // ...then any column hidden via `visible: false` / setColumnVisible.
470
- // Those aren't in `allColumns` (that list is visible-only), so pull
471
- // them straight from the engine's leaf set.
472
- const visibleIds = new Set(out.map((c: { id: string }) => c.id));
473
- for (const c of ctx.grid.getAllColumns() as any[]) {
474
- if (!visibleIds.has(c.id)) out.push(describe(c, false));
475
- }
476
- return out;
477
- },
478
- // ---- Free data export (CSV / TSV / JSON + clipboard) -----------------
479
- async exportCsv(options: GridExportOptions = {}) {
480
- const { records, fields } = projectForExport(
481
- options.rows ?? "displayed",
482
- options.columns,
483
- options.rawValues,
484
- );
485
- const text = await serializeDelimited(records, fields, {
486
- csv: { delimiter: ",", bom: options.bom ?? true },
487
- signal: options.signal,
488
- onProgress: options.onProgress,
489
- });
490
- if (options.download !== false)
491
- downloadTextFile(text, `${options.filename ?? "grid"}.csv`, "text/csv;charset=utf-8");
492
- return text;
493
- },
494
- async exportTsv(options: GridExportOptions = {}) {
495
- const { records, fields } = projectForExport(
496
- options.rows ?? "displayed",
497
- options.columns,
498
- options.rawValues,
499
- );
500
- const text = await serializeDelimited(records, fields, {
501
- csv: { delimiter: "\t", bom: options.bom ?? true },
502
- signal: options.signal,
503
- onProgress: options.onProgress,
504
- });
505
- if (options.download !== false)
506
- downloadTextFile(text, `${options.filename ?? "grid"}.tsv`, "text/tab-separated-values;charset=utf-8");
507
- return text;
508
- },
509
- async exportJson(options: GridExportOptions = {}) {
510
- const { records, fields } = projectForExport(
511
- options.rows ?? "displayed",
512
- options.columns,
513
- options.rawValues,
514
- );
515
- const text = await serializeJson(records, fields, {
516
- signal: options.signal,
517
- onProgress: options.onProgress,
518
- });
519
- if (options.download !== false)
520
- downloadTextFile(text, `${options.filename ?? "grid"}.json`, "application/json");
521
- return text;
522
- },
523
- async copyToClipboard(options: GridClipboardOptions = {}) {
524
- const { records, fields, align } = projectForExport(
525
- options.rows ?? "displayed",
526
- options.columns,
527
- options.rawValues,
528
- );
529
- const format = options.format ?? "tsv";
530
- const text =
531
- format === "markdown"
532
- ? await serializeMarkdown(records, fields, { align })
533
- : await serializeDelimited(records, fields, {
534
- csv: { delimiter: format === "csv" ? "," : "\t", bom: false },
535
- });
536
- await copyTextToClipboard(text);
537
- return text;
538
- },
539
- clearRowSelection() {
540
- // Wipe the internal selection map AND emit the change so any
541
- // consumer holding a derived `selectedRows` resets too.
542
- ctx.grid.setRowSelection(() => ({}));
543
- ctx.props.onRowSelectionChange?.({}, []);
544
- },
545
- setColumnWidth(columnId: string, width: number) {
546
- const clamped = Math.max(ctx.MIN_COLUMN_WIDTH, Math.floor(width));
547
- ctx.columnWidths = { ...ctx.columnWidths, [columnId]: clamped };
548
- },
549
- getColumnWidths() {
550
- // Resolve every column's effective width by consulting both the
551
- // resize overrides (`columnWidths`) AND the columnDef defaults,
552
- // so the snapshot is round-trippable through setColumnWidth.
553
- const out: Record<string, number> = {};
554
- for (const c of ctx.allColumns) out[c.id] = ctx.getColumnWidth(c.id);
555
- return out;
556
- },
557
- autosizeColumn(columnId: string) {
558
- ctx.autosizeColumn(columnId);
559
- },
560
- autosizeAllColumns() {
561
- ctx.autosizeAllColumns();
562
- },
563
- setColumnPinning(pinning) {
564
- // Defensive copy + dedupe so callers can't mutate our state.
565
- const left = Array.from(new Set(pinning.left ?? []));
566
- const right = Array.from(new Set(pinning.right ?? []));
567
- ctx.columnPinning = { left, right };
568
- },
569
- getColumnPinning() {
570
- return {
571
- left: ctx.columnPinning.left.slice(),
572
- right: ctx.columnPinning.right.slice(),
573
- };
574
- },
575
- // ---- Column reorder
576
- setColumnOrder(order) {
577
- ctx.setColumnOrderInternal(order);
578
- },
579
- getColumnOrder() {
580
- return ctx.getCurrentColumnOrder();
581
- },
582
- setRowExpanded(id, expanded) {
583
- ctx.grid.setExpanded((prev: any) => ({ ...prev, [id]: !!expanded }));
584
- },
585
- expandAllGroups() {
586
- // Walk the current grouped row model and flip every group node on.
587
- const next: Record<string, boolean> = {};
588
- const walk = (rows: ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>) => {
589
- for (const row of rows) {
590
- if (row.getCanExpand?.()) next[row.id] = true;
591
- const sub = row.subRows as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }> | undefined;
592
- if (sub && sub.length > 0) walk(sub);
593
- }
594
- };
595
- walk(ctx.grid.getRowModel().rows as unknown as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>);
596
- ctx.grid.setExpanded(() => next);
597
- },
598
- collapseAllGroups() {
599
- ctx.grid.setExpanded(() => ({}));
600
- },
601
- // ---- Undo / redo (history + pointer)
602
- undo() {
603
- if (ctx.historyPtr < 0) return false
604
- const step = ctx.history[ctx.historyPtr]
605
- if (!step) return false
606
- ctx.applyHistoryStep(step, 'undo')
607
- ctx.historyPtr -= 1
608
- ctx.historyVersion += 1
609
- return true
610
- },
611
- redo() {
612
- if (ctx.historyPtr >= ctx.history.length - 1) return false
613
- const step = ctx.history[ctx.historyPtr + 1]
614
- if (!step) return false
615
- ctx.applyHistoryStep(step, 'redo')
616
- ctx.historyPtr += 1
617
- ctx.historyVersion += 1
618
- return true
619
- },
620
- canUndo() { void ctx.historyVersion; return ctx.historyPtr >= 0 },
621
- canRedo() { void ctx.historyVersion; return ctx.historyPtr < ctx.history.length - 1 },
622
- clearHistory() { ctx.history = []; ctx.historyPtr = -1; ctx.historyVersion += 1 },
623
- // ---- Find
624
- openFind() { ctx.findOpen = true },
625
- closeFind() { ctx.findOpen = false; ctx.findQuery = '' },
626
- setFindQuery(q: string) { ctx.findQuery = q; ctx.findHitIndex = 0 },
627
- getFindHits() { return ctx.findHits.slice() },
628
- // ---- Row selection (read + write)
629
- getSelectedRows() {
630
- const out: TData[] = [];
631
- for (const row of ctx.allRows) {
632
- if (isGroupRow(row)) continue;
633
- if (ctx.rowSelectionState[row.id]) out.push(row.original as TData);
634
- }
635
- return out;
636
- },
637
- getSelectedRowIds() {
638
- const out: string[] = [];
639
- for (const row of ctx.allRows) {
640
- if (!isGroupRow(row) && ctx.rowSelectionState[row.id]) out.push(row.id);
641
- }
642
- return out;
643
- },
644
- selectRows(ids, additive = false) {
645
- const set = new Set(ids);
646
- ctx.grid.setRowSelection((prev: any) => {
647
- const next: Record<string, boolean> = additive ? { ...prev } : {};
648
- for (const id of set) next[id] = true;
649
- return next;
650
- });
651
- },
652
- selectAllRows() {
653
- const next: Record<string, boolean> = {};
654
- for (const row of ctx.allRows) if (!isGroupRow(row)) next[row.id] = true;
655
- ctx.grid.setRowSelection(() => next);
656
- },
657
- toggleRowSelected(id) {
658
- ctx.toggleRowSelectionById(id);
659
- },
660
- // ---- Pagination
661
- getPageInfo() {
662
- const { pageIndex, pageSize } = ctx.paginationState;
663
- const total = ctx.allRowsBeforePagination.length;
664
- const pageCount = Math.max(1, Math.ceil(total / Math.max(1, pageSize)));
665
- return { pageIndex, pageSize, pageCount, total };
666
- },
667
- setPage(pageIndex) {
668
- const total = ctx.allRowsBeforePagination.length;
669
- const pageCount = Math.max(
670
- 1,
671
- Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
672
- );
673
- ctx.goToPage(Math.max(0, Math.min(pageIndex, pageCount - 1)));
674
- },
675
- nextPage() {
676
- this.setPage(ctx.paginationState.pageIndex + 1);
677
- },
678
- prevPage() {
679
- this.setPage(ctx.paginationState.pageIndex - 1);
680
- },
681
- firstPage() {
682
- this.setPage(0);
683
- },
684
- lastPage() {
685
- const total = ctx.allRowsBeforePagination.length;
686
- const pageCount = Math.max(
687
- 1,
688
- Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
689
- );
690
- this.setPage(pageCount - 1);
691
- },
692
- setPageSize(size) {
693
- // Calls the component-level helper (lexical scope), not this method.
694
- ctx.setPageSize(Math.max(1, Math.floor(size)));
695
- },
696
- // ---- Navigation / scrolling
697
- scrollToRow(rowIndex) {
698
- if (!ctx.scrollContainer) return;
699
- const maxIndex = Math.max(0, ctx.allRows.length - 1);
700
- const clamped = Math.max(0, Math.min(rowIndex, maxIndex));
701
- // Logical offset from the virtualizer (honors uniform OR per-row
702
- // sizing), then mapped into the capped DOM scroll space so it lands
703
- // correctly on huge grids where the DOM height is scaled down.
704
- const logical = ctx.virtualizer.getOffsetForIndex(clamped);
705
- ctx.scrollContainer.scrollTop = ctx.logicalToDomRowOffset(logical);
706
- ctx.scheduleScrollSync(
707
- ctx.scrollContainer.scrollTop,
708
- ctx.scrollContainer.scrollLeft,
709
- );
710
- },
711
- getActiveCell() {
712
- const a = ctx.activeCell;
713
- if (!a || a.rowIndex < 0 || a.colIndex < 0) return null;
714
- const col = ctx.allColumns[a.colIndex];
715
- return {
716
- rowIndex: a.rowIndex,
717
- colIndex: a.colIndex,
718
- columnId: col?.id ?? "",
719
- };
720
- },
721
- setActiveCell(rowIndex, colIndex) {
722
- const r = Math.max(0, Math.min(rowIndex, Math.max(0, ctx.allRows.length - 1)));
723
- const c = Math.max(
724
- 0,
725
- Math.min(colIndex, Math.max(0, ctx.allColumns.length - 1)),
726
- );
727
- // Calls the component-level helper (lexical scope), not this method.
728
- ctx.setActiveCell(r, c);
729
- },
730
- // ---- View state (save / restore)
731
- getState() {
732
- return {
733
- sorting: (ctx.grid.getState().sorting ?? []).map(
734
- (s: { id: string; desc: boolean }) => ({ id: s.id, desc: s.desc }),
735
- ),
736
- grouping: [...(ctx.grid.getState().grouping ?? [])],
737
- pagination: {
738
- pageIndex: ctx.paginationState.pageIndex,
739
- pageSize: ctx.paginationState.pageSize,
740
- },
741
- columnWidths: this.getColumnWidths(),
742
- columnPinning: this.getColumnPinning(),
743
- columnOrder: ctx.getCurrentColumnOrder(),
744
- hiddenColumns: Object.keys(ctx.hiddenColumns).filter(
745
- (k) => ctx.hiddenColumns[k],
746
- ),
747
- globalFilter: ctx.globalFilter,
748
- columnFilters: this.getFilters(),
749
- facetFilters: Object.fromEntries(
750
- Object.entries(ctx.valueFilters).map(([k, set]: [string, any]) => [
751
- k,
752
- Array.from(set),
753
- ]),
754
- ),
755
- };
756
- },
757
- setState(state) {
758
- if (state.sorting) {
759
- const sorting = state.sorting.map((s) => ({ id: s.id, desc: s.desc }));
760
- ctx.grid.store.setState((prev: any) => ({ ...prev, sorting }));
761
- }
762
- if (state.grouping) ctx.grid.setGrouping([...state.grouping]);
763
- if (state.pagination) {
764
- const p = state.pagination;
765
- ctx.grid.setPagination((prev: any) => ({ ...prev, ...p }));
766
- }
767
- if (state.columnWidths) ctx.columnWidths = { ...state.columnWidths };
768
- if (state.columnPinning)
769
- ctx.columnPinning = {
770
- left: [...(state.columnPinning.left ?? [])],
771
- right: [...(state.columnPinning.right ?? [])],
772
- };
773
- if (state.columnOrder) ctx.setColumnOrderInternal(state.columnOrder);
774
- if (state.hiddenColumns) {
775
- const next: Record<string, boolean> = {};
776
- for (const id of state.hiddenColumns) next[id] = true;
777
- ctx.hiddenColumns = next;
778
- }
779
- if (state.globalFilter !== undefined) ctx.globalFilter = state.globalFilter;
780
- if (state.columnFilters)
781
- ctx.filterMenuValues = { ...state.columnFilters };
782
- if (state.facetFilters) {
783
- const next: Record<string, Set<string>> = {};
784
- for (const [k, arr] of Object.entries(state.facetFilters))
785
- next[k] = new Set(arr);
786
- ctx.valueFilters = next;
787
- }
788
- },
789
- refresh() {
790
- ctx.grid.store.setState((prev: any) => ({ ...prev }));
791
- },
792
- };
793
- }
794
-
795
- return {
796
- buildApi,
797
- };
798
- }
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 type { Snippet } from "svelte";
44
+ import { getKeyboardIntent, getNextActiveCell } from "./keyboard";
45
+ import {
46
+ formatNumericWithConfig,
47
+ getDateFormatter,
48
+ resolveDatePattern,
49
+ } from "./cell-formatting";
50
+ import {
51
+ projectGridRows,
52
+ serializeDelimited,
53
+ serializeJson,
54
+ serializeMarkdown,
55
+ downloadTextFile,
56
+ copyTextToClipboard,
57
+ type GridExportColumn,
58
+ type GridExportScope,
59
+ type GridExportOptions,
60
+ type GridClipboardOptions,
61
+ } from "./export-format";
62
+ import {
63
+ RenderSnippetConfig,
64
+ RenderComponentConfig,
65
+ } from "./render-component";
66
+ import { buildFillPattern } from "./fill-patterns";
67
+ import { buildSparkline, toSparklineValues } from "./sparkline";
68
+ import {
69
+ resolveCellFormat,
70
+ computeColumnStat,
71
+ formatsNeedingStats,
72
+ type ColumnStat,
73
+ type ResolvedCellFormat,
74
+ } from "./conditional-formatting";
75
+ import SvGridDropdown from "./SvGridDropdown.svelte";
76
+ import type {
77
+ Props,
78
+ SelectionPoint,
79
+ SelectionRange,
80
+ CellEditState,
81
+ FilterOperator,
82
+ FilterOption,
83
+ MenuPosition,
84
+ } from "./SvGrid.types";
85
+ import {
86
+ cfTextStyle,
87
+ fmtStat,
88
+ getCellKey,
89
+ resolveClassList,
90
+ toDateInputValue,
91
+ toDateTimeLocalInputValue,
92
+ getEditableInputValue,
93
+ getEditorInputType,
94
+ toValueArray,
95
+ getOptionLabel,
96
+ getOptionColor,
97
+ colorfulChipStyle,
98
+ getEditorClass,
99
+ asDate,
100
+ clampMenuX,
101
+ cssEscape,
102
+ rawToNumber,
103
+ formatFacetNumber,
104
+ formatFacetDate,
105
+ } from "./SvGrid.helpers";
106
+ import { createClipboard } from "./clipboard";
107
+ import {
108
+ filterOperatorOptions,
109
+ fallbackOperatorOption,
110
+ TEXT_OPERATORS,
111
+ NUMBER_OPERATORS,
112
+ DATE_OPERATORS,
113
+ CHECKBOX_OPERATORS,
114
+ operatorOption,
115
+ operatorsForColumn,
116
+ defaultOperatorFor,
117
+ operatorLabelFor,
118
+ } from "./filter-operators";
119
+ import {
120
+ type FacetBucket,
121
+ isBucketableColumn,
122
+ buildBuckets,
123
+ isInBucket,
124
+ } from "./facet-buckets";
125
+ import {
126
+ getColumnBaseValue,
127
+ isGroupRow,
128
+ toolPanelHeaderLabel,
129
+ formatSummaryNumeric,
130
+ getColumnAlign,
131
+ getPinnedCellValue,
132
+ getColumnAccessorValue,
133
+ columnDefMatchesId,
134
+ } from "./cell-values";
135
+
136
+ export function createGridApi<
137
+ TFeatures extends TableFeatures = TableFeatures,
138
+ TData extends RowData = RowData,
139
+ >(ctx: any) {
140
+ function buildApi(): SvGridApi<TFeatures, TData> {
141
+ const findColumn = (columnId: string) =>
142
+ ctx.grid.getAllColumns().find((column: any) => column.id === columnId);
143
+
144
+ // --- Free data export (CSV / TSV / JSON + clipboard) helpers ----------
145
+ // Snapshot the VISIBLE columns (field + label + format + align) so the
146
+ // exporter reproduces on-screen values. Mirrors getColumns()'s visible set.
147
+ const exportColumns = (): GridExportColumn[] =>
148
+ ctx.allColumns
149
+ .map((c: any) => ({
150
+ field: (c.columnDef as { field?: string }).field as string,
151
+ header:
152
+ typeof c.columnDef.header === "string" ? c.columnDef.header : c.id,
153
+ format: c.columnDef.format,
154
+ align: getColumnAlign(c),
155
+ }))
156
+ .filter((c: GridExportColumn) => !!c.field);
157
+ // Rows for the requested scope: current view / checked / full dataset.
158
+ const exportScopeRows = (scope: GridExportScope): TData[] => {
159
+ if (scope === "all") return ctx.internalData as TData[];
160
+ const out: TData[] = [];
161
+ for (const row of ctx.allRows) {
162
+ if (isGroupRow(row)) continue;
163
+ if (scope === "selected" && !ctx.rowSelectionState[row.id]) continue;
164
+ out.push(row.original as TData);
165
+ }
166
+ return out;
167
+ };
168
+ const projectForExport = (
169
+ scope: GridExportScope,
170
+ columns: ReadonlyArray<string> | undefined,
171
+ rawValues: boolean | undefined,
172
+ ) =>
173
+ projectGridRows(
174
+ exportScopeRows(scope) as ReadonlyArray<Record<string, unknown>>,
175
+ exportColumns(),
176
+ { columns, rawValues },
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
+ addRow(row, position = "bottom") {
243
+ this.addRows([row], position);
244
+ },
245
+ addRows(rows, position = "bottom") {
246
+ const next = ctx.internalData.slice() as Array<TData>;
247
+ if (position === "top") next.unshift(...rows);
248
+ else if (position === "bottom") next.push(...rows);
249
+ else if (typeof position === "number")
250
+ next.splice(Math.max(0, Math.min(position, next.length)), 0, ...rows);
251
+ ctx.internalData = next;
252
+ },
253
+ removeRow(rowIndex) {
254
+ this.removeRows([rowIndex]);
255
+ },
256
+ removeRows(rowIndices) {
257
+ const drop = new Set(rowIndices);
258
+ ctx.internalData = ctx.internalData.filter((_: any, i: any) => !drop.has(i));
259
+ },
260
+ applyTransaction(tx) {
261
+ const getId = ctx.props.getRowId;
262
+ let next = ctx.internalData.slice() as Array<TData>;
263
+ let added = 0;
264
+ let updated = 0;
265
+ let removed = 0;
266
+
267
+ if (tx.remove?.length) {
268
+ const removeIds = new Set<string>();
269
+ const removeRefs = new Set<TData>();
270
+ for (const r of tx.remove) {
271
+ if (typeof r === "string") removeIds.add(r);
272
+ else removeRefs.add(r as TData);
273
+ }
274
+ next = next.filter((row, i) => {
275
+ const hit =
276
+ removeRefs.has(row) ||
277
+ (getId ? removeIds.has(getId(row, i)) : false);
278
+ if (hit) removed += 1;
279
+ return !hit;
280
+ });
281
+ }
282
+
283
+ if (tx.update?.length && getId) {
284
+ const byId = new Map<string, TData>();
285
+ for (const u of tx.update) byId.set(getId(u, 0), u);
286
+ next = next.map((row, i) => {
287
+ const u = byId.get(getId(row, i));
288
+ if (u) {
289
+ updated += 1;
290
+ return u;
291
+ }
292
+ return row;
293
+ });
294
+ }
295
+
296
+ if (tx.add?.length) {
297
+ next.push(...(tx.add as Array<TData>));
298
+ added += tx.add.length;
299
+ }
300
+
301
+ ctx.internalData = next;
302
+ return { added, updated, removed };
303
+ },
304
+ addColumn(column, position = "right") {
305
+ this.addColumns([column], position);
306
+ },
307
+ addColumns(columns, position = "right") {
308
+ const next = ctx.internalColumns.slice();
309
+ if (position === "left") next.unshift(...columns);
310
+ else if (position === "right") next.push(...columns);
311
+ else if (typeof position === "number")
312
+ next.splice(
313
+ Math.max(0, Math.min(position, next.length)),
314
+ 0,
315
+ ...columns,
316
+ );
317
+ ctx.internalColumns = next;
318
+ },
319
+ removeColumn(columnId) {
320
+ ctx.internalColumns = ctx.internalColumns.filter(
321
+ (def: any) => !columnDefMatchesId(def, columnId),
322
+ );
323
+ },
324
+ setColumnVisible(columnId, visible) {
325
+ if (visible) {
326
+ const next = { ...ctx.hiddenColumns };
327
+ delete next[columnId];
328
+ ctx.hiddenColumns = next;
329
+ } else {
330
+ ctx.hiddenColumns = { ...ctx.hiddenColumns, [columnId]: true };
331
+ }
332
+ },
333
+ isColumnVisible(columnId) {
334
+ return !ctx.hiddenColumns[columnId];
335
+ },
336
+ setSort(columnId, direction) {
337
+ // Honour the column's `sortable` opt-out. Asking the engine
338
+ // whether the column can sort folds in both the feature toggle
339
+ // AND the per-column flag.
340
+ const col = ctx.allColumns.find((c: any) => c.id === columnId);
341
+ if (col && !col.getCanSort?.()) return;
342
+ const clauses = direction
343
+ ? [{ id: columnId, desc: direction === "desc" }]
344
+ : (ctx.grid.getState().sorting ?? []).filter(
345
+ (entry: { id: string }) => entry.id !== columnId,
346
+ );
347
+ ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: clauses }));
348
+ },
349
+ clearSort() {
350
+ ctx.grid.store.setState((prev: any) => ({ ...prev, sorting: [] }));
351
+ },
352
+ setGroupBy(columnIds) {
353
+ ctx.grid.setGrouping([...columnIds]);
354
+ },
355
+ setFilter(columnId, filter) {
356
+ // Honour the column's `filterable` opt-out. Same approach as
357
+ // `setSort` - `getCanFilter()` already combines the feature flag
358
+ // and the per-column field.
359
+ const col = ctx.allColumns.find((c: any) => c.id === columnId);
360
+ if (col && !col.getCanFilter?.()) return;
361
+ if (!filter) {
362
+ this.clearFilter(columnId);
363
+ return;
364
+ }
365
+ ctx.filterMenuValues = {
366
+ ...ctx.filterMenuValues,
367
+ [columnId]: {
368
+ operator: filter.operator,
369
+ value: filter.value ?? "",
370
+ ...(filter.operator === "between"
371
+ ? { valueTo: filter.valueTo ?? "" }
372
+ : {}),
373
+ // Optional second condition + join (multi-condition filtering).
374
+ ...(filter.operator2
375
+ ? {
376
+ operator2: filter.operator2,
377
+ value2: filter.value2 ?? "",
378
+ join: filter.join ?? "AND",
379
+ ...(filter.operator2 === "between"
380
+ ? { valueTo2: filter.valueTo2 ?? "" }
381
+ : {}),
382
+ }
383
+ : {}),
384
+ },
385
+ };
386
+ },
387
+ setFacetFilter(columnId, values) {
388
+ // Empty array OR null both mean "clear this column's facet" -
389
+ // mirrors how the column menu treats unchecking the last value.
390
+ if (!values || values.length === 0) {
391
+ if (ctx.valueFilters[columnId]) {
392
+ const next = { ...ctx.valueFilters };
393
+ delete next[columnId];
394
+ ctx.valueFilters = next;
395
+ }
396
+ return;
397
+ }
398
+ ctx.valueFilters = {
399
+ ...ctx.valueFilters,
400
+ [columnId]: new Set(values),
401
+ };
402
+ },
403
+ clearFilter(columnId) {
404
+ ctx.clearColumnFilter(columnId);
405
+ },
406
+ clearAllFilters() {
407
+ // Wipe every filter surface in one go: column-menu, filter-row, set
408
+ // filters, and the global search box.
409
+ ctx.filterMenuValues = {};
410
+ ctx.filterRowValues = {};
411
+ ctx.valueFilters = {};
412
+ if (ctx.globalFilter !== "") ctx.globalFilter = "";
413
+ },
414
+ getFilters() {
415
+ // Return a defensive copy so callers can't mutate internal state.
416
+ const out: Record<
417
+ string,
418
+ { operator: FilterOperator; value: string; valueTo?: string }
419
+ > = {};
420
+ for (const [columnId, filter] of Object.entries(ctx.filterMenuValues as Record<string, { operator: FilterOperator; value: string; valueTo?: string }>)) {
421
+ out[columnId] = {
422
+ operator: filter.operator,
423
+ value: filter.value,
424
+ ...(filter.operator === "between" && filter.valueTo
425
+ ? { valueTo: filter.valueTo }
426
+ : {}),
427
+ };
428
+ }
429
+ return out;
430
+ },
431
+ getDisplayedRows() {
432
+ // `allRows` is the final, post-filter, post-sort, post-group,
433
+ // post-pagination list - exactly what the body renders. Skip group
434
+ // header rows (they wrap an aggregate, not a TData row).
435
+ const out: TData[] = [];
436
+ for (const row of ctx.allRows) {
437
+ if (row.subRows && row.subRows.length > 0) continue;
438
+ out.push(row.original as TData);
439
+ }
440
+ return out;
441
+ },
442
+ getData() {
443
+ return ctx.internalData;
444
+ },
445
+ getColumns() {
446
+ // Snapshot every column with its human-readable label and
447
+ // visibility flag. Used by external code (exporters, column
448
+ // pickers) so they don't have to re-walk the columnDef tree.
449
+ // Hidden columns ARE included (with `visible: false`) so a column
450
+ // picker can re-enable them - callers that only want what's
451
+ // rendered filter by `.visible` (e.g. the exporter does).
452
+ const describe = (c: any, visible: boolean) => ({
453
+ id: c.id,
454
+ field: (c.columnDef as { field?: string }).field,
455
+ header:
456
+ typeof c.columnDef.header === "string"
457
+ ? c.columnDef.header
458
+ : c.id,
459
+ visible,
460
+ // Surface the format + alignment so exporters can reproduce the
461
+ // on-screen display value (currency symbol, date pattern, etc.)
462
+ // instead of dumping raw values. `getColumnAlign` applies the same
463
+ // editorType-based default the body uses.
464
+ format: c.columnDef.format,
465
+ align: getColumnAlign(c),
466
+ });
467
+ // Visible columns first, in their current visual order...
468
+ const out = ctx.allColumns.map((c: any) => describe(c, true));
469
+ // ...then any column hidden via `visible: false` / setColumnVisible.
470
+ // Those aren't in `allColumns` (that list is visible-only), so pull
471
+ // them straight from the engine's leaf set.
472
+ const visibleIds = new Set(out.map((c: { id: string }) => c.id));
473
+ for (const c of ctx.grid.getAllColumns() as any[]) {
474
+ if (!visibleIds.has(c.id)) out.push(describe(c, false));
475
+ }
476
+ return out;
477
+ },
478
+ // ---- Free data export (CSV / TSV / JSON + clipboard) -----------------
479
+ async exportCsv(options: GridExportOptions = {}) {
480
+ const { records, fields } = projectForExport(
481
+ options.rows ?? "displayed",
482
+ options.columns,
483
+ options.rawValues,
484
+ );
485
+ const text = await serializeDelimited(records, fields, {
486
+ csv: { delimiter: ",", bom: options.bom ?? true },
487
+ signal: options.signal,
488
+ onProgress: options.onProgress,
489
+ });
490
+ if (options.download !== false)
491
+ downloadTextFile(text, `${options.filename ?? "grid"}.csv`, "text/csv;charset=utf-8");
492
+ return text;
493
+ },
494
+ async exportTsv(options: GridExportOptions = {}) {
495
+ const { records, fields } = projectForExport(
496
+ options.rows ?? "displayed",
497
+ options.columns,
498
+ options.rawValues,
499
+ );
500
+ const text = await serializeDelimited(records, fields, {
501
+ csv: { delimiter: "\t", bom: options.bom ?? true },
502
+ signal: options.signal,
503
+ onProgress: options.onProgress,
504
+ });
505
+ if (options.download !== false)
506
+ downloadTextFile(text, `${options.filename ?? "grid"}.tsv`, "text/tab-separated-values;charset=utf-8");
507
+ return text;
508
+ },
509
+ async exportJson(options: GridExportOptions = {}) {
510
+ const { records, fields } = projectForExport(
511
+ options.rows ?? "displayed",
512
+ options.columns,
513
+ options.rawValues,
514
+ );
515
+ const text = await serializeJson(records, fields, {
516
+ signal: options.signal,
517
+ onProgress: options.onProgress,
518
+ });
519
+ if (options.download !== false)
520
+ downloadTextFile(text, `${options.filename ?? "grid"}.json`, "application/json");
521
+ return text;
522
+ },
523
+ async copyToClipboard(options: GridClipboardOptions = {}) {
524
+ const { records, fields, align } = projectForExport(
525
+ options.rows ?? "displayed",
526
+ options.columns,
527
+ options.rawValues,
528
+ );
529
+ const format = options.format ?? "tsv";
530
+ const text =
531
+ format === "markdown"
532
+ ? await serializeMarkdown(records, fields, { align })
533
+ : await serializeDelimited(records, fields, {
534
+ csv: { delimiter: format === "csv" ? "," : "\t", bom: false },
535
+ });
536
+ await copyTextToClipboard(text);
537
+ return text;
538
+ },
539
+ clearRowSelection() {
540
+ // Wipe the internal selection map AND emit the change so any
541
+ // consumer holding a derived `selectedRows` resets too.
542
+ ctx.grid.setRowSelection(() => ({}));
543
+ ctx.props.onRowSelectionChange?.({}, []);
544
+ },
545
+ setColumnWidth(columnId: string, width: number) {
546
+ const clamped = Math.max(ctx.MIN_COLUMN_WIDTH, Math.floor(width));
547
+ ctx.columnWidths = { ...ctx.columnWidths, [columnId]: clamped };
548
+ },
549
+ getColumnWidths() {
550
+ // Resolve every column's effective width by consulting both the
551
+ // resize overrides (`columnWidths`) AND the columnDef defaults,
552
+ // so the snapshot is round-trippable through setColumnWidth.
553
+ const out: Record<string, number> = {};
554
+ for (const c of ctx.allColumns) out[c.id] = ctx.getColumnWidth(c.id);
555
+ return out;
556
+ },
557
+ autosizeColumn(columnId: string) {
558
+ ctx.autosizeColumn(columnId);
559
+ },
560
+ autosizeAllColumns() {
561
+ ctx.autosizeAllColumns();
562
+ },
563
+ setColumnPinning(pinning) {
564
+ // Defensive copy + dedupe so callers can't mutate our state.
565
+ const left = Array.from(new Set(pinning.left ?? []));
566
+ const right = Array.from(new Set(pinning.right ?? []));
567
+ ctx.columnPinning = { left, right };
568
+ },
569
+ getColumnPinning() {
570
+ return {
571
+ left: ctx.columnPinning.left.slice(),
572
+ right: ctx.columnPinning.right.slice(),
573
+ };
574
+ },
575
+ // ---- Column reorder
576
+ setColumnOrder(order) {
577
+ ctx.setColumnOrderInternal(order);
578
+ },
579
+ getColumnOrder() {
580
+ return ctx.getCurrentColumnOrder();
581
+ },
582
+ setRowExpanded(id, expanded) {
583
+ ctx.grid.setExpanded((prev: any) => ({ ...prev, [id]: !!expanded }));
584
+ },
585
+ expandAllGroups() {
586
+ // Walk the current grouped row model and flip every group node on.
587
+ const next: Record<string, boolean> = {};
588
+ const walk = (rows: ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>) => {
589
+ for (const row of rows) {
590
+ if (row.getCanExpand?.()) next[row.id] = true;
591
+ const sub = row.subRows as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }> | undefined;
592
+ if (sub && sub.length > 0) walk(sub);
593
+ }
594
+ };
595
+ walk(ctx.grid.getRowModel().rows as unknown as ReadonlyArray<{ id: string; getCanExpand?: () => boolean; subRows?: ReadonlyArray<unknown> }>);
596
+ ctx.grid.setExpanded(() => next);
597
+ },
598
+ collapseAllGroups() {
599
+ ctx.grid.setExpanded(() => ({}));
600
+ },
601
+ // ---- Undo / redo (history + pointer)
602
+ undo() {
603
+ if (ctx.historyPtr < 0) return false
604
+ const step = ctx.history[ctx.historyPtr]
605
+ if (!step) return false
606
+ ctx.applyHistoryStep(step, 'undo')
607
+ ctx.historyPtr -= 1
608
+ ctx.historyVersion += 1
609
+ return true
610
+ },
611
+ redo() {
612
+ if (ctx.historyPtr >= ctx.history.length - 1) return false
613
+ const step = ctx.history[ctx.historyPtr + 1]
614
+ if (!step) return false
615
+ ctx.applyHistoryStep(step, 'redo')
616
+ ctx.historyPtr += 1
617
+ ctx.historyVersion += 1
618
+ return true
619
+ },
620
+ canUndo() { void ctx.historyVersion; return ctx.historyPtr >= 0 },
621
+ canRedo() { void ctx.historyVersion; return ctx.historyPtr < ctx.history.length - 1 },
622
+ clearHistory() { ctx.history = []; ctx.historyPtr = -1; ctx.historyVersion += 1 },
623
+ // ---- Find
624
+ openFind() { ctx.findOpen = true },
625
+ closeFind() { ctx.findOpen = false; ctx.findQuery = '' },
626
+ setFindQuery(q: string) { ctx.findQuery = q; ctx.findHitIndex = 0 },
627
+ getFindHits() { return ctx.findHits.slice() },
628
+ // ---- Row selection (read + write)
629
+ getSelectedRows() {
630
+ const out: TData[] = [];
631
+ for (const row of ctx.allRows) {
632
+ if (isGroupRow(row)) continue;
633
+ if (ctx.rowSelectionState[row.id]) out.push(row.original as TData);
634
+ }
635
+ return out;
636
+ },
637
+ getSelectedRowIds() {
638
+ const out: string[] = [];
639
+ for (const row of ctx.allRows) {
640
+ if (!isGroupRow(row) && ctx.rowSelectionState[row.id]) out.push(row.id);
641
+ }
642
+ return out;
643
+ },
644
+ selectRows(ids, additive = false) {
645
+ const set = new Set(ids);
646
+ ctx.grid.setRowSelection((prev: any) => {
647
+ const next: Record<string, boolean> = additive ? { ...prev } : {};
648
+ for (const id of set) next[id] = true;
649
+ return next;
650
+ });
651
+ },
652
+ selectAllRows() {
653
+ const next: Record<string, boolean> = {};
654
+ for (const row of ctx.allRows) if (!isGroupRow(row)) next[row.id] = true;
655
+ ctx.grid.setRowSelection(() => next);
656
+ },
657
+ toggleRowSelected(id) {
658
+ ctx.toggleRowSelectionById(id);
659
+ },
660
+ // ---- Pagination
661
+ getPageInfo() {
662
+ const { pageIndex, pageSize } = ctx.paginationState;
663
+ const total = ctx.allRowsBeforePagination.length;
664
+ const pageCount = Math.max(1, Math.ceil(total / Math.max(1, pageSize)));
665
+ return { pageIndex, pageSize, pageCount, total };
666
+ },
667
+ setPage(pageIndex) {
668
+ const total = ctx.allRowsBeforePagination.length;
669
+ const pageCount = Math.max(
670
+ 1,
671
+ Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
672
+ );
673
+ ctx.goToPage(Math.max(0, Math.min(pageIndex, pageCount - 1)));
674
+ },
675
+ nextPage() {
676
+ this.setPage(ctx.paginationState.pageIndex + 1);
677
+ },
678
+ prevPage() {
679
+ this.setPage(ctx.paginationState.pageIndex - 1);
680
+ },
681
+ firstPage() {
682
+ this.setPage(0);
683
+ },
684
+ lastPage() {
685
+ const total = ctx.allRowsBeforePagination.length;
686
+ const pageCount = Math.max(
687
+ 1,
688
+ Math.ceil(total / Math.max(1, ctx.paginationState.pageSize)),
689
+ );
690
+ this.setPage(pageCount - 1);
691
+ },
692
+ setPageSize(size) {
693
+ // Calls the component-level helper (lexical scope), not this method.
694
+ ctx.setPageSize(Math.max(1, Math.floor(size)));
695
+ },
696
+ // ---- Navigation / scrolling
697
+ scrollToRow(rowIndex) {
698
+ if (!ctx.scrollContainer) return;
699
+ const maxIndex = Math.max(0, ctx.allRows.length - 1);
700
+ const clamped = Math.max(0, Math.min(rowIndex, maxIndex));
701
+ // Logical offset from the virtualizer (honors uniform OR per-row
702
+ // sizing), then mapped into the capped DOM scroll space so it lands
703
+ // correctly on huge grids where the DOM height is scaled down.
704
+ const logical = ctx.virtualizer.getOffsetForIndex(clamped);
705
+ ctx.scrollContainer.scrollTop = ctx.logicalToDomRowOffset(logical);
706
+ ctx.scheduleScrollSync(
707
+ ctx.scrollContainer.scrollTop,
708
+ ctx.scrollContainer.scrollLeft,
709
+ );
710
+ },
711
+ getActiveCell() {
712
+ const a = ctx.activeCell;
713
+ if (!a || a.rowIndex < 0 || a.colIndex < 0) return null;
714
+ const col = ctx.allColumns[a.colIndex];
715
+ return {
716
+ rowIndex: a.rowIndex,
717
+ colIndex: a.colIndex,
718
+ columnId: col?.id ?? "",
719
+ };
720
+ },
721
+ setActiveCell(rowIndex, colIndex) {
722
+ const r = Math.max(0, Math.min(rowIndex, Math.max(0, ctx.allRows.length - 1)));
723
+ const c = Math.max(
724
+ 0,
725
+ Math.min(colIndex, Math.max(0, ctx.allColumns.length - 1)),
726
+ );
727
+ // Calls the component-level helper (lexical scope), not this method.
728
+ ctx.setActiveCell(r, c);
729
+ },
730
+ // ---- View state (save / restore)
731
+ getState() {
732
+ return {
733
+ sorting: (ctx.grid.getState().sorting ?? []).map(
734
+ (s: { id: string; desc: boolean }) => ({ id: s.id, desc: s.desc }),
735
+ ),
736
+ grouping: [...(ctx.grid.getState().grouping ?? [])],
737
+ pagination: {
738
+ pageIndex: ctx.paginationState.pageIndex,
739
+ pageSize: ctx.paginationState.pageSize,
740
+ },
741
+ columnWidths: this.getColumnWidths(),
742
+ columnPinning: this.getColumnPinning(),
743
+ columnOrder: ctx.getCurrentColumnOrder(),
744
+ hiddenColumns: Object.keys(ctx.hiddenColumns).filter(
745
+ (k) => ctx.hiddenColumns[k],
746
+ ),
747
+ globalFilter: ctx.globalFilter,
748
+ columnFilters: this.getFilters(),
749
+ facetFilters: Object.fromEntries(
750
+ Object.entries(ctx.valueFilters).map(([k, set]: [string, any]) => [
751
+ k,
752
+ Array.from(set),
753
+ ]),
754
+ ),
755
+ };
756
+ },
757
+ setState(state) {
758
+ if (state.sorting) {
759
+ const sorting = state.sorting.map((s) => ({ id: s.id, desc: s.desc }));
760
+ ctx.grid.store.setState((prev: any) => ({ ...prev, sorting }));
761
+ }
762
+ if (state.grouping) ctx.grid.setGrouping([...state.grouping]);
763
+ if (state.pagination) {
764
+ const p = state.pagination;
765
+ ctx.grid.setPagination((prev: any) => ({ ...prev, ...p }));
766
+ }
767
+ if (state.columnWidths) ctx.columnWidths = { ...state.columnWidths };
768
+ if (state.columnPinning)
769
+ ctx.columnPinning = {
770
+ left: [...(state.columnPinning.left ?? [])],
771
+ right: [...(state.columnPinning.right ?? [])],
772
+ };
773
+ if (state.columnOrder) ctx.setColumnOrderInternal(state.columnOrder);
774
+ if (state.hiddenColumns) {
775
+ const next: Record<string, boolean> = {};
776
+ for (const id of state.hiddenColumns) next[id] = true;
777
+ ctx.hiddenColumns = next;
778
+ }
779
+ if (state.globalFilter !== undefined) ctx.globalFilter = state.globalFilter;
780
+ if (state.columnFilters)
781
+ ctx.filterMenuValues = { ...state.columnFilters };
782
+ if (state.facetFilters) {
783
+ const next: Record<string, Set<string>> = {};
784
+ for (const [k, arr] of Object.entries(state.facetFilters))
785
+ next[k] = new Set(arr);
786
+ ctx.valueFilters = next;
787
+ }
788
+ },
789
+ refresh() {
790
+ ctx.grid.store.setState((prev: any) => ({ ...prev }));
791
+ },
792
+ };
793
+ }
794
+
795
+ return {
796
+ buildApi,
797
+ };
798
+ }