@svgrid/grid 2.1.22 → 2.2.0

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 (295) hide show
  1. package/README.md +9 -2
  2. package/dist/DockNodeView.svelte +306 -0
  3. package/dist/DockNodeView.svelte.d.ts +7 -0
  4. package/dist/DockPopoutHost.svelte +17 -0
  5. package/dist/DockPopoutHost.svelte.d.ts +14 -0
  6. package/dist/FlexRender.svelte +96 -96
  7. package/dist/GridFooter.svelte +178 -178
  8. package/dist/GridMenus.svelte +83 -3
  9. package/dist/SvAutoComplete.svelte +5 -3
  10. package/dist/SvCarousel.svelte +141 -163
  11. package/dist/SvColorInput.svelte +187 -186
  12. package/dist/SvColorInput.svelte.d.ts +1 -1
  13. package/dist/SvComboBox.svelte +7 -3
  14. package/dist/SvCommand.svelte +28 -85
  15. package/dist/SvContextMenu.svelte +116 -116
  16. package/dist/SvCountryInput.svelte +1 -1
  17. package/dist/SvDateRangeInput.svelte +1 -1
  18. package/dist/SvDateTimePicker.svelte +9 -3
  19. package/dist/SvDateTimePicker.svelte.d.ts +3 -0
  20. package/dist/SvDockLayout.svelte +244 -0
  21. package/dist/SvDockLayout.svelte.d.ts +77 -0
  22. package/dist/SvDockManager.svelte +922 -0
  23. package/dist/SvDockManager.svelte.d.ts +106 -0
  24. package/dist/SvDrawer.svelte +250 -228
  25. package/dist/SvDrawer.svelte.d.ts +4 -0
  26. package/dist/SvDropDownList.svelte +85 -13
  27. package/dist/SvDropDownList.svelte.d.ts +3 -0
  28. package/dist/SvField.svelte +21 -4
  29. package/dist/SvField.svelte.d.ts +1 -0
  30. package/dist/SvForm.svelte +201 -91
  31. package/dist/SvForm.svelte.d.ts +15 -22
  32. package/dist/SvGrid.controller.svelte.d.ts +32 -1
  33. package/dist/SvGrid.controller.svelte.js +156 -27
  34. package/dist/SvGrid.css +193 -5
  35. package/dist/SvGrid.svelte +3131 -2786
  36. package/dist/SvGrid.types.d.ts +452 -1
  37. package/dist/SvGridBoard.svelte +2339 -2339
  38. package/dist/SvGridChart.svelte +1724 -1724
  39. package/dist/SvGridChartPanel.svelte +485 -485
  40. package/dist/SvGridDropdown.svelte +689 -682
  41. package/dist/SvGridSelect.svelte +1 -0
  42. package/dist/SvGroupCell.svelte +109 -109
  43. package/dist/SvListBox.svelte +36 -14
  44. package/dist/SvMaskedInput.svelte +4 -3
  45. package/dist/SvMaskedInput.svelte.d.ts +1 -1
  46. package/dist/SvMenu.svelte +124 -124
  47. package/dist/SvMenuList.svelte +117 -165
  48. package/dist/SvMenuList.svelte.d.ts +2 -13
  49. package/dist/SvModal.svelte +12 -29
  50. package/dist/SvMultiSelect.svelte +1 -0
  51. package/dist/SvNumberInput.svelte +131 -130
  52. package/dist/SvNumberInput.svelte.d.ts +1 -1
  53. package/dist/SvOtpInput.svelte +158 -158
  54. package/dist/SvPagination.svelte +18 -18
  55. package/dist/SvPasswordInput.svelte +3 -2
  56. package/dist/SvPasswordInput.svelte.d.ts +1 -1
  57. package/dist/SvPhoneInput.svelte +3 -2
  58. package/dist/SvPhoneInput.svelte.d.ts +1 -1
  59. package/dist/SvPopover.svelte +139 -139
  60. package/dist/SvRowGroupPanel.svelte +170 -170
  61. package/dist/SvScrollArea.svelte +61 -61
  62. package/dist/SvStepper.svelte +6 -9
  63. package/dist/SvTagsInput.svelte +3 -2
  64. package/dist/SvTagsInput.svelte.d.ts +1 -1
  65. package/dist/SvTooltip.svelte +127 -138
  66. package/dist/SvTour.svelte +204 -176
  67. package/dist/SvTree.svelte +377 -377
  68. package/dist/SvTreeSelect.svelte +230 -229
  69. package/dist/build-api.js +76 -54
  70. package/dist/cdn/svgrid.js +10913 -6450
  71. package/dist/cdn/svgrid.svelte-external.js +9628 -5481
  72. package/dist/chart-export.js +8 -8
  73. package/dist/columns.js +6 -0
  74. package/dist/conditional-formatting.d.ts +67 -3
  75. package/dist/conditional-formatting.js +124 -17
  76. package/dist/createCarousel.svelte.d.ts +72 -0
  77. package/dist/createCarousel.svelte.js +80 -0
  78. package/dist/createCommand.svelte.d.ts +62 -0
  79. package/dist/createCommand.svelte.js +109 -0
  80. package/dist/createForm.svelte.d.ts +62 -0
  81. package/dist/createForm.svelte.js +374 -0
  82. package/dist/createMenu.svelte.d.ts +88 -0
  83. package/dist/createMenu.svelte.js +153 -0
  84. package/dist/createOverlay.svelte.d.ts +38 -0
  85. package/dist/createOverlay.svelte.js +68 -0
  86. package/dist/createPagination.d.ts +74 -0
  87. package/dist/createPagination.js +71 -0
  88. package/dist/createPopoverSelect.svelte.js +6 -12
  89. package/dist/createStepper.d.ts +44 -0
  90. package/dist/createStepper.js +26 -0
  91. package/dist/createTooltip.svelte.d.ts +32 -0
  92. package/dist/createTooltip.svelte.js +61 -0
  93. package/dist/datetime/timezone.d.ts +36 -0
  94. package/dist/datetime/timezone.js +110 -0
  95. package/dist/dock-context.d.ts +52 -0
  96. package/dist/dock-context.js +1 -0
  97. package/dist/dock-manager-model.d.ts +136 -0
  98. package/dist/dock-manager-model.js +514 -0
  99. package/dist/dock-model.d.ts +105 -0
  100. package/dist/dock-model.js +288 -0
  101. package/dist/dock-popout.d.ts +30 -0
  102. package/dist/dock-popout.js +81 -0
  103. package/dist/editor-contract.d.ts +2 -0
  104. package/dist/filter-operators.d.ts +6 -0
  105. package/dist/filter-operators.js +35 -2
  106. package/dist/filtering/excel-filters.d.ts +18 -1
  107. package/dist/filtering/excel-filters.js +56 -0
  108. package/dist/form-field.d.ts +73 -0
  109. package/dist/form-field.js +15 -0
  110. package/dist/index.d.ts +25 -5
  111. package/dist/index.js +40 -4
  112. package/dist/list-nav.d.ts +18 -0
  113. package/dist/list-nav.js +30 -0
  114. package/dist/list-option.d.ts +2 -0
  115. package/dist/menu-item.d.ts +20 -0
  116. package/dist/menu-item.js +1 -0
  117. package/dist/menus.d.ts +5 -0
  118. package/dist/menus.js +68 -16
  119. package/dist/panel-resize.d.ts +25 -0
  120. package/dist/panel-resize.js +40 -0
  121. package/dist/popover.d.ts +29 -3
  122. package/dist/popover.js +22 -6
  123. package/dist/recurrence.d.ts +33 -7
  124. package/dist/recurrence.js +151 -13
  125. package/dist/row-drag.d.ts +8 -0
  126. package/dist/row-drag.js +11 -0
  127. package/dist/scheduler-ical.d.ts +30 -0
  128. package/dist/scheduler-ical.js +180 -0
  129. package/dist/scheduler-model.d.ts +269 -0
  130. package/dist/scheduler-model.js +602 -0
  131. package/dist/scheduler-view.svelte.d.ts +22 -0
  132. package/dist/scheduler-view.svelte.js +13 -0
  133. package/dist/spreadsheet.js +20 -12
  134. package/dist/ui-app.types.d.ts +3 -0
  135. package/package.json +14 -10
  136. package/src/DockNodeView.svelte +306 -0
  137. package/src/DockPopoutHost.svelte +17 -0
  138. package/src/FlexRender.svelte +96 -96
  139. package/src/GridFooter.svelte +178 -178
  140. package/src/GridMenus.svelte +83 -3
  141. package/src/SvAutoComplete.svelte +5 -3
  142. package/src/SvCarousel.svelte +141 -163
  143. package/src/SvCarousel.test.ts +68 -0
  144. package/src/SvColorInput.svelte +187 -186
  145. package/src/SvComboBox.svelte +7 -3
  146. package/src/SvCommand.svelte +28 -85
  147. package/src/SvCommand.test.ts +78 -0
  148. package/src/SvContextMenu.svelte +116 -116
  149. package/src/SvCountryInput.svelte +1 -1
  150. package/src/SvDateRangeInput.svelte +1 -1
  151. package/src/SvDateTimePicker.svelte +9 -3
  152. package/src/SvDockLayout.svelte +244 -0
  153. package/src/SvDockManager.svelte +922 -0
  154. package/src/SvDrawer.svelte +250 -228
  155. package/src/SvDropDownList.svelte +85 -13
  156. package/src/SvField.svelte +21 -4
  157. package/src/SvForm.svelte +201 -91
  158. package/src/SvForm.test.ts +299 -0
  159. package/src/SvGrid.controller.svelte.ts +3158 -3034
  160. package/src/SvGrid.css +193 -5
  161. package/src/SvGrid.svelte +3131 -2786
  162. package/src/SvGrid.types.ts +1489 -1027
  163. package/src/SvGridBoard.svelte +2339 -2339
  164. package/src/SvGridChart.svelte +1724 -1724
  165. package/src/SvGridChartPanel.svelte +485 -485
  166. package/src/SvGridDropdown.svelte +689 -682
  167. package/src/SvGridSelect.svelte +1 -0
  168. package/src/SvGroupCell.svelte +109 -109
  169. package/src/SvListBox.svelte +36 -14
  170. package/src/SvMaskedInput.svelte +4 -3
  171. package/src/SvMenu.svelte +124 -124
  172. package/src/SvMenu.test.ts +97 -73
  173. package/src/SvMenuList.svelte +117 -165
  174. package/src/SvModal.svelte +12 -29
  175. package/src/SvModal.test.ts +82 -0
  176. package/src/SvMultiSelect.svelte +1 -0
  177. package/src/SvNumberInput.svelte +131 -130
  178. package/src/SvOtpInput.svelte +158 -158
  179. package/src/SvPagination.svelte +18 -18
  180. package/src/SvPasswordInput.svelte +3 -2
  181. package/src/SvPhoneInput.svelte +3 -2
  182. package/src/SvPopover.svelte +139 -139
  183. package/src/SvRowGroupPanel.svelte +170 -170
  184. package/src/SvScrollArea.svelte +61 -61
  185. package/src/SvStepper.svelte +6 -9
  186. package/src/SvTagsInput.svelte +3 -2
  187. package/src/SvTooltip.svelte +127 -138
  188. package/src/SvTooltip.test.ts +73 -0
  189. package/src/SvTour.svelte +204 -176
  190. package/src/SvTree.svelte +377 -377
  191. package/src/SvTreeSelect.svelte +230 -229
  192. package/src/a11y.contract.test.ts +49 -49
  193. package/src/a11y.test.ts +59 -59
  194. package/src/a11y.ts +61 -61
  195. package/src/build-api.ts +870 -847
  196. package/src/cell-formatting.ts +169 -169
  197. package/src/cell-render.ts +469 -469
  198. package/src/chart-export.ts +201 -201
  199. package/src/chart.ts +2296 -2296
  200. package/src/collaboration.test.ts +104 -104
  201. package/src/collaboration.ts +167 -167
  202. package/src/columns.ts +5 -0
  203. package/src/conditional-formatting.test.ts +104 -0
  204. package/src/conditional-formatting.ts +176 -19
  205. package/src/core.performance.test.ts +30 -30
  206. package/src/core.ts +1111 -1111
  207. package/src/createAutocomplete.svelte.ts +132 -132
  208. package/src/createCarousel.svelte.ts +104 -0
  209. package/src/createCombobox.svelte.ts +179 -179
  210. package/src/createCommand.svelte.ts +125 -0
  211. package/src/createCountryInput.svelte.ts +157 -157
  212. package/src/createDropdownList.svelte.ts +162 -162
  213. package/src/createForm.svelte.ts +333 -0
  214. package/src/createGrid.svelte.ts +42 -42
  215. package/src/createGrid.test.ts +10 -10
  216. package/src/createGridState.svelte.ts +17 -17
  217. package/src/createMenu.svelte.ts +202 -0
  218. package/src/createOverlay.svelte.ts +101 -0
  219. package/src/createPagination.test.ts +65 -0
  220. package/src/createPagination.ts +84 -0
  221. package/src/createPopoverSelect.svelte.ts +206 -210
  222. package/src/createStepper.test.ts +62 -0
  223. package/src/createStepper.ts +61 -0
  224. package/src/createTooltip.svelte.ts +86 -0
  225. package/src/createTree.svelte.ts +319 -319
  226. package/src/datetime/timezone.test.ts +69 -0
  227. package/src/datetime/timezone.ts +134 -0
  228. package/src/dock-context.ts +47 -0
  229. package/src/dock-manager-model.test.ts +275 -0
  230. package/src/dock-manager-model.ts +593 -0
  231. package/src/dock-model.test.ts +163 -0
  232. package/src/dock-model.ts +368 -0
  233. package/src/dock-popout.ts +94 -0
  234. package/src/editing.test.ts +859 -859
  235. package/src/editing.ts +675 -675
  236. package/src/editor-contract.ts +2 -0
  237. package/src/export-data-api.test.ts +126 -126
  238. package/src/export-format.test.ts +107 -107
  239. package/src/export-format.ts +598 -598
  240. package/src/filter-operators.test.ts +59 -0
  241. package/src/filter-operators.ts +35 -2
  242. package/src/filtering/excel-filters.test.ts +86 -1
  243. package/src/filtering/excel-filters.ts +65 -0
  244. package/src/flex-render.ts +3 -3
  245. package/src/form-field.ts +87 -0
  246. package/src/index.ts +623 -469
  247. package/src/keyboard.test.ts +59 -59
  248. package/src/keyboard.ts +97 -97
  249. package/src/list-nav.test.ts +49 -0
  250. package/src/list-nav.ts +29 -0
  251. package/src/list-option.ts +2 -0
  252. package/src/menu-item.ts +21 -0
  253. package/src/menus.test.ts +48 -0
  254. package/src/menus.ts +639 -582
  255. package/src/merge-objects.ts +48 -48
  256. package/src/overlays.test.ts +90 -90
  257. package/src/panel-resize.ts +52 -0
  258. package/src/popover.bounds.test.ts +93 -0
  259. package/src/popover.ts +51 -7
  260. package/src/recurrence.test.ts +88 -1
  261. package/src/recurrence.ts +166 -15
  262. package/src/render-component.ts +28 -28
  263. package/src/row-drag.ts +10 -0
  264. package/src/scheduler-ical.test.ts +68 -0
  265. package/src/scheduler-ical.ts +180 -0
  266. package/src/scheduler-model.test.ts +546 -0
  267. package/src/scheduler-model.ts +853 -0
  268. package/src/scheduler-view.svelte.ts +33 -0
  269. package/src/selection.test.ts +754 -754
  270. package/src/selection.ts +600 -600
  271. package/src/server-data-source.test.ts +289 -289
  272. package/src/server-data-source.ts +413 -413
  273. package/src/sparkline.test.ts +68 -68
  274. package/src/sparkline.ts +169 -169
  275. package/src/spreadsheet.test.ts +489 -489
  276. package/src/spreadsheet.ts +312 -304
  277. package/src/static-functions.ts +11 -11
  278. package/src/subscribe.ts +38 -38
  279. package/src/svgrid-wrapper.types.ts +501 -501
  280. package/src/svgrid.behavior.test.ts +706 -706
  281. package/src/svgrid.charting.test.ts +527 -527
  282. package/src/svgrid.effect-driven-filter.svelte.test.ts +116 -0
  283. package/src/svgrid.features.test.ts +157 -157
  284. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  285. package/src/svgrid.wrapper.test.ts +40 -40
  286. package/src/test-setup.ts +62 -62
  287. package/src/themes/index.ts +159 -159
  288. package/src/ui-app.types.ts +3 -0
  289. package/src/virtual.test.ts +6 -4
  290. package/src/virtualization/column-virtualizer.test.ts +27 -27
  291. package/src/virtualization/column-virtualizer.ts +30 -30
  292. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  293. package/src/virtualization/types.ts +30 -30
  294. package/src/virtualization/virtualizer.test.ts +47 -47
  295. package/src/virtualization/virtualizer.ts +296 -296
@@ -1,413 +1,413 @@
1
- /**
2
- * Server-Side Row Model (SSRM) controller. A single, documented datasource
3
- * contract for grids whose data lives on the server - the "I have a million
4
- * rows in a database" case. The consumer implements ONE async `getRows`
5
- * function; this controller owns the request lifecycle (sort, filter, page),
6
- * de-dupes/races, and pushes results back through `onChange`.
7
- *
8
- * It's headless and framework-agnostic on purpose: wire `setSort` /
9
- * `setFilter` / `setPage` to the grid's controlled callbacks, and render the
10
- * grid from the `{ rows, total, loading }` it hands you. See the demo.
11
- *
12
- * The write side (`createRow` / `updateRow` / `deleteRow`) is optional: a
13
- * source that only implements `getRows` stays a pure read model, and the
14
- * matching controller methods throw a clear error if called. Mutations are
15
- * non-optimistic for now - the grid reflects a change only after the
16
- * follow-up re-fetch of the current page lands.
17
- */
18
- export type ServerSortModel = Array<{ id: string; desc: boolean }>
19
-
20
- export type ServerFilterModel = {
21
- /** Free-text global search. */
22
- global?: string
23
- /**
24
- * Per-column filters, keyed by column id. `value` (+ `valueTo`) carry the
25
- * operator-style filter; `selectedValues` carries a facet/checklist
26
- * selection (set-filter). Either or both may be present.
27
- */
28
- columns?: Record<
29
- string,
30
- { operator: string; value: string; valueTo?: string; selectedValues?: string[] }
31
- >
32
- }
33
-
34
- /** A value column to roll up per group. */
35
- export type ServerAggregation = { col: string; fn: 'sum' | 'avg' | 'min' | 'max' | 'count' }
36
-
37
- export type ServerRequest = {
38
- /** Zero-based index of the first row wanted (inclusive). */
39
- startRow: number
40
- /** Index just past the last row wanted (exclusive). */
41
- endRow: number
42
- pageIndex: number
43
- pageSize: number
44
- sortModel: ServerSortModel
45
- filterModel: ServerFilterModel
46
- /**
47
- * Server-side grouping / tree: the columns being grouped on, outer to inner.
48
- * Omitted / empty for a flat request.
49
- */
50
- groupBy?: string[]
51
- /**
52
- * The path of group keys the grid is expanding, e.g. `['Germany', 'Berlin']`.
53
- * Empty (`[]`) asks for the top level. When `groupKeys.length < groupBy.length`
54
- * the server returns **group rows** (one per distinct key at this level,
55
- * carrying the group key + aggregates); when they are equal it returns the
56
- * **leaf rows** under that path.
57
- */
58
- groupKeys?: string[]
59
- /** Value columns to aggregate per group. */
60
- aggregations?: ServerAggregation[]
61
- }
62
-
63
- /**
64
- * A group row in the server-side group/tree model - one distinct key at a
65
- * level, with its rolled-up aggregates. The grid renders it with an expander;
66
- * expanding it fetches its children through the same `getRows`.
67
- */
68
- export type ServerGroupRow<TData> = {
69
- kind: 'group'
70
- /** Stable id (the group path). */
71
- id: string
72
- /** Group keys from the root to this node, e.g. `['Germany', 'Berlin']`. */
73
- path: string[]
74
- /** The column this group is on (the `groupBy` entry for this level). */
75
- field: string
76
- /** This group's key value. */
77
- key: string
78
- /** Zero-based depth (0 = top level). */
79
- level: number
80
- expanded: boolean
81
- loading: boolean
82
- /** Aggregate values keyed by column id, read from the group's response row. */
83
- aggregates: Record<string, unknown>
84
- /** The raw response row for this group (key + aggregates), for cell rendering. */
85
- data: TData
86
- }
87
-
88
- export type ServerLeafRow<TData> = {
89
- kind: 'leaf'
90
- id: string
91
- level: number
92
- data: TData
93
- }
94
-
95
- /**
96
- * A "load more" affordance emitted at the end of a group whose children are
97
- * only partially loaded (intra-group paging). Trigger `loadMoreChildren(path)`
98
- * to fetch the next block.
99
- */
100
- export type ServerMoreRow = {
101
- kind: 'more'
102
- id: string
103
- level: number
104
- /** Path of the parent group whose children to load more of. */
105
- path: string[]
106
- /** How many children remain unloaded. */
107
- remaining: number
108
- loading: boolean
109
- }
110
-
111
- /**
112
- * A subtotal / footer row emitted after an expanded group's children when
113
- * `groupFooters` is on. Carries the group's aggregates a second time so a
114
- * "Total" line sits under the detail.
115
- */
116
- export type ServerFooterRow<TData> = {
117
- kind: 'footer'
118
- id: string
119
- level: number
120
- path: string[]
121
- /** The group this footer totals (its key). */
122
- key: string
123
- aggregates: Record<string, unknown>
124
- /** The group's response row (key + aggregates), so value columns show totals. */
125
- data: TData
126
- }
127
-
128
- /** A placeholder row shown while a block of children is being fetched. */
129
- export type ServerSkeletonRow = {
130
- kind: 'skeleton'
131
- id: string
132
- level: number
133
- }
134
-
135
- /** A row in the flattened server-side group/tree display list. */
136
- export type ServerDisplayRow<TData> =
137
- | ServerGroupRow<TData>
138
- | ServerLeafRow<TData>
139
- | ServerMoreRow
140
- | ServerFooterRow<TData>
141
- | ServerSkeletonRow
142
-
143
- export type ServerResult<TData> = {
144
- rows: ReadonlyArray<TData>
145
- /** Total row count after filtering (for the pager). */
146
- rowCount: number
147
- }
148
-
149
- export type ServerDataSource<TData> = {
150
- getRows(request: ServerRequest): Promise<ServerResult<TData>>
151
- /**
152
- * Optional write side. Implement whichever your backend supports; the
153
- * controller exposes matching `createRow` / `updateRow` / `deleteRow`
154
- * methods that call through and then `refresh()` the current page.
155
- * Calling a controller method whose source counterpart is missing throws.
156
- */
157
- createRow?(input: Partial<TData>): Promise<TData>
158
- updateRow?(id: string, patch: Partial<TData>): Promise<TData>
159
- deleteRow?(id: string): Promise<void>
160
- }
161
-
162
- export type ServerState<TData> = {
163
- rows: ReadonlyArray<TData>
164
- total: number
165
- loading: boolean
166
- /** True while a create / update / delete mutation is in flight. */
167
- saving: boolean
168
- error: unknown
169
- pageIndex: number
170
- pageSize: number
171
- pageCount: number
172
- sortModel: ServerSortModel
173
- filterModel: ServerFilterModel
174
- }
175
-
176
- export type ServerController<TData> = {
177
- /** Re-fetch the current page (e.g. after a mutation). */
178
- refresh(): void
179
- setSort(sortModel: ServerSortModel): void
180
- setFilter(filterModel: ServerFilterModel): void
181
- setPage(pageIndex: number): void
182
- setPageSize(pageSize: number): void
183
- /**
184
- * Create a row through the source, then refresh the current page. Resolves
185
- * with the created row. Rejects if the source has no `createRow` (or if the
186
- * create itself fails - the read state is left untouched on failure).
187
- */
188
- createRow(input: Partial<TData>): Promise<TData>
189
- /**
190
- * Update a row by id through the source. Non-optimistic: refreshes the page.
191
- * Optimistic (see `optimistic` + `getRowId` options): patches the local row
192
- * immediately, then reconciles with the server result, rolling back on error.
193
- */
194
- updateRow(id: string, patch: Partial<TData>): Promise<TData>
195
- /**
196
- * Delete a row by id through the source. Non-optimistic: refreshes the page.
197
- * Optimistic: removes the local row immediately, restoring it on error.
198
- */
199
- deleteRow(id: string): Promise<void>
200
- getState(): ServerState<TData>
201
- /** Stop accepting in-flight responses (call on unmount). */
202
- dispose(): void
203
- }
204
-
205
- export type ServerControllerOptions<TData> = {
206
- pageSize?: number
207
- /** Called whenever any of `rows` / `total` / `loading` / page changes. */
208
- onChange: (state: ServerState<TData>) => void
209
- /**
210
- * Apply `updateRow` / `deleteRow` to the local rows immediately (before the
211
- * server confirms) and roll back on error - so edits feel instant and no
212
- * refetch is needed. Requires `getRowId` to locate rows; ignored without it.
213
- * A subsequent `refresh()` reconciles ordering/filtering. Default false.
214
- */
215
- optimistic?: boolean
216
- /** Resolve a row's stable id, so optimistic update/delete can find it in `rows`. */
217
- getRowId?: (row: TData) => string
218
- }
219
-
220
- export function createServerDataSource<TData>(
221
- source: ServerDataSource<TData>,
222
- options: ServerControllerOptions<TData>,
223
- ): ServerController<TData> {
224
- const state: ServerState<TData> = {
225
- rows: [],
226
- total: 0,
227
- loading: false,
228
- saving: false,
229
- error: null,
230
- pageIndex: 0,
231
- pageSize: options.pageSize ?? 50,
232
- pageCount: 1,
233
- sortModel: [],
234
- filterModel: {},
235
- }
236
-
237
- // Monotonic request id: only the latest fetch is allowed to land, so a slow
238
- // response for an old sort/filter can't clobber a newer one.
239
- let requestSeq = 0
240
- let disposed = false
241
-
242
- const emit = () => {
243
- state.pageCount = Math.max(1, Math.ceil(state.total / state.pageSize))
244
- options.onChange({ ...state })
245
- }
246
-
247
- async function fetchPage() {
248
- if (disposed) return
249
- const id = ++requestSeq
250
- state.loading = true
251
- state.error = null
252
- emit()
253
- const startRow = state.pageIndex * state.pageSize
254
- try {
255
- const result = await source.getRows({
256
- startRow,
257
- endRow: startRow + state.pageSize,
258
- pageIndex: state.pageIndex,
259
- pageSize: state.pageSize,
260
- sortModel: state.sortModel,
261
- filterModel: state.filterModel,
262
- // Flat mode: no grouping. Group mode lives in createServerGroupModel.
263
- groupBy: [],
264
- groupKeys: [],
265
- aggregations: [],
266
- })
267
- if (disposed || id !== requestSeq) return // stale
268
- state.rows = result.rows
269
- state.total = result.rowCount
270
- state.loading = false
271
- emit()
272
- } catch (err) {
273
- if (disposed || id !== requestSeq) return
274
- state.rows = []
275
- state.error = err
276
- state.loading = false
277
- emit()
278
- }
279
- }
280
-
281
- // Shared mutation lifecycle: flip `saving`, run the write, refresh the
282
- // current page on success, and always clear `saving`. A missing source
283
- // method (or a disposed controller) rejects before anything is emitted.
284
- function mutate<T>(name: string, thunk: (() => Promise<T>) | null): Promise<T> {
285
- if (disposed) {
286
- return Promise.reject(new Error('createServerDataSource: controller is disposed'))
287
- }
288
- if (!thunk) {
289
- return Promise.reject(
290
- new Error(`createServerDataSource: the datasource does not implement ${name}()`),
291
- )
292
- }
293
- state.saving = true
294
- emit()
295
- return (async () => {
296
- try {
297
- const result = await thunk()
298
- await fetchPage()
299
- return result
300
- } finally {
301
- state.saving = false
302
- emit()
303
- }
304
- })()
305
- }
306
-
307
- const optimistic = !!options.optimistic && !!options.getRowId
308
- const getRowId = options.getRowId
309
-
310
- // Optimistic update: patch the local row, reconcile with the server result,
311
- // roll back on error. Falls back to the plain refresh path when the row
312
- // isn't on the current page (nothing local to update).
313
- async function optimisticUpdate(
314
- id: string,
315
- patch: Partial<TData>,
316
- fn: (id: string, patch: Partial<TData>) => Promise<TData>,
317
- ): Promise<TData> {
318
- if (disposed) throw new Error('createServerDataSource: controller is disposed')
319
- const prevRows = state.rows
320
- const idx = prevRows.findIndex((r) => getRowId!(r) === id)
321
- if (idx < 0) return mutate('updateRow', () => fn(id, patch))
322
-
323
- state.rows = [...prevRows.slice(0, idx), { ...prevRows[idx]!, ...patch }, ...prevRows.slice(idx + 1)]
324
- state.saving = true
325
- emit()
326
- try {
327
- const result = await fn(id, patch)
328
- state.rows = state.rows.map((r) => (getRowId!(r) === id ? result : r))
329
- return result
330
- } catch (err) {
331
- state.rows = prevRows
332
- throw err
333
- } finally {
334
- state.saving = false
335
- emit()
336
- }
337
- }
338
-
339
- // Optimistic delete: drop the local row + decrement total, restore on error.
340
- async function optimisticDelete(
341
- id: string,
342
- fn: (id: string) => Promise<void>,
343
- ): Promise<void> {
344
- if (disposed) throw new Error('createServerDataSource: controller is disposed')
345
- const prevRows = state.rows
346
- const prevTotal = state.total
347
- const next = prevRows.filter((r) => getRowId!(r) !== id)
348
- if (next.length === prevRows.length) return mutate('deleteRow', () => fn(id))
349
-
350
- state.rows = next
351
- state.total = Math.max(0, prevTotal - (prevRows.length - next.length))
352
- state.saving = true
353
- emit()
354
- try {
355
- await fn(id)
356
- } catch (err) {
357
- state.rows = prevRows
358
- state.total = prevTotal
359
- throw err
360
- } finally {
361
- state.saving = false
362
- emit()
363
- }
364
- }
365
-
366
- return {
367
- refresh: fetchPage,
368
- createRow: (input) =>
369
- mutate('createRow', source.createRow ? () => source.createRow!(input) : null),
370
- updateRow: (id, patch) => {
371
- if (!source.updateRow) return mutate('updateRow', null)
372
- const fn = source.updateRow
373
- return optimistic ? optimisticUpdate(id, patch, fn) : mutate('updateRow', () => fn(id, patch))
374
- },
375
- deleteRow: (id) => {
376
- if (!source.deleteRow) return mutate('deleteRow', null)
377
- const fn = source.deleteRow
378
- return optimistic ? optimisticDelete(id, fn) : mutate('deleteRow', () => fn(id))
379
- },
380
- setSort(sortModel) {
381
- state.sortModel = sortModel
382
- state.pageIndex = 0
383
- void fetchPage()
384
- },
385
- setFilter(filterModel) {
386
- state.filterModel = filterModel
387
- state.pageIndex = 0
388
- void fetchPage()
389
- },
390
- setPage(pageIndex) {
391
- const clamped = Math.max(0, pageIndex)
392
- if (clamped === state.pageIndex) return
393
- state.pageIndex = clamped
394
- void fetchPage()
395
- },
396
- setPageSize(pageSize) {
397
- state.pageSize = Math.max(1, pageSize)
398
- state.pageIndex = 0
399
- void fetchPage()
400
- },
401
- getState: () => ({ ...state }),
402
- dispose() {
403
- disposed = true
404
- // An in-flight fetch's resolution short-circuits on `disposed`, so it
405
- // never clears `loading`. Clear it here (and emit) so a disposed
406
- // controller doesn't report a permanent loading state.
407
- if (state.loading) {
408
- state.loading = false
409
- emit()
410
- }
411
- },
412
- }
413
- }
1
+ /**
2
+ * Server-Side Row Model (SSRM) controller. A single, documented datasource
3
+ * contract for grids whose data lives on the server - the "I have a million
4
+ * rows in a database" case. The consumer implements ONE async `getRows`
5
+ * function; this controller owns the request lifecycle (sort, filter, page),
6
+ * de-dupes/races, and pushes results back through `onChange`.
7
+ *
8
+ * It's headless and framework-agnostic on purpose: wire `setSort` /
9
+ * `setFilter` / `setPage` to the grid's controlled callbacks, and render the
10
+ * grid from the `{ rows, total, loading }` it hands you. See the demo.
11
+ *
12
+ * The write side (`createRow` / `updateRow` / `deleteRow`) is optional: a
13
+ * source that only implements `getRows` stays a pure read model, and the
14
+ * matching controller methods throw a clear error if called. Mutations are
15
+ * non-optimistic for now - the grid reflects a change only after the
16
+ * follow-up re-fetch of the current page lands.
17
+ */
18
+ export type ServerSortModel = Array<{ id: string; desc: boolean }>
19
+
20
+ export type ServerFilterModel = {
21
+ /** Free-text global search. */
22
+ global?: string
23
+ /**
24
+ * Per-column filters, keyed by column id. `value` (+ `valueTo`) carry the
25
+ * operator-style filter; `selectedValues` carries a facet/checklist
26
+ * selection (set-filter). Either or both may be present.
27
+ */
28
+ columns?: Record<
29
+ string,
30
+ { operator: string; value: string; valueTo?: string; selectedValues?: string[] }
31
+ >
32
+ }
33
+
34
+ /** A value column to roll up per group. */
35
+ export type ServerAggregation = { col: string; fn: 'sum' | 'avg' | 'min' | 'max' | 'count' }
36
+
37
+ export type ServerRequest = {
38
+ /** Zero-based index of the first row wanted (inclusive). */
39
+ startRow: number
40
+ /** Index just past the last row wanted (exclusive). */
41
+ endRow: number
42
+ pageIndex: number
43
+ pageSize: number
44
+ sortModel: ServerSortModel
45
+ filterModel: ServerFilterModel
46
+ /**
47
+ * Server-side grouping / tree: the columns being grouped on, outer to inner.
48
+ * Omitted / empty for a flat request.
49
+ */
50
+ groupBy?: string[]
51
+ /**
52
+ * The path of group keys the grid is expanding, e.g. `['Germany', 'Berlin']`.
53
+ * Empty (`[]`) asks for the top level. When `groupKeys.length < groupBy.length`
54
+ * the server returns **group rows** (one per distinct key at this level,
55
+ * carrying the group key + aggregates); when they are equal it returns the
56
+ * **leaf rows** under that path.
57
+ */
58
+ groupKeys?: string[]
59
+ /** Value columns to aggregate per group. */
60
+ aggregations?: ServerAggregation[]
61
+ }
62
+
63
+ /**
64
+ * A group row in the server-side group/tree model - one distinct key at a
65
+ * level, with its rolled-up aggregates. The grid renders it with an expander;
66
+ * expanding it fetches its children through the same `getRows`.
67
+ */
68
+ export type ServerGroupRow<TData> = {
69
+ kind: 'group'
70
+ /** Stable id (the group path). */
71
+ id: string
72
+ /** Group keys from the root to this node, e.g. `['Germany', 'Berlin']`. */
73
+ path: string[]
74
+ /** The column this group is on (the `groupBy` entry for this level). */
75
+ field: string
76
+ /** This group's key value. */
77
+ key: string
78
+ /** Zero-based depth (0 = top level). */
79
+ level: number
80
+ expanded: boolean
81
+ loading: boolean
82
+ /** Aggregate values keyed by column id, read from the group's response row. */
83
+ aggregates: Record<string, unknown>
84
+ /** The raw response row for this group (key + aggregates), for cell rendering. */
85
+ data: TData
86
+ }
87
+
88
+ export type ServerLeafRow<TData> = {
89
+ kind: 'leaf'
90
+ id: string
91
+ level: number
92
+ data: TData
93
+ }
94
+
95
+ /**
96
+ * A "load more" affordance emitted at the end of a group whose children are
97
+ * only partially loaded (intra-group paging). Trigger `loadMoreChildren(path)`
98
+ * to fetch the next block.
99
+ */
100
+ export type ServerMoreRow = {
101
+ kind: 'more'
102
+ id: string
103
+ level: number
104
+ /** Path of the parent group whose children to load more of. */
105
+ path: string[]
106
+ /** How many children remain unloaded. */
107
+ remaining: number
108
+ loading: boolean
109
+ }
110
+
111
+ /**
112
+ * A subtotal / footer row emitted after an expanded group's children when
113
+ * `groupFooters` is on. Carries the group's aggregates a second time so a
114
+ * "Total" line sits under the detail.
115
+ */
116
+ export type ServerFooterRow<TData> = {
117
+ kind: 'footer'
118
+ id: string
119
+ level: number
120
+ path: string[]
121
+ /** The group this footer totals (its key). */
122
+ key: string
123
+ aggregates: Record<string, unknown>
124
+ /** The group's response row (key + aggregates), so value columns show totals. */
125
+ data: TData
126
+ }
127
+
128
+ /** A placeholder row shown while a block of children is being fetched. */
129
+ export type ServerSkeletonRow = {
130
+ kind: 'skeleton'
131
+ id: string
132
+ level: number
133
+ }
134
+
135
+ /** A row in the flattened server-side group/tree display list. */
136
+ export type ServerDisplayRow<TData> =
137
+ | ServerGroupRow<TData>
138
+ | ServerLeafRow<TData>
139
+ | ServerMoreRow
140
+ | ServerFooterRow<TData>
141
+ | ServerSkeletonRow
142
+
143
+ export type ServerResult<TData> = {
144
+ rows: ReadonlyArray<TData>
145
+ /** Total row count after filtering (for the pager). */
146
+ rowCount: number
147
+ }
148
+
149
+ export type ServerDataSource<TData> = {
150
+ getRows(request: ServerRequest): Promise<ServerResult<TData>>
151
+ /**
152
+ * Optional write side. Implement whichever your backend supports; the
153
+ * controller exposes matching `createRow` / `updateRow` / `deleteRow`
154
+ * methods that call through and then `refresh()` the current page.
155
+ * Calling a controller method whose source counterpart is missing throws.
156
+ */
157
+ createRow?(input: Partial<TData>): Promise<TData>
158
+ updateRow?(id: string, patch: Partial<TData>): Promise<TData>
159
+ deleteRow?(id: string): Promise<void>
160
+ }
161
+
162
+ export type ServerState<TData> = {
163
+ rows: ReadonlyArray<TData>
164
+ total: number
165
+ loading: boolean
166
+ /** True while a create / update / delete mutation is in flight. */
167
+ saving: boolean
168
+ error: unknown
169
+ pageIndex: number
170
+ pageSize: number
171
+ pageCount: number
172
+ sortModel: ServerSortModel
173
+ filterModel: ServerFilterModel
174
+ }
175
+
176
+ export type ServerController<TData> = {
177
+ /** Re-fetch the current page (e.g. after a mutation). */
178
+ refresh(): void
179
+ setSort(sortModel: ServerSortModel): void
180
+ setFilter(filterModel: ServerFilterModel): void
181
+ setPage(pageIndex: number): void
182
+ setPageSize(pageSize: number): void
183
+ /**
184
+ * Create a row through the source, then refresh the current page. Resolves
185
+ * with the created row. Rejects if the source has no `createRow` (or if the
186
+ * create itself fails - the read state is left untouched on failure).
187
+ */
188
+ createRow(input: Partial<TData>): Promise<TData>
189
+ /**
190
+ * Update a row by id through the source. Non-optimistic: refreshes the page.
191
+ * Optimistic (see `optimistic` + `getRowId` options): patches the local row
192
+ * immediately, then reconciles with the server result, rolling back on error.
193
+ */
194
+ updateRow(id: string, patch: Partial<TData>): Promise<TData>
195
+ /**
196
+ * Delete a row by id through the source. Non-optimistic: refreshes the page.
197
+ * Optimistic: removes the local row immediately, restoring it on error.
198
+ */
199
+ deleteRow(id: string): Promise<void>
200
+ getState(): ServerState<TData>
201
+ /** Stop accepting in-flight responses (call on unmount). */
202
+ dispose(): void
203
+ }
204
+
205
+ export type ServerControllerOptions<TData> = {
206
+ pageSize?: number
207
+ /** Called whenever any of `rows` / `total` / `loading` / page changes. */
208
+ onChange: (state: ServerState<TData>) => void
209
+ /**
210
+ * Apply `updateRow` / `deleteRow` to the local rows immediately (before the
211
+ * server confirms) and roll back on error - so edits feel instant and no
212
+ * refetch is needed. Requires `getRowId` to locate rows; ignored without it.
213
+ * A subsequent `refresh()` reconciles ordering/filtering. Default false.
214
+ */
215
+ optimistic?: boolean
216
+ /** Resolve a row's stable id, so optimistic update/delete can find it in `rows`. */
217
+ getRowId?: (row: TData) => string
218
+ }
219
+
220
+ export function createServerDataSource<TData>(
221
+ source: ServerDataSource<TData>,
222
+ options: ServerControllerOptions<TData>,
223
+ ): ServerController<TData> {
224
+ const state: ServerState<TData> = {
225
+ rows: [],
226
+ total: 0,
227
+ loading: false,
228
+ saving: false,
229
+ error: null,
230
+ pageIndex: 0,
231
+ pageSize: options.pageSize ?? 50,
232
+ pageCount: 1,
233
+ sortModel: [],
234
+ filterModel: {},
235
+ }
236
+
237
+ // Monotonic request id: only the latest fetch is allowed to land, so a slow
238
+ // response for an old sort/filter can't clobber a newer one.
239
+ let requestSeq = 0
240
+ let disposed = false
241
+
242
+ const emit = () => {
243
+ state.pageCount = Math.max(1, Math.ceil(state.total / state.pageSize))
244
+ options.onChange({ ...state })
245
+ }
246
+
247
+ async function fetchPage() {
248
+ if (disposed) return
249
+ const id = ++requestSeq
250
+ state.loading = true
251
+ state.error = null
252
+ emit()
253
+ const startRow = state.pageIndex * state.pageSize
254
+ try {
255
+ const result = await source.getRows({
256
+ startRow,
257
+ endRow: startRow + state.pageSize,
258
+ pageIndex: state.pageIndex,
259
+ pageSize: state.pageSize,
260
+ sortModel: state.sortModel,
261
+ filterModel: state.filterModel,
262
+ // Flat mode: no grouping. Group mode lives in createServerGroupModel.
263
+ groupBy: [],
264
+ groupKeys: [],
265
+ aggregations: [],
266
+ })
267
+ if (disposed || id !== requestSeq) return // stale
268
+ state.rows = result.rows
269
+ state.total = result.rowCount
270
+ state.loading = false
271
+ emit()
272
+ } catch (err) {
273
+ if (disposed || id !== requestSeq) return
274
+ state.rows = []
275
+ state.error = err
276
+ state.loading = false
277
+ emit()
278
+ }
279
+ }
280
+
281
+ // Shared mutation lifecycle: flip `saving`, run the write, refresh the
282
+ // current page on success, and always clear `saving`. A missing source
283
+ // method (or a disposed controller) rejects before anything is emitted.
284
+ function mutate<T>(name: string, thunk: (() => Promise<T>) | null): Promise<T> {
285
+ if (disposed) {
286
+ return Promise.reject(new Error('createServerDataSource: controller is disposed'))
287
+ }
288
+ if (!thunk) {
289
+ return Promise.reject(
290
+ new Error(`createServerDataSource: the datasource does not implement ${name}()`),
291
+ )
292
+ }
293
+ state.saving = true
294
+ emit()
295
+ return (async () => {
296
+ try {
297
+ const result = await thunk()
298
+ await fetchPage()
299
+ return result
300
+ } finally {
301
+ state.saving = false
302
+ emit()
303
+ }
304
+ })()
305
+ }
306
+
307
+ const optimistic = !!options.optimistic && !!options.getRowId
308
+ const getRowId = options.getRowId
309
+
310
+ // Optimistic update: patch the local row, reconcile with the server result,
311
+ // roll back on error. Falls back to the plain refresh path when the row
312
+ // isn't on the current page (nothing local to update).
313
+ async function optimisticUpdate(
314
+ id: string,
315
+ patch: Partial<TData>,
316
+ fn: (id: string, patch: Partial<TData>) => Promise<TData>,
317
+ ): Promise<TData> {
318
+ if (disposed) throw new Error('createServerDataSource: controller is disposed')
319
+ const prevRows = state.rows
320
+ const idx = prevRows.findIndex((r) => getRowId!(r) === id)
321
+ if (idx < 0) return mutate('updateRow', () => fn(id, patch))
322
+
323
+ state.rows = [...prevRows.slice(0, idx), { ...prevRows[idx]!, ...patch }, ...prevRows.slice(idx + 1)]
324
+ state.saving = true
325
+ emit()
326
+ try {
327
+ const result = await fn(id, patch)
328
+ state.rows = state.rows.map((r) => (getRowId!(r) === id ? result : r))
329
+ return result
330
+ } catch (err) {
331
+ state.rows = prevRows
332
+ throw err
333
+ } finally {
334
+ state.saving = false
335
+ emit()
336
+ }
337
+ }
338
+
339
+ // Optimistic delete: drop the local row + decrement total, restore on error.
340
+ async function optimisticDelete(
341
+ id: string,
342
+ fn: (id: string) => Promise<void>,
343
+ ): Promise<void> {
344
+ if (disposed) throw new Error('createServerDataSource: controller is disposed')
345
+ const prevRows = state.rows
346
+ const prevTotal = state.total
347
+ const next = prevRows.filter((r) => getRowId!(r) !== id)
348
+ if (next.length === prevRows.length) return mutate('deleteRow', () => fn(id))
349
+
350
+ state.rows = next
351
+ state.total = Math.max(0, prevTotal - (prevRows.length - next.length))
352
+ state.saving = true
353
+ emit()
354
+ try {
355
+ await fn(id)
356
+ } catch (err) {
357
+ state.rows = prevRows
358
+ state.total = prevTotal
359
+ throw err
360
+ } finally {
361
+ state.saving = false
362
+ emit()
363
+ }
364
+ }
365
+
366
+ return {
367
+ refresh: fetchPage,
368
+ createRow: (input) =>
369
+ mutate('createRow', source.createRow ? () => source.createRow!(input) : null),
370
+ updateRow: (id, patch) => {
371
+ if (!source.updateRow) return mutate('updateRow', null)
372
+ const fn = source.updateRow
373
+ return optimistic ? optimisticUpdate(id, patch, fn) : mutate('updateRow', () => fn(id, patch))
374
+ },
375
+ deleteRow: (id) => {
376
+ if (!source.deleteRow) return mutate('deleteRow', null)
377
+ const fn = source.deleteRow
378
+ return optimistic ? optimisticDelete(id, fn) : mutate('deleteRow', () => fn(id))
379
+ },
380
+ setSort(sortModel) {
381
+ state.sortModel = sortModel
382
+ state.pageIndex = 0
383
+ void fetchPage()
384
+ },
385
+ setFilter(filterModel) {
386
+ state.filterModel = filterModel
387
+ state.pageIndex = 0
388
+ void fetchPage()
389
+ },
390
+ setPage(pageIndex) {
391
+ const clamped = Math.max(0, pageIndex)
392
+ if (clamped === state.pageIndex) return
393
+ state.pageIndex = clamped
394
+ void fetchPage()
395
+ },
396
+ setPageSize(pageSize) {
397
+ state.pageSize = Math.max(1, pageSize)
398
+ state.pageIndex = 0
399
+ void fetchPage()
400
+ },
401
+ getState: () => ({ ...state }),
402
+ dispose() {
403
+ disposed = true
404
+ // An in-flight fetch's resolution short-circuits on `disposed`, so it
405
+ // never clears `loading`. Clear it here (and emit) so a disposed
406
+ // controller doesn't report a permanent loading state.
407
+ if (state.loading) {
408
+ state.loading = false
409
+ emit()
410
+ }
411
+ },
412
+ }
413
+ }