@svgrid/grid 1.0.2 → 1.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 (216) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +137 -39
  3. package/dist/GridFooter.svelte +164 -0
  4. package/dist/GridFooter.svelte.d.ts +29 -0
  5. package/dist/GridMenus.svelte +648 -0
  6. package/dist/GridMenus.svelte.d.ts +31 -0
  7. package/dist/SvGrid.controller.svelte.d.ts +472 -0
  8. package/dist/SvGrid.controller.svelte.js +1917 -0
  9. package/dist/SvGrid.css +2012 -0
  10. package/dist/SvGrid.helpers.d.ts +35 -0
  11. package/dist/SvGrid.helpers.js +160 -0
  12. package/dist/SvGrid.helpers.test.d.ts +1 -0
  13. package/dist/SvGrid.helpers.test.js +298 -0
  14. package/dist/SvGrid.svelte +2346 -8742
  15. package/dist/SvGrid.svelte.d.ts +4 -357
  16. package/dist/SvGrid.types.d.ts +523 -0
  17. package/dist/SvGrid.types.js +1 -0
  18. package/dist/SvGridChart.svelte +1060 -23
  19. package/dist/SvGridChart.svelte.d.ts +17 -0
  20. package/dist/aligned-grids.d.ts +6 -0
  21. package/dist/aligned-grids.js +84 -0
  22. package/dist/aligned-grids.test.d.ts +1 -0
  23. package/dist/aligned-grids.test.js +75 -0
  24. package/dist/build-api.coverage.test.d.ts +20 -0
  25. package/dist/build-api.coverage.test.js +505 -0
  26. package/dist/build-api.d.ts +5 -0
  27. package/dist/build-api.js +557 -0
  28. package/dist/cell-render.d.ts +15 -0
  29. package/dist/cell-render.js +246 -0
  30. package/dist/cell-render.test.d.ts +1 -0
  31. package/dist/cell-render.test.js +338 -0
  32. package/dist/cell-values.d.ts +28 -0
  33. package/dist/cell-values.js +89 -0
  34. package/dist/chart-export.test.d.ts +1 -0
  35. package/dist/chart-export.test.js +302 -0
  36. package/dist/chart.coverage.test.d.ts +1 -0
  37. package/dist/chart.coverage.test.js +748 -0
  38. package/dist/chart.d.ts +370 -3
  39. package/dist/chart.js +1135 -42
  40. package/dist/clipboard.d.ts +15 -0
  41. package/dist/clipboard.js +420 -0
  42. package/dist/clipboard.test.d.ts +1 -0
  43. package/dist/clipboard.test.js +700 -0
  44. package/dist/collaboration.coverage.test.d.ts +1 -0
  45. package/dist/collaboration.coverage.test.js +200 -0
  46. package/dist/column-groups.d.ts +19 -0
  47. package/dist/column-groups.js +62 -0
  48. package/dist/column-groups.test.d.ts +1 -0
  49. package/dist/column-groups.test.js +56 -0
  50. package/dist/column-types.d.ts +10 -0
  51. package/dist/column-types.js +63 -0
  52. package/dist/column-types.test.d.ts +1 -0
  53. package/dist/column-types.test.js +62 -0
  54. package/dist/columns.d.ts +30 -0
  55. package/dist/columns.js +277 -0
  56. package/dist/columns.test.d.ts +1 -0
  57. package/dist/columns.test.js +625 -0
  58. package/dist/core.d.ts +86 -1
  59. package/dist/css.d.ts +3 -0
  60. package/dist/editing.d.ts +31 -0
  61. package/dist/editing.js +529 -0
  62. package/dist/editing.test.d.ts +1 -0
  63. package/dist/editing.test.js +732 -0
  64. package/dist/editors/cell-editors.coverage.test.d.ts +1 -0
  65. package/dist/editors/cell-editors.coverage.test.js +139 -0
  66. package/dist/editors/cell-editors.d.ts +1 -1
  67. package/dist/facet-buckets.d.ts +13 -0
  68. package/dist/facet-buckets.js +54 -0
  69. package/dist/facet-buckets.test.d.ts +1 -0
  70. package/dist/facet-buckets.test.js +296 -0
  71. package/dist/features.d.ts +5 -0
  72. package/dist/features.js +30 -0
  73. package/dist/filter-operators.d.ts +16 -0
  74. package/dist/filter-operators.js +69 -0
  75. package/dist/filter-operators.test.d.ts +1 -0
  76. package/dist/filter-operators.test.js +135 -0
  77. package/dist/hyperformula-adapter.d.ts +82 -0
  78. package/dist/hyperformula-adapter.js +73 -0
  79. package/dist/hyperformula-adapter.test.d.ts +1 -0
  80. package/dist/hyperformula-adapter.test.js +205 -0
  81. package/dist/index.d.ts +9 -3
  82. package/dist/index.js +8 -2
  83. package/dist/keyboard-handlers.coverage.test.d.ts +1 -0
  84. package/dist/keyboard-handlers.coverage.test.js +495 -0
  85. package/dist/keyboard-handlers.d.ts +7 -0
  86. package/dist/keyboard-handlers.js +202 -0
  87. package/dist/menus.d.ts +40 -0
  88. package/dist/menus.js +390 -0
  89. package/dist/menus.test.d.ts +1 -0
  90. package/dist/menus.test.js +560 -0
  91. package/dist/named-views.coverage.test.d.ts +1 -0
  92. package/dist/named-views.coverage.test.js +180 -0
  93. package/dist/named-views.d.ts +27 -0
  94. package/dist/named-views.js +39 -0
  95. package/dist/row-drag.d.ts +49 -0
  96. package/dist/row-drag.js +221 -0
  97. package/dist/row-drag.test.d.ts +1 -0
  98. package/dist/row-drag.test.js +142 -0
  99. package/dist/row-resize.d.ts +43 -0
  100. package/dist/row-resize.js +158 -0
  101. package/dist/row-resize.test.d.ts +1 -0
  102. package/dist/row-resize.test.js +329 -0
  103. package/dist/scroll-sync.d.ts +9 -0
  104. package/dist/scroll-sync.js +89 -0
  105. package/dist/scroll-sync.test.d.ts +1 -0
  106. package/dist/scroll-sync.test.js +290 -0
  107. package/dist/selection.d.ts +32 -0
  108. package/dist/selection.js +427 -0
  109. package/dist/selection.multi-range.test.d.ts +1 -0
  110. package/dist/selection.multi-range.test.js +55 -0
  111. package/dist/selection.test.d.ts +1 -0
  112. package/dist/selection.test.js +647 -0
  113. package/dist/server-data-source.coverage.test.d.ts +1 -0
  114. package/dist/server-data-source.coverage.test.js +154 -0
  115. package/dist/spreadsheet.d.ts +110 -0
  116. package/dist/spreadsheet.js +242 -0
  117. package/dist/spreadsheet.test.d.ts +1 -0
  118. package/dist/spreadsheet.test.js +446 -0
  119. package/dist/summaries.d.ts +12 -0
  120. package/dist/summaries.js +65 -0
  121. package/dist/sv-grid-scrollbar.js +13 -1
  122. package/dist/svgrid-wrapper.types.d.ts +31 -1
  123. package/dist/svgrid.behavior.test.js +20 -0
  124. package/dist/svgrid.comments-autocomplete.test.d.ts +1 -0
  125. package/dist/svgrid.comments-autocomplete.test.js +96 -0
  126. package/dist/svgrid.context-menu.test.d.ts +1 -0
  127. package/dist/svgrid.context-menu.test.js +102 -0
  128. package/dist/svgrid.interaction.test.js +31 -0
  129. package/dist/svgrid.new-features.wrapper.test.js +64 -6
  130. package/dist/svgrid.wrapper.test.js +27 -1
  131. package/dist/test-setup.js +9 -3
  132. package/dist/virtualization/column-virtualizer.d.ts +2 -0
  133. package/dist/virtualization/scroll-scaling.d.ts +45 -0
  134. package/dist/virtualization/scroll-scaling.js +99 -0
  135. package/dist/virtualization/scroll-scaling.test.d.ts +1 -0
  136. package/dist/virtualization/scroll-scaling.test.js +127 -0
  137. package/dist/virtualization/svelte-virtualizer.svelte.d.ts +2 -0
  138. package/dist/virtualization/svelte-virtualizer.svelte.js +2 -0
  139. package/dist/virtualization/virtualizer.d.ts +7 -0
  140. package/dist/virtualization/virtualizer.js +30 -0
  141. package/package.json +2 -1
  142. package/src/GridFooter.svelte +164 -0
  143. package/src/GridMenus.svelte +648 -0
  144. package/src/SvGrid.controller.svelte.ts +2352 -0
  145. package/src/SvGrid.css +2012 -0
  146. package/src/SvGrid.helpers.test.ts +415 -0
  147. package/src/SvGrid.helpers.ts +185 -0
  148. package/src/SvGrid.svelte +2346 -8742
  149. package/src/SvGrid.types.ts +537 -0
  150. package/src/SvGridChart.svelte +1060 -23
  151. package/src/aligned-grids.test.ts +80 -0
  152. package/src/aligned-grids.ts +87 -0
  153. package/src/build-api.coverage.test.ts +532 -0
  154. package/src/build-api.ts +683 -0
  155. package/src/cell-render.test.ts +451 -0
  156. package/src/cell-render.ts +426 -0
  157. package/src/cell-values.ts +114 -0
  158. package/src/chart-export.test.ts +370 -0
  159. package/src/chart.coverage.test.ts +814 -0
  160. package/src/chart.ts +1352 -47
  161. package/src/clipboard.test.ts +780 -0
  162. package/src/clipboard.ts +552 -0
  163. package/src/collaboration.coverage.test.ts +220 -0
  164. package/src/column-groups.test.ts +59 -0
  165. package/src/column-groups.ts +80 -0
  166. package/src/column-types.test.ts +68 -0
  167. package/src/column-types.ts +82 -0
  168. package/src/columns.test.ts +702 -0
  169. package/src/columns.ts +419 -0
  170. package/src/core.ts +86 -0
  171. package/src/css.d.ts +3 -0
  172. package/src/editing.test.ts +837 -0
  173. package/src/editing.ts +669 -0
  174. package/src/editors/cell-editors.coverage.test.ts +156 -0
  175. package/src/editors/cell-editors.ts +1 -0
  176. package/src/facet-buckets.test.ts +353 -0
  177. package/src/facet-buckets.ts +67 -0
  178. package/src/features.ts +128 -0
  179. package/src/filter-operators.test.ts +174 -0
  180. package/src/filter-operators.ts +87 -0
  181. package/src/hyperformula-adapter.test.ts +256 -0
  182. package/src/hyperformula-adapter.ts +124 -0
  183. package/src/index.ts +49 -0
  184. package/src/keyboard-handlers.coverage.test.ts +560 -0
  185. package/src/keyboard-handlers.ts +353 -0
  186. package/src/keyboard.ts +97 -97
  187. package/src/menus.test.ts +620 -0
  188. package/src/menus.ts +555 -0
  189. package/src/named-views.coverage.test.ts +210 -0
  190. package/src/named-views.ts +48 -0
  191. package/src/row-drag.test.ts +168 -0
  192. package/src/row-drag.ts +255 -0
  193. package/src/row-resize.test.ts +369 -0
  194. package/src/row-resize.ts +171 -0
  195. package/src/scroll-sync.test.ts +330 -0
  196. package/src/scroll-sync.ts +218 -0
  197. package/src/selection.multi-range.test.ts +61 -0
  198. package/src/selection.test.ts +722 -0
  199. package/src/selection.ts +579 -0
  200. package/src/server-data-source.coverage.test.ts +180 -0
  201. package/src/spreadsheet.test.ts +489 -0
  202. package/src/spreadsheet.ts +304 -0
  203. package/src/summaries.ts +204 -0
  204. package/src/sv-grid-scrollbar.ts +13 -1
  205. package/src/svgrid-wrapper.types.ts +31 -1
  206. package/src/svgrid.behavior.test.ts +22 -0
  207. package/src/svgrid.comments-autocomplete.test.ts +112 -0
  208. package/src/svgrid.context-menu.test.ts +126 -0
  209. package/src/svgrid.interaction.test.ts +30 -0
  210. package/src/svgrid.new-features.wrapper.test.ts +67 -6
  211. package/src/svgrid.wrapper.test.ts +27 -1
  212. package/src/test-setup.ts +9 -6
  213. package/src/virtualization/scroll-scaling.test.ts +148 -0
  214. package/src/virtualization/scroll-scaling.ts +121 -0
  215. package/src/virtualization/svelte-virtualizer.svelte.ts +2 -0
  216. package/src/virtualization/virtualizer.ts +26 -0
@@ -0,0 +1,180 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+ import { createServerDataSource, type ServerDataSource, type ServerRequest } from './server-data-source'
3
+
4
+ type Row = { id: number }
5
+
6
+ const flush = () => new Promise((r) => setTimeout(r, 0))
7
+
8
+ describe('createServerDataSource - request params', () => {
9
+ it('passes startRow/endRow/page/sort/filter through to getRows', async () => {
10
+ const getRows = vi.fn(async (_req: ServerRequest) => ({ rows: [], rowCount: 0 }))
11
+ const ctl = createServerDataSource<Row>({ getRows }, { pageSize: 20, onChange: () => {} })
12
+ ctl.setFilter({ global: 'abc', columns: { name: { operator: 'eq', value: 'x' } } })
13
+ await flush()
14
+ const req = getRows.mock.calls.at(-1)![0]
15
+ expect(req).toMatchObject({
16
+ startRow: 0,
17
+ endRow: 20,
18
+ pageIndex: 0,
19
+ pageSize: 20,
20
+ filterModel: { global: 'abc', columns: { name: { operator: 'eq', value: 'x' } } },
21
+ })
22
+ })
23
+
24
+ it('setFilter resets to page 0', async () => {
25
+ const getRows = vi.fn(async () => ({ rows: [], rowCount: 100 }))
26
+ const ctl = createServerDataSource<Row>({ getRows }, { pageSize: 10, onChange: () => {} })
27
+ ctl.setPage(3)
28
+ await flush()
29
+ ctl.setFilter({ global: 'q' })
30
+ await flush()
31
+ expect(ctl.getState().pageIndex).toBe(0)
32
+ const req = getRows.mock.calls.at(-1)![0]
33
+ expect(req.startRow).toBe(0)
34
+ })
35
+
36
+ it('uses the default page size of 50 when unspecified', () => {
37
+ const ctl = createServerDataSource<Row>(
38
+ { getRows: async () => ({ rows: [], rowCount: 0 }) },
39
+ { onChange: () => {} },
40
+ )
41
+ expect(ctl.getState().pageSize).toBe(50)
42
+ })
43
+ })
44
+
45
+ describe('createServerDataSource - setPage edge cases', () => {
46
+ it('clamps a negative page index to 0', async () => {
47
+ const getRows = vi.fn(async () => ({ rows: [], rowCount: 0 }))
48
+ const ctl = createServerDataSource<Row>({ getRows }, { pageSize: 10, onChange: () => {} })
49
+ ctl.setPage(5)
50
+ await flush()
51
+ getRows.mockClear()
52
+ ctl.setPage(-3)
53
+ await flush()
54
+ expect(ctl.getState().pageIndex).toBe(0)
55
+ expect(getRows).toHaveBeenCalledTimes(1)
56
+ })
57
+
58
+ it('does nothing when the page index is unchanged', async () => {
59
+ const getRows = vi.fn(async () => ({ rows: [], rowCount: 0 }))
60
+ const ctl = createServerDataSource<Row>({ getRows }, { pageSize: 10, onChange: () => {} })
61
+ await flush()
62
+ getRows.mockClear()
63
+ ctl.setPage(0) // already on page 0
64
+ await flush()
65
+ expect(getRows).not.toHaveBeenCalled()
66
+ })
67
+ })
68
+
69
+ describe('createServerDataSource - setPageSize', () => {
70
+ it('clamps page size to a minimum of 1, resets page, and re-fetches', async () => {
71
+ const getRows = vi.fn(async () => ({ rows: [], rowCount: 0 }))
72
+ const ctl = createServerDataSource<Row>({ getRows }, { pageSize: 10, onChange: () => {} })
73
+ ctl.setPage(2)
74
+ await flush()
75
+ getRows.mockClear()
76
+ ctl.setPageSize(0)
77
+ await flush()
78
+ expect(ctl.getState().pageSize).toBe(1)
79
+ expect(ctl.getState().pageIndex).toBe(0)
80
+ expect(getRows).toHaveBeenCalledTimes(1)
81
+ })
82
+
83
+ it('recomputes pageCount from total and page size', async () => {
84
+ const getRows = vi.fn(async () => ({ rows: [], rowCount: 95 }))
85
+ const ctl = createServerDataSource<Row>({ getRows }, { pageSize: 10, onChange: () => {} })
86
+ ctl.refresh()
87
+ await flush()
88
+ expect(ctl.getState().pageCount).toBe(10) // ceil(95/10)
89
+ ctl.setPageSize(20)
90
+ await flush()
91
+ expect(ctl.getState().pageCount).toBe(5) // ceil(95/20)
92
+ })
93
+ })
94
+
95
+ describe('createServerDataSource - error handling', () => {
96
+ it('captures a rejection into state.error and clears rows', async () => {
97
+ const boom = new Error('network down')
98
+ const ctl = createServerDataSource<Row>(
99
+ { getRows: async () => { throw boom } },
100
+ { pageSize: 10, onChange: () => {} },
101
+ )
102
+ ctl.refresh()
103
+ await flush()
104
+ const s = ctl.getState()
105
+ expect(s.error).toBe(boom)
106
+ expect(s.rows).toEqual([])
107
+ expect(s.loading).toBe(false)
108
+ })
109
+
110
+ it('clears a prior error on the next successful fetch', async () => {
111
+ let fail = true
112
+ const ctl = createServerDataSource<Row>(
113
+ {
114
+ getRows: async () => {
115
+ if (fail) throw new Error('x')
116
+ return { rows: [{ id: 1 }], rowCount: 1 }
117
+ },
118
+ },
119
+ { pageSize: 10, onChange: () => {} },
120
+ )
121
+ ctl.refresh()
122
+ await flush()
123
+ expect(ctl.getState().error).toBeInstanceOf(Error)
124
+ fail = false
125
+ ctl.refresh()
126
+ await flush()
127
+ expect(ctl.getState().error).toBe(null)
128
+ expect(ctl.getState().rows).toEqual([{ id: 1 }])
129
+ })
130
+
131
+ it('ignores a stale REJECTION when a newer request superseded it', async () => {
132
+ let call = 0
133
+ const src: ServerDataSource<Row> = {
134
+ getRows: vi.fn(async (req) => {
135
+ call += 1
136
+ if (call === 1) {
137
+ await new Promise((r) => setTimeout(r, 40))
138
+ throw new Error('stale failure')
139
+ }
140
+ await new Promise((r) => setTimeout(r, 5))
141
+ return { rows: [{ id: req.startRow }], rowCount: 100 }
142
+ }),
143
+ }
144
+ const ctl = createServerDataSource<Row>(src, { pageSize: 10, onChange: () => {} })
145
+ ctl.refresh() // slow + throws
146
+ ctl.setPage(2) // fast + wins
147
+ await new Promise((r) => setTimeout(r, 80))
148
+ const s = ctl.getState()
149
+ expect(s.error).toBe(null) // stale rejection did not land
150
+ expect(s.rows).toEqual([{ id: 20 }])
151
+ })
152
+ })
153
+
154
+ describe('createServerDataSource - dispose', () => {
155
+ it('refresh after dispose does not call getRows', async () => {
156
+ const getRows = vi.fn(async () => ({ rows: [], rowCount: 0 }))
157
+ const ctl = createServerDataSource<Row>({ getRows }, { pageSize: 10, onChange: () => {} })
158
+ ctl.dispose()
159
+ ctl.refresh()
160
+ await flush()
161
+ expect(getRows).not.toHaveBeenCalled()
162
+ })
163
+
164
+ it('a response resolving after dispose is ignored', async () => {
165
+ const onChange = vi.fn()
166
+ const ctl = createServerDataSource<Row>(
167
+ {
168
+ getRows: async () => {
169
+ await new Promise((r) => setTimeout(r, 30))
170
+ return { rows: [{ id: 1 }], rowCount: 1 }
171
+ },
172
+ },
173
+ { pageSize: 10, onChange },
174
+ )
175
+ ctl.refresh()
176
+ ctl.dispose()
177
+ await new Promise((r) => setTimeout(r, 60))
178
+ expect(ctl.getState().rows).toEqual([])
179
+ })
180
+ })
@@ -0,0 +1,489 @@
1
+ import { afterEach, beforeEach, describe, expect, it } from 'vitest'
2
+ import { spreadsheetLayout, spansToMerges } from './spreadsheet'
3
+ import type { SpreadsheetActionOptions, SpanColumn } from './spreadsheet'
4
+
5
+ // jsdom does not implement the global `CSS` object, which `findCell` uses via
6
+ // `CSS.escape`. Provide a minimal polyfill so the action's selector queries
7
+ // run. (A real browser ships CSS.escape; this is purely an env gap.)
8
+ if (typeof globalThis.CSS === 'undefined') {
9
+ // @ts-expect-error - minimal shim for the test environment
10
+ globalThis.CSS = { escape: (s: string) => s.replace(/["\\]/g, '\\$&') }
11
+ } else if (typeof globalThis.CSS.escape !== 'function') {
12
+ // @ts-expect-error - augment partial CSS object
13
+ globalThis.CSS.escape = (s: string) => s.replace(/["\\]/g, '\\$&')
14
+ }
15
+
16
+ // ---------------------------------------------------------------------------
17
+ // Helpers
18
+ // ---------------------------------------------------------------------------
19
+
20
+ /** Flush a queued requestAnimationFrame callback. The action batches its
21
+ * work into one rAF, so tests must advance a frame to observe the effect. */
22
+ function flushFrame(): Promise<void> {
23
+ return new Promise((resolve) => {
24
+ // Two rAFs: the first lets any already-queued callback run, the second
25
+ // guarantees we resolve AFTER that callback has executed.
26
+ requestAnimationFrame(() => requestAnimationFrame(() => resolve()))
27
+ })
28
+ }
29
+
30
+ /** Build a `<table>` with a header-less body of `rows` x `cols`. Each TD is
31
+ * tagged with `data-svgrid-row` (display index) + `data-col-id` exactly the
32
+ * way SvGrid emits them, which is what the layout helper queries on. */
33
+ function buildGrid(
34
+ rows: number,
35
+ columnOrder: readonly string[],
36
+ ): { host: HTMLElement; cellAt: (r: number, colId: string) => HTMLTableCellElement } {
37
+ const host = document.createElement('div')
38
+ const table = document.createElement('table')
39
+ const tbody = document.createElement('tbody')
40
+ for (let r = 0; r < rows; r += 1) {
41
+ const tr = document.createElement('tr')
42
+ for (const colId of columnOrder) {
43
+ const td = document.createElement('td')
44
+ td.setAttribute('data-svgrid-row', String(r))
45
+ td.setAttribute('data-col-id', colId)
46
+ td.textContent = `${colId}-${r}`
47
+ tr.appendChild(td)
48
+ }
49
+ tbody.appendChild(tr)
50
+ }
51
+ table.appendChild(tbody)
52
+ host.appendChild(table)
53
+ document.body.appendChild(host)
54
+
55
+ const cellAt = (r: number, colId: string): HTMLTableCellElement => {
56
+ const el = host.querySelector<HTMLTableCellElement>(
57
+ `td[data-svgrid-row="${r}"][data-col-id="${colId}"]`,
58
+ )
59
+ if (!el) throw new Error(`no cell at row=${r} col=${colId}`)
60
+ return el
61
+ }
62
+ return { host, cellAt }
63
+ }
64
+
65
+ let hosts: HTMLElement[] = []
66
+ function track(host: HTMLElement): HTMLElement {
67
+ hosts.push(host)
68
+ return host
69
+ }
70
+
71
+ beforeEach(() => {
72
+ hosts = []
73
+ })
74
+ afterEach(() => {
75
+ for (const h of hosts) h.remove()
76
+ document.body.innerHTML = ''
77
+ })
78
+
79
+ // ---------------------------------------------------------------------------
80
+ // Merges
81
+ // ---------------------------------------------------------------------------
82
+
83
+ describe('spreadsheetLayout - merges', () => {
84
+ it('applies colspan + hides covered cells horizontally', async () => {
85
+ const cols = ['a', 'b', 'c']
86
+ const { host, cellAt } = buildGrid(2, cols)
87
+ track(host)
88
+ const action = spreadsheetLayout(host, {
89
+ columnOrder: cols,
90
+ merges: [{ rowIndex: 0, columnId: 'a', colspan: 2 }],
91
+ })
92
+ await flushFrame()
93
+
94
+ const origin = cellAt(0, 'a')
95
+ expect(origin.getAttribute('colspan')).toBe('2')
96
+ expect(origin.hasAttribute('rowspan')).toBe(false)
97
+ expect(origin.getAttribute('data-svgrid-sheet')).toBe('')
98
+ // Covered neighbour to the right is hidden + marked.
99
+ expect(cellAt(0, 'b').style.display).toBe('none')
100
+ expect(cellAt(0, 'b').getAttribute('data-svgrid-sheet')).toBe('')
101
+ // Untouched cells stay visible.
102
+ expect(cellAt(0, 'c').style.display).toBe('')
103
+ expect(cellAt(1, 'a').style.display).toBe('')
104
+
105
+ action.destroy()
106
+ })
107
+
108
+ it('applies rowspan + hides covered cells vertically', async () => {
109
+ const cols = ['a', 'b']
110
+ const { host, cellAt } = buildGrid(3, cols)
111
+ track(host)
112
+ const action = spreadsheetLayout(host, {
113
+ columnOrder: cols,
114
+ merges: [{ rowIndex: 0, columnId: 'a', rowspan: 2 }],
115
+ })
116
+ await flushFrame()
117
+
118
+ const origin = cellAt(0, 'a')
119
+ expect(origin.getAttribute('rowspan')).toBe('2')
120
+ expect(origin.hasAttribute('colspan')).toBe(false)
121
+ expect(cellAt(1, 'a').style.display).toBe('none')
122
+ expect(cellAt(2, 'a').style.display).toBe('') // outside the span
123
+ action.destroy()
124
+ })
125
+
126
+ it('handles a rectangular colspan + rowspan block', async () => {
127
+ const cols = ['a', 'b', 'c']
128
+ const { host, cellAt } = buildGrid(3, cols)
129
+ track(host)
130
+ const action = spreadsheetLayout(host, {
131
+ columnOrder: cols,
132
+ merges: [{ rowIndex: 0, columnId: 'a', colspan: 2, rowspan: 2 }],
133
+ })
134
+ await flushFrame()
135
+
136
+ expect(cellAt(0, 'a').getAttribute('colspan')).toBe('2')
137
+ expect(cellAt(0, 'a').getAttribute('rowspan')).toBe('2')
138
+ // All covered cells except the origin are hidden.
139
+ expect(cellAt(0, 'b').style.display).toBe('none')
140
+ expect(cellAt(1, 'a').style.display).toBe('none')
141
+ expect(cellAt(1, 'b').style.display).toBe('none')
142
+ // c column + row 2 untouched.
143
+ expect(cellAt(0, 'c').style.display).toBe('')
144
+ expect(cellAt(2, 'a').style.display).toBe('')
145
+ action.destroy()
146
+ })
147
+
148
+ it('clamps zero/negative span to a minimum of 1 (no colspan/rowspan attr)', async () => {
149
+ const cols = ['a', 'b']
150
+ const { host, cellAt } = buildGrid(2, cols)
151
+ track(host)
152
+ const action = spreadsheetLayout(host, {
153
+ columnOrder: cols,
154
+ merges: [{ rowIndex: 0, columnId: 'a', colspan: 0, rowspan: -5 }],
155
+ })
156
+ await flushFrame()
157
+ const origin = cellAt(0, 'a')
158
+ // Clamped to 1, so no span attributes are written, but it is still marked.
159
+ expect(origin.hasAttribute('colspan')).toBe(false)
160
+ expect(origin.hasAttribute('rowspan')).toBe(false)
161
+ expect(origin.getAttribute('data-svgrid-sheet')).toBe('')
162
+ expect(cellAt(0, 'b').style.display).toBe('') // nothing covered
163
+ action.destroy()
164
+ })
165
+
166
+ it('skips a merge whose columnId is not in columnOrder', async () => {
167
+ const cols = ['a', 'b']
168
+ const { host, cellAt } = buildGrid(1, cols)
169
+ track(host)
170
+ const action = spreadsheetLayout(host, {
171
+ columnOrder: cols,
172
+ merges: [{ rowIndex: 0, columnId: 'ghost', colspan: 2 }],
173
+ })
174
+ await flushFrame()
175
+ expect(cellAt(0, 'a').hasAttribute('data-svgrid-sheet')).toBe(false)
176
+ expect(cellAt(0, 'b').style.display).toBe('')
177
+ action.destroy()
178
+ })
179
+
180
+ it('skips a merge whose origin cell is not rendered', async () => {
181
+ const cols = ['a', 'b']
182
+ const { host, cellAt } = buildGrid(1, cols)
183
+ track(host)
184
+ const action = spreadsheetLayout(host, {
185
+ columnOrder: cols,
186
+ merges: [{ rowIndex: 99, columnId: 'a', colspan: 2 }],
187
+ })
188
+ await flushFrame()
189
+ // Nothing marked anywhere.
190
+ expect(host.querySelectorAll('[data-svgrid-sheet]').length).toBe(0)
191
+ expect(cellAt(0, 'a').style.display).toBe('')
192
+ action.destroy()
193
+ })
194
+
195
+ it('ignores covered cells that fall outside the columnOrder or render window', async () => {
196
+ const cols = ['a', 'b']
197
+ // Only 1 row rendered, but ask for a colspan that runs off the column
198
+ // list AND a rowspan that runs off the rendered rows.
199
+ const { host, cellAt } = buildGrid(1, cols)
200
+ track(host)
201
+ const action = spreadsheetLayout(host, {
202
+ columnOrder: cols,
203
+ merges: [{ rowIndex: 0, columnId: 'b', colspan: 3, rowspan: 3 }],
204
+ })
205
+ await flushFrame()
206
+ const origin = cellAt(0, 'b')
207
+ expect(origin.getAttribute('colspan')).toBe('3')
208
+ expect(origin.getAttribute('rowspan')).toBe('3')
209
+ // No sibling to the right of b, and rows 1/2 don't exist - so the only
210
+ // marked cell is the origin itself.
211
+ expect(host.querySelectorAll('[data-svgrid-sheet]').length).toBe(1)
212
+ action.destroy()
213
+ })
214
+ })
215
+
216
+ // ---------------------------------------------------------------------------
217
+ // Selection-edge inheritance
218
+ // ---------------------------------------------------------------------------
219
+
220
+ describe('spreadsheetLayout - selection edge inheritance', () => {
221
+ it('mirrors range-right / range-bottom / selected-range flags onto the origin', async () => {
222
+ const cols = ['a', 'b']
223
+ const { host, cellAt } = buildGrid(2, cols)
224
+ track(host)
225
+ // Mark the far covered cell with range edge flags BEFORE applying.
226
+ cellAt(1, 'b').setAttribute('data-range-right', 'true')
227
+ cellAt(1, 'b').setAttribute('data-range-bottom', 'true')
228
+ cellAt(0, 'b').setAttribute('data-selected-range', 'true')
229
+
230
+ const action = spreadsheetLayout(host, {
231
+ columnOrder: cols,
232
+ merges: [{ rowIndex: 0, columnId: 'a', colspan: 2, rowspan: 2 }],
233
+ })
234
+ await flushFrame()
235
+ const origin = cellAt(0, 'a')
236
+ expect(origin.classList.contains('sv-merge-edge-right')).toBe(true)
237
+ expect(origin.classList.contains('sv-merge-edge-bottom')).toBe(true)
238
+ expect(origin.classList.contains('sv-merge-in-range')).toBe(true)
239
+ action.destroy()
240
+ })
241
+
242
+ it('leaves edge classes off when no range flags are present', async () => {
243
+ const cols = ['a', 'b']
244
+ const { host, cellAt } = buildGrid(2, cols)
245
+ track(host)
246
+ const action = spreadsheetLayout(host, {
247
+ columnOrder: cols,
248
+ merges: [{ rowIndex: 0, columnId: 'a', colspan: 2, rowspan: 2 }],
249
+ })
250
+ await flushFrame()
251
+ const origin = cellAt(0, 'a')
252
+ expect(origin.classList.contains('sv-merge-edge-right')).toBe(false)
253
+ expect(origin.classList.contains('sv-merge-edge-bottom')).toBe(false)
254
+ expect(origin.classList.contains('sv-merge-in-range')).toBe(false)
255
+ action.destroy()
256
+ })
257
+
258
+ it('treats the origin own selected-range flag as in-range', async () => {
259
+ const cols = ['a']
260
+ const { host, cellAt } = buildGrid(1, cols)
261
+ track(host)
262
+ cellAt(0, 'a').setAttribute('data-selected-range', 'true')
263
+ const action = spreadsheetLayout(host, {
264
+ columnOrder: cols,
265
+ merges: [{ rowIndex: 0, columnId: 'a' }],
266
+ })
267
+ await flushFrame()
268
+ expect(cellAt(0, 'a').classList.contains('sv-merge-in-range')).toBe(true)
269
+ action.destroy()
270
+ })
271
+ })
272
+
273
+ // ---------------------------------------------------------------------------
274
+ // Borders
275
+ // ---------------------------------------------------------------------------
276
+
277
+ describe('spreadsheetLayout - borders', () => {
278
+ it('injects an overlay with the requested edge styles', async () => {
279
+ const cols = ['a']
280
+ const { host, cellAt } = buildGrid(1, cols)
281
+ track(host)
282
+ const action = spreadsheetLayout(host, {
283
+ columnOrder: cols,
284
+ borders: [
285
+ {
286
+ rowIndex: 0,
287
+ columnId: 'a',
288
+ top: { width: 3, style: 'dashed', color: 'red' },
289
+ bottom: {}, // defaults: 2px solid currentColor
290
+ },
291
+ ],
292
+ })
293
+ await flushFrame()
294
+ const td = cellAt(0, 'a')
295
+ const overlay = td.querySelector<HTMLElement>('.sv-cell-border-overlay')
296
+ expect(overlay).not.toBeNull()
297
+ expect(overlay!.style.borderTop).toBe('3px dashed red')
298
+ // jsdom's CSSOM drops the `currentColor` keyword from the border
299
+ // shorthand, but the width + style survive, confirming the default
300
+ // (2px solid) edge was emitted.
301
+ expect(overlay!.style.borderBottom).toContain('2px solid')
302
+ // No left/right set.
303
+ expect(overlay!.style.borderLeft).toBe('')
304
+ expect(td.getAttribute('data-svgrid-sheet')).toBe('')
305
+ // The TD becomes a positioning context.
306
+ expect(td.style.position).toBe('relative')
307
+ action.destroy()
308
+ })
309
+
310
+ it('skips a border spec with no edges set (no overlay injected)', async () => {
311
+ const cols = ['a']
312
+ const { host, cellAt } = buildGrid(1, cols)
313
+ track(host)
314
+ const action = spreadsheetLayout(host, {
315
+ columnOrder: cols,
316
+ borders: [{ rowIndex: 0, columnId: 'a' }],
317
+ })
318
+ await flushFrame()
319
+ expect(cellAt(0, 'a').querySelector('.sv-cell-border-overlay')).toBeNull()
320
+ expect(cellAt(0, 'a').hasAttribute('data-svgrid-sheet')).toBe(false)
321
+ action.destroy()
322
+ })
323
+
324
+ it('skips a border spec whose target cell is absent', async () => {
325
+ const cols = ['a']
326
+ const { host } = buildGrid(1, cols)
327
+ track(host)
328
+ const action = spreadsheetLayout(host, {
329
+ columnOrder: cols,
330
+ borders: [{ rowIndex: 5, columnId: 'a', top: { width: 1 } }],
331
+ })
332
+ await flushFrame()
333
+ expect(host.querySelectorAll('.sv-cell-border-overlay').length).toBe(0)
334
+ action.destroy()
335
+ })
336
+
337
+ it('does not override an already-positioned TD', async () => {
338
+ const cols = ['a']
339
+ const { host, cellAt } = buildGrid(1, cols)
340
+ track(host)
341
+ cellAt(0, 'a').style.position = 'absolute'
342
+ const action = spreadsheetLayout(host, {
343
+ columnOrder: cols,
344
+ borders: [{ rowIndex: 0, columnId: 'a', left: { color: 'blue' } }],
345
+ })
346
+ await flushFrame()
347
+ expect(cellAt(0, 'a').style.position).toBe('absolute')
348
+ action.destroy()
349
+ })
350
+ })
351
+
352
+ // ---------------------------------------------------------------------------
353
+ // Cleanup + update + destroy
354
+ // ---------------------------------------------------------------------------
355
+
356
+ describe('spreadsheetLayout - update + cleanup', () => {
357
+ it('clears prior decorations on the next apply (update path)', async () => {
358
+ const cols = ['a', 'b']
359
+ const { host, cellAt } = buildGrid(2, cols)
360
+ track(host)
361
+ const action = spreadsheetLayout(host, {
362
+ columnOrder: cols,
363
+ merges: [{ rowIndex: 0, columnId: 'a', colspan: 2 }],
364
+ borders: [{ rowIndex: 1, columnId: 'a', top: { width: 1 } }],
365
+ })
366
+ await flushFrame()
367
+ expect(cellAt(0, 'a').getAttribute('colspan')).toBe('2')
368
+ expect(cellAt(1, 'a').querySelector('.sv-cell-border-overlay')).not.toBeNull()
369
+
370
+ // Update to an empty spec - everything from the previous run is removed.
371
+ action.update({ columnOrder: cols, merges: [], borders: [] })
372
+ await flushFrame()
373
+ expect(cellAt(0, 'a').hasAttribute('colspan')).toBe(false)
374
+ expect(cellAt(0, 'b').style.display).toBe('')
375
+ expect(cellAt(0, 'a').hasAttribute('data-svgrid-sheet')).toBe(false)
376
+ expect(cellAt(1, 'a').querySelector('.sv-cell-border-overlay')).toBeNull()
377
+ action.destroy()
378
+ })
379
+
380
+ it('re-applies decorations when the grid body mutates (MutationObserver)', async () => {
381
+ const cols = ['a', 'b']
382
+ const { host, cellAt } = buildGrid(1, cols)
383
+ track(host)
384
+ const action = spreadsheetLayout(host, {
385
+ columnOrder: cols,
386
+ merges: [{ rowIndex: 1, columnId: 'a', colspan: 2 }],
387
+ })
388
+ await flushFrame()
389
+ // Row 1 does not exist yet - nothing applied.
390
+ expect(host.querySelectorAll('[data-svgrid-sheet]').length).toBe(0)
391
+
392
+ // Simulate the grid rendering a new row -> observer schedules apply.
393
+ const tbody = host.querySelector('tbody')!
394
+ const tr = document.createElement('tr')
395
+ for (const colId of cols) {
396
+ const td = document.createElement('td')
397
+ td.setAttribute('data-svgrid-row', '1')
398
+ td.setAttribute('data-col-id', colId)
399
+ tr.appendChild(td)
400
+ }
401
+ tbody.appendChild(tr)
402
+ await flushFrame()
403
+ await flushFrame()
404
+ expect(cellAt(1, 'a').getAttribute('colspan')).toBe('2')
405
+ action.destroy()
406
+ })
407
+
408
+ it('destroy disconnects the observer and cancels a pending frame', async () => {
409
+ const cols = ['a', 'b']
410
+ const { host, cellAt } = buildGrid(1, cols)
411
+ track(host)
412
+ // Destroy immediately - the first scheduled frame is pending.
413
+ const action = spreadsheetLayout(host, {
414
+ columnOrder: cols,
415
+ merges: [{ rowIndex: 0, columnId: 'a', colspan: 2 }],
416
+ })
417
+ action.destroy()
418
+ await flushFrame()
419
+ await flushFrame()
420
+ // Frame was cancelled before apply ran.
421
+ expect(cellAt(0, 'a').hasAttribute('colspan')).toBe(false)
422
+
423
+ // After destroy, mutations no longer trigger apply.
424
+ const tbody = host.querySelector('tbody')!
425
+ tbody.appendChild(document.createElement('tr'))
426
+ await flushFrame()
427
+ await flushFrame()
428
+ expect(cellAt(0, 'a').hasAttribute('colspan')).toBe(false)
429
+ })
430
+
431
+ it('treats null merges / borders as empty (no throw)', async () => {
432
+ const cols = ['a']
433
+ const { host } = buildGrid(1, cols)
434
+ track(host)
435
+ const opts: SpreadsheetActionOptions = {
436
+ columnOrder: cols,
437
+ merges: null,
438
+ borders: null,
439
+ }
440
+ const action = spreadsheetLayout(host, opts)
441
+ await flushFrame()
442
+ expect(host.querySelectorAll('[data-svgrid-sheet]').length).toBe(0)
443
+ action.destroy()
444
+ })
445
+ })
446
+
447
+ describe('spansToMerges - declarative colSpan/rowSpan -> MergeSpec[]', () => {
448
+ type Row = { region: string; q: string; amt: number }
449
+ const rows: Row[] = [
450
+ { region: 'AMER', q: 'Q1', amt: 1 },
451
+ { region: 'AMER', q: 'Q2', amt: 2 },
452
+ { region: 'AMER', q: 'Q3', amt: 3 },
453
+ { region: 'EMEA', q: 'Q1', amt: 4 },
454
+ { region: 'EMEA', q: 'Q2', amt: 5 },
455
+ ]
456
+ // Merge each run of equal `region` values downward.
457
+ function regionRowSpan(): SpanColumn<Row>['rowSpan'] {
458
+ return ({ data, rowIndex }) => {
459
+ if (rowIndex > 0 && rows[rowIndex - 1]!.region === data.region) return 1 // covered
460
+ let n = 1
461
+ while (rows[rowIndex + n]?.region === data.region) n += 1
462
+ return n
463
+ }
464
+ }
465
+
466
+ it('emits a rowspan merge at each run origin and skips covered rows', () => {
467
+ const columns: SpanColumn<Row>[] = [{ id: 'region', field: 'region', rowSpan: regionRowSpan() }]
468
+ const merges = spansToMerges(rows, columns)
469
+ // AMER spans rows 0..2 (rowspan 3), EMEA spans rows 3..4 (rowspan 2).
470
+ expect(merges).toEqual([
471
+ { rowIndex: 0, columnId: 'region', colspan: undefined, rowspan: 3 },
472
+ { rowIndex: 3, columnId: 'region', colspan: undefined, rowspan: 2 },
473
+ ])
474
+ })
475
+
476
+ it('supports colSpan and marks covered columns', () => {
477
+ const columns: SpanColumn<Row>[] = [
478
+ { id: 'a', field: 'region', colSpan: ({ rowIndex }) => (rowIndex === 0 ? 2 : 1) },
479
+ { id: 'b', field: 'q' },
480
+ { id: 'c', field: 'amt' },
481
+ ]
482
+ const merges = spansToMerges(rows.slice(0, 1), columns)
483
+ expect(merges).toEqual([{ rowIndex: 0, columnId: 'a', colspan: 2, rowspan: undefined }])
484
+ })
485
+
486
+ it('returns no merges when no column defines spans', () => {
487
+ expect(spansToMerges(rows, [{ id: 'region', field: 'region' }])).toEqual([])
488
+ })
489
+ })