@svgrid/grid 1.2.21 → 1.2.23

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 (190) hide show
  1. package/dist/GridFooter.svelte +34 -20
  2. package/dist/GridFooter.svelte.d.ts +8 -0
  3. package/dist/SvAutoComplete.svelte +100 -0
  4. package/dist/SvAutoComplete.svelte.d.ts +16 -0
  5. package/dist/SvButton.svelte +97 -0
  6. package/dist/SvButton.svelte.d.ts +23 -0
  7. package/dist/SvCalendar.svelte +669 -0
  8. package/dist/SvCalendar.svelte.d.ts +70 -0
  9. package/dist/SvCheckBox.svelte +81 -0
  10. package/dist/SvCheckBox.svelte.d.ts +19 -0
  11. package/dist/SvColorInput.svelte +187 -0
  12. package/dist/SvColorInput.svelte.d.ts +15 -0
  13. package/dist/SvComboBox.svelte +130 -0
  14. package/dist/SvComboBox.svelte.d.ts +15 -0
  15. package/dist/SvCountryInput.svelte +123 -0
  16. package/dist/SvCountryInput.svelte.d.ts +14 -0
  17. package/dist/SvDateTimePicker.svelte +322 -0
  18. package/dist/SvDateTimePicker.svelte.d.ts +37 -0
  19. package/dist/SvDropDownList.svelte +143 -0
  20. package/dist/SvDropDownList.svelte.d.ts +15 -0
  21. package/dist/SvForm.svelte +147 -0
  22. package/dist/SvForm.svelte.d.ts +29 -0
  23. package/dist/SvGauge.svelte +99 -0
  24. package/dist/SvGauge.svelte.d.ts +31 -0
  25. package/dist/SvGrid.controller.svelte.d.ts +16 -2
  26. package/dist/SvGrid.controller.svelte.js +63 -8
  27. package/dist/SvGrid.css +84 -31
  28. package/dist/SvGrid.helpers.d.ts +4 -0
  29. package/dist/SvGrid.helpers.js +40 -12
  30. package/dist/SvGrid.svelte +84 -5
  31. package/dist/SvGrid.types.d.ts +36 -0
  32. package/dist/SvGridDropdown.svelte +16 -30
  33. package/dist/SvGridDropdown.svelte.d.ts +4 -0
  34. package/dist/SvListBox.svelte +122 -0
  35. package/dist/SvListBox.svelte.d.ts +19 -0
  36. package/dist/SvMaskedInput.svelte +0 -0
  37. package/dist/SvMaskedInput.svelte.d.ts +15 -0
  38. package/dist/SvNumberInput.svelte +0 -0
  39. package/dist/SvNumberInput.svelte.d.ts +22 -0
  40. package/dist/SvPasswordInput.svelte +110 -0
  41. package/dist/SvPasswordInput.svelte.d.ts +22 -0
  42. package/dist/SvPhoneInput.svelte +0 -0
  43. package/dist/SvPhoneInput.svelte.d.ts +19 -0
  44. package/dist/SvRadioGroup.svelte +108 -0
  45. package/dist/SvRadioGroup.svelte.d.ts +23 -0
  46. package/dist/SvRating.svelte +111 -0
  47. package/dist/SvRating.svelte.d.ts +20 -0
  48. package/dist/SvRepeatButton.svelte +89 -0
  49. package/dist/SvRepeatButton.svelte.d.ts +21 -0
  50. package/dist/SvSlider.svelte +182 -0
  51. package/dist/SvSlider.svelte.d.ts +25 -0
  52. package/dist/SvSwitchButton.svelte +94 -0
  53. package/dist/SvSwitchButton.svelte.d.ts +19 -0
  54. package/dist/SvTabs.svelte +122 -0
  55. package/dist/SvTabs.svelte.d.ts +26 -0
  56. package/dist/SvTagsInput.svelte +81 -0
  57. package/dist/SvTagsInput.svelte.d.ts +19 -0
  58. package/dist/SvTimePicker.svelte +359 -0
  59. package/dist/SvTimePicker.svelte.d.ts +27 -0
  60. package/dist/SvToggleButton.svelte +57 -0
  61. package/dist/SvToggleButton.svelte.d.ts +16 -0
  62. package/dist/SvTree.svelte +210 -0
  63. package/dist/SvTree.svelte.d.ts +29 -0
  64. package/dist/build-api.js +78 -1
  65. package/dist/cdn/svgrid.js +10022 -5904
  66. package/dist/cdn/svgrid.svelte-external.js +8531 -4429
  67. package/dist/cell-render.d.ts +4 -0
  68. package/dist/cell-render.js +35 -1
  69. package/dist/clipboard.js +19 -1
  70. package/dist/collaboration.d.ts +2 -0
  71. package/dist/collaboration.js +4 -0
  72. package/dist/core.d.ts +22 -1
  73. package/dist/countries.d.ts +15 -0
  74. package/dist/countries.js +61 -0
  75. package/dist/datetime/date-core.d.ts +88 -0
  76. package/dist/datetime/date-core.js +165 -0
  77. package/dist/datetime/date-format.d.ts +39 -0
  78. package/dist/datetime/date-format.js +371 -0
  79. package/dist/datetime/date-restrict.d.ts +23 -0
  80. package/dist/datetime/date-restrict.js +50 -0
  81. package/dist/datetime/date-selection.d.ts +25 -0
  82. package/dist/datetime/date-selection.js +94 -0
  83. package/dist/datetime/mask.d.ts +21 -0
  84. package/dist/datetime/mask.js +90 -0
  85. package/dist/editing.d.ts +1 -1
  86. package/dist/editing.js +7 -0
  87. package/dist/editors/cell-editors.d.ts +2 -2
  88. package/dist/editors/cell-editors.js +3 -1
  89. package/dist/export-format.d.ts +178 -0
  90. package/dist/export-format.js +419 -0
  91. package/dist/hyperformula-adapter.d.ts +4 -0
  92. package/dist/hyperformula-adapter.js +15 -6
  93. package/dist/index.d.ts +36 -0
  94. package/dist/index.js +41 -0
  95. package/dist/list-option.d.ts +10 -0
  96. package/dist/list-option.js +7 -0
  97. package/dist/menus.js +18 -2
  98. package/dist/popover.d.ts +48 -0
  99. package/dist/popover.js +65 -0
  100. package/dist/row-resize.d.ts +4 -4
  101. package/dist/row-resize.js +8 -5
  102. package/dist/selection.d.ts +6 -0
  103. package/dist/selection.js +31 -5
  104. package/dist/server-data-source.d.ts +43 -0
  105. package/dist/server-data-source.js +100 -0
  106. package/dist/sparkline.js +8 -4
  107. package/dist/svgrid-wrapper.types.d.ts +26 -1
  108. package/package.json +6 -1
  109. package/src/GridFooter.svelte +34 -20
  110. package/src/SvAutoComplete.svelte +100 -0
  111. package/src/SvButton.svelte +97 -0
  112. package/src/SvCalendar.svelte +669 -0
  113. package/src/SvCalendar.test.ts +211 -0
  114. package/src/SvCheckBox.svelte +81 -0
  115. package/src/SvColorInput.svelte +187 -0
  116. package/src/SvComboBox.svelte +130 -0
  117. package/src/SvCountryInput.svelte +123 -0
  118. package/src/SvDateTimePicker.svelte +322 -0
  119. package/src/SvDateTimePicker.test.ts +136 -0
  120. package/src/SvDropDownList.svelte +143 -0
  121. package/src/SvForm.svelte +147 -0
  122. package/src/SvGauge.svelte +99 -0
  123. package/src/SvGrid.controller.svelte.ts +74 -8
  124. package/src/SvGrid.css +84 -31
  125. package/src/SvGrid.helpers.ts +41 -12
  126. package/src/SvGrid.svelte +84 -5
  127. package/src/SvGrid.types.ts +33 -0
  128. package/src/SvGridDropdown.svelte +16 -30
  129. package/src/SvListBox.svelte +122 -0
  130. package/src/SvMaskedInput.svelte +0 -0
  131. package/src/SvNumberInput.svelte +0 -0
  132. package/src/SvPasswordInput.svelte +110 -0
  133. package/src/SvPhoneInput.svelte +0 -0
  134. package/src/SvRadioGroup.svelte +108 -0
  135. package/src/SvRating.svelte +111 -0
  136. package/src/SvRepeatButton.svelte +89 -0
  137. package/src/SvSlider.svelte +182 -0
  138. package/src/SvSwitchButton.svelte +94 -0
  139. package/src/SvTabs.svelte +122 -0
  140. package/src/SvTagsInput.svelte +81 -0
  141. package/src/SvTimePicker.svelte +359 -0
  142. package/src/SvTimePicker.test.ts +98 -0
  143. package/src/SvToggleButton.svelte +57 -0
  144. package/src/SvTree.svelte +210 -0
  145. package/src/build-api.ts +115 -0
  146. package/src/cell-render.test.ts +38 -0
  147. package/src/cell-render.ts +43 -0
  148. package/src/clipboard.test.ts +18 -0
  149. package/src/clipboard.ts +24 -1
  150. package/src/collaboration.test.ts +30 -0
  151. package/src/collaboration.ts +6 -0
  152. package/src/core.ts +27 -3
  153. package/src/countries.ts +71 -0
  154. package/src/datetime/date-core.test.ts +217 -0
  155. package/src/datetime/date-core.ts +204 -0
  156. package/src/datetime/date-format.test.ts +121 -0
  157. package/src/datetime/date-format.ts +317 -0
  158. package/src/datetime/date-restrict.ts +60 -0
  159. package/src/datetime/date-selection.test.ts +129 -0
  160. package/src/datetime/date-selection.ts +137 -0
  161. package/src/datetime/mask.test.ts +36 -0
  162. package/src/datetime/mask.ts +84 -0
  163. package/src/editing.test.ts +22 -0
  164. package/src/editing.ts +7 -1
  165. package/src/editors/cell-editors.ts +7 -1
  166. package/src/export-data-api.test.ts +126 -0
  167. package/src/export-format.test.ts +107 -0
  168. package/src/export-format.ts +598 -0
  169. package/src/hyperformula-adapter.test.ts +35 -1
  170. package/src/hyperformula-adapter.ts +18 -6
  171. package/src/index.ts +71 -0
  172. package/src/list-option.ts +15 -0
  173. package/src/menus.ts +21 -2
  174. package/src/popover.ts +79 -0
  175. package/src/row-resize.test.ts +25 -0
  176. package/src/row-resize.ts +8 -5
  177. package/src/selection.test.ts +36 -4
  178. package/src/selection.ts +30 -9
  179. package/src/server-data-source.test.ts +201 -0
  180. package/src/server-data-source.ts +148 -0
  181. package/src/sparkline.test.ts +9 -0
  182. package/src/sparkline.ts +9 -4
  183. package/src/svgrid-wrapper.types.ts +28 -1
  184. package/src/svgrid.behavior.test.ts +27 -0
  185. package/src/svgrid.new-features.wrapper.test.ts +27 -1
  186. package/src/ui-buttons.test.ts +105 -0
  187. package/src/ui-composite.test.ts +89 -0
  188. package/src/ui-inputs.test.ts +92 -0
  189. package/src/ui-range.test.ts +61 -0
  190. package/src/ui-selection.test.ts +106 -0
@@ -0,0 +1,598 @@
1
+ /**
2
+ * Pure, render-free value formatting for data export. The grid's on-screen
3
+ * `formatCellValue` (see cell-render.ts) is a closure bound to a `Row<TData>`
4
+ * and the live table, so it can't be reused directly by an exporter that only
5
+ * has raw values + a column's `format` config. These helpers replicate the
6
+ * numeric / date / percent branches of that formatter as standalone functions:
7
+ *
8
+ * - `formatValueForExport(value, format)` returns the display STRING a user
9
+ * sees on screen, so CSV / TSV / HTML / PDF exports are faithful to the
10
+ * grid ("what you see is what you export") instead of dumping raw values.
11
+ * - `toExcelNumFmt(format)` maps a `CellFormatConfig` to an Excel number
12
+ * format code, so an xlsx cell can stay a real number / date while still
13
+ * displaying formatted (currency symbol, thousands, date pattern).
14
+ *
15
+ * Custom per-row `formatter` callbacks are intentionally NOT handled here -
16
+ * they may close over row/table state. Columns that need custom export text
17
+ * should provide an `exportValue(row)` hook at the export layer instead.
18
+ */
19
+ import type { CellFormatConfig } from './core'
20
+ import {
21
+ formatNumericWithConfig,
22
+ getDateFormatter,
23
+ resolveDatePattern,
24
+ } from './cell-formatting'
25
+
26
+ // Re-export the pure conditional-formatting engine here too, so the
27
+ // Svelte-free `@svgrid/grid/format` subpath carries it for @svgrid/enterprise's
28
+ // export code (which must not pull in SvGrid.svelte).
29
+ export {
30
+ computeColumnStat,
31
+ contrastText,
32
+ formatsNeedingStats,
33
+ resolveCellFormat,
34
+ type ColumnStat,
35
+ type ConditionalFormat,
36
+ type ResolvedCellFormat,
37
+ } from './conditional-formatting'
38
+
39
+ /** Best-effort coercion of a cell value to a Date. Accepts Date, epoch ms
40
+ * numbers, and parseable date strings. Returns null when it isn't a date. */
41
+ export function coerceExportDate(value: unknown): Date | null {
42
+ if (value instanceof Date) return Number.isNaN(value.getTime()) ? null : value
43
+ if (typeof value === 'number' && Number.isFinite(value)) {
44
+ const d = new Date(value)
45
+ return Number.isNaN(d.getTime()) ? null : d
46
+ }
47
+ if (typeof value === 'string' && value.trim() !== '') {
48
+ const d = new Date(value)
49
+ return Number.isNaN(d.getTime()) ? null : d
50
+ }
51
+ return null
52
+ }
53
+
54
+ /**
55
+ * Format a raw cell value to its on-screen display string using the column's
56
+ * `format` config. Mirrors the grid's own numeric / currency / percent / date
57
+ * branches. Values with no (or an unrecognised) format fall back to
58
+ * `String(value)`, and `null` / `undefined` become an empty string.
59
+ */
60
+ export function formatValueForExport(
61
+ value: unknown,
62
+ format: CellFormatConfig | undefined,
63
+ ): string {
64
+ if (value == null) return ''
65
+ if (!format) return String(value)
66
+
67
+ if (format.type === 'number' || format.type === 'currency' || format.type === 'percent') {
68
+ return formatNumericWithConfig(value, {
69
+ type: format.type,
70
+ locales: format.locales,
71
+ currency: format.type === 'currency' ? (format.currency ?? 'USD') : undefined,
72
+ valueIsPercentPoints:
73
+ format.type === 'percent' ? format.valueIsPercentPoints : undefined,
74
+ options: format.options,
75
+ })
76
+ }
77
+
78
+ if (format.type === 'date' || format.type === 'datetime') {
79
+ const parsed = coerceExportDate(value)
80
+ if (parsed) {
81
+ const preset = resolveDatePattern(format.pattern, format.type)
82
+ const merged: Intl.DateTimeFormatOptions =
83
+ preset || format.options
84
+ ? { ...preset, ...format.options }
85
+ : format.type === 'date'
86
+ ? { year: 'numeric', month: '2-digit', day: '2-digit' }
87
+ : {
88
+ year: 'numeric',
89
+ month: '2-digit',
90
+ day: '2-digit',
91
+ hour: '2-digit',
92
+ minute: '2-digit',
93
+ }
94
+ return getDateFormatter(format.locales, merged).format(parsed)
95
+ }
96
+ }
97
+
98
+ return String(value)
99
+ }
100
+
101
+ /**
102
+ * Map a `CellFormatConfig` to an Excel/OOXML number-format code, so an xlsx
103
+ * writer can keep the cell numeric/date while displaying it formatted.
104
+ * Returns `undefined` when the format has no natural Excel representation
105
+ * (or the caller should just write a string).
106
+ *
107
+ * These are deliberately conservative, widely-recognised codes:
108
+ * number → `#,##0[.00…]` (grouping + N decimals)
109
+ * currency → `"$"#,##0.00` (symbol + grouping + 2 decimals)
110
+ * percent → `0[.00…]%` (Excel multiplies by 100, so this pairs with a
111
+ * 0..1 fraction; see `valueForExcel`)
112
+ * date → `yyyy-mm-dd`, datetime → `yyyy-mm-dd hh:mm`
113
+ */
114
+ export function toExcelNumFmt(format: CellFormatConfig | undefined): string | undefined {
115
+ if (!format) return undefined
116
+
117
+ const decimals = (): number => {
118
+ // `options` is a union across number/date formats; only the numeric ones
119
+ // carry fraction-digit hints, so read them through a narrow shape.
120
+ const o = format.options as
121
+ | { maximumFractionDigits?: number; minimumFractionDigits?: number }
122
+ | undefined
123
+ if (o && typeof o.maximumFractionDigits === 'number') return o.maximumFractionDigits
124
+ if (o && typeof o.minimumFractionDigits === 'number') return o.minimumFractionDigits
125
+ return format.type === 'currency' ? 2 : format.type === 'number' ? 0 : 2
126
+ }
127
+ const dp = (n: number) => (n > 0 ? '.' + '0'.repeat(n) : '')
128
+
129
+ switch (format.type) {
130
+ case 'number':
131
+ return `#,##0${dp(decimals())}`
132
+ case 'currency': {
133
+ const sym = currencySymbol(format.currency ?? 'USD')
134
+ return `"${sym}"#,##0${dp(decimals())}`
135
+ }
136
+ case 'percent':
137
+ return `0${dp(decimals())}%`
138
+ case 'date':
139
+ return 'yyyy-mm-dd'
140
+ case 'datetime':
141
+ return 'yyyy-mm-dd hh:mm'
142
+ default:
143
+ return undefined
144
+ }
145
+ }
146
+
147
+ /**
148
+ * Turn a grid's data rows + columns into the header-first `{ field: value }`
149
+ * record shape the serializers consume, applying each column's `format` so
150
+ * the export matches what's on screen (unless `rawValues`). Optionally
151
+ * restricts + reorders columns to a `columns` field subset.
152
+ */
153
+ export function projectGridRows(
154
+ dataRows: ReadonlyArray<Record<string, unknown>>,
155
+ columns: ReadonlyArray<GridExportColumn>,
156
+ opts: { columns?: ReadonlyArray<string>; rawValues?: boolean } = {},
157
+ ): {
158
+ records: Array<Record<string, unknown>>
159
+ fields: string[]
160
+ align: Record<string, 'left' | 'center' | 'right'>
161
+ } {
162
+ const chosen =
163
+ opts.columns && opts.columns.length
164
+ ? opts.columns
165
+ .map((f) => columns.find((c) => c.field === f))
166
+ .filter((c): c is GridExportColumn => !!c)
167
+ : columns.filter((c) => c.field)
168
+ const fields = chosen.map((c) => c.field)
169
+ const align: Record<string, 'left' | 'center' | 'right'> = {}
170
+ for (const c of chosen) if (c.align) align[c.field] = c.align
171
+
172
+ const header: Record<string, unknown> = {}
173
+ for (const c of chosen) header[c.field] = c.header
174
+ const records: Array<Record<string, unknown>> = [header]
175
+ for (const row of dataRows) {
176
+ const rec: Record<string, unknown> = {}
177
+ for (const c of chosen) {
178
+ const raw = row[c.field]
179
+ rec[c.field] = opts.rawValues ? raw : formatValueForExport(raw, c.format)
180
+ }
181
+ records.push(rec)
182
+ }
183
+ return { records, fields, align }
184
+ }
185
+
186
+ /** A tiny currency-code → symbol map for the Excel numFmt code. Falls back
187
+ * to the ISO code itself (e.g. "CHF") when we don't have a glyph. */
188
+ function currencySymbol(code: string): string {
189
+ const map: Record<string, string> = {
190
+ USD: '$',
191
+ EUR: '€',
192
+ GBP: '£',
193
+ JPY: '¥',
194
+ CNY: '¥',
195
+ INR: '₹',
196
+ KRW: '₩',
197
+ RUB: '₽',
198
+ BRL: 'R$',
199
+ }
200
+ return map[code.toUpperCase()] ?? code.toUpperCase()
201
+ }
202
+
203
+ /**
204
+ * The value to write into a native xlsx cell that carries an Excel numFmt.
205
+ * Numbers stay numbers; percent values are divided to the 0..1 fraction Excel
206
+ * expects (unless the config already stores 0..1); dates become real `Date`s.
207
+ * Returns `{ ok: false }` when the value can't be represented natively and the
208
+ * caller should fall back to the formatted string.
209
+ */
210
+ export function valueForExcel(
211
+ value: unknown,
212
+ format: CellFormatConfig | undefined,
213
+ ): { ok: true; value: number | Date } | { ok: false } {
214
+ if (value == null || !format) return { ok: false }
215
+
216
+ if (format.type === 'number' || format.type === 'currency') {
217
+ const n = typeof value === 'number' ? value : Number(value)
218
+ return Number.isFinite(n) ? { ok: true, value: n } : { ok: false }
219
+ }
220
+ if (format.type === 'percent') {
221
+ const n = typeof value === 'number' ? value : Number(value)
222
+ if (!Number.isFinite(n)) return { ok: false }
223
+ // Excel's percent numFmt multiplies by 100, so it wants the fraction.
224
+ return { ok: true, value: format.valueIsPercentPoints === true ? n / 100 : n }
225
+ }
226
+ if (format.type === 'date' || format.type === 'datetime') {
227
+ const d = coerceExportDate(value)
228
+ return d ? { ok: true, value: d } : { ok: false }
229
+ }
230
+ return { ok: false }
231
+ }
232
+
233
+ // ===========================================================================
234
+ // Free data export (CSV / TSV / JSON) + delivery. Kept in this same
235
+ // Svelte-free module (the `@svgrid/grid/format` subpath) so @svgrid/enterprise
236
+ // re-uses ONE implementation of each serializer. Input is already-projected
237
+ // rows: an array of `{ field: value }` records whose FIRST record is the
238
+ // header row. Use `projectGridRows` above to build that shape.
239
+ // ===========================================================================
240
+
241
+ // ----- Public option types (shared by the grid API export methods) ---------
242
+
243
+ export type GridExportScope = 'displayed' | 'selected' | 'all'
244
+
245
+ /** The slice of a grid column an exporter needs. Accepts `api.getColumns()`. */
246
+ export type GridExportColumn = {
247
+ field: string
248
+ header: string
249
+ format?: CellFormatConfig | undefined
250
+ align?: 'left' | 'center' | 'right'
251
+ }
252
+
253
+ export type GridExportOptions = {
254
+ /** Base filename (no extension). Default 'grid'. */
255
+ filename?: string
256
+ /** Which rows to export. Default 'displayed' (current view). */
257
+ rows?: GridExportScope
258
+ /** Restrict to these fields, in this order. Default: all visible columns. */
259
+ columns?: string[]
260
+ /** Export raw values instead of the on-screen formatted display. Default false. */
261
+ rawValues?: boolean
262
+ /** Prepend a UTF-8 BOM (csv/tsv) so Excel detects UTF-8. Default true. */
263
+ bom?: boolean
264
+ /** Cancel a large export. */
265
+ signal?: AbortSignal
266
+ /** Progress for large exports. */
267
+ onProgress?: (progress: SerializeProgress) => void
268
+ /** When false, skip the browser download and just return the text. Default true. */
269
+ download?: boolean
270
+ }
271
+
272
+ export type GridClipboardFormat = 'csv' | 'tsv' | 'markdown'
273
+
274
+ export type GridClipboardOptions = {
275
+ /** Clipboard payload format. Default 'tsv' (pastes straight into Excel). */
276
+ format?: GridClipboardFormat
277
+ rows?: GridExportScope
278
+ columns?: string[]
279
+ rawValues?: boolean
280
+ }
281
+
282
+ // ----- Serializers ---------------------------------------------------------
283
+
284
+ export type SerializeProgress = {
285
+ phase: 'serialize'
286
+ /** 0..1 completion of the row walk. */
287
+ ratio: number
288
+ row: number
289
+ total: number
290
+ }
291
+
292
+ export type CsvOptions = {
293
+ /** Field delimiter. Default ',' (','→CSV, '\t'→TSV). */
294
+ delimiter?: string
295
+ /** Line ending between records. Default '\r\n' (Excel-friendly). */
296
+ eol?: string
297
+ /** Prepend a UTF-8 BOM so Excel detects UTF-8. Default true for csv/tsv. */
298
+ bom?: boolean
299
+ }
300
+
301
+ export type SerializeOptions = {
302
+ onProgress?: (p: SerializeProgress) => void
303
+ signal?: AbortSignal
304
+ csv?: CsvOptions
305
+ /** Rows processed between event-loop yields. Default 5000. */
306
+ chunkRows?: number
307
+ }
308
+
309
+ const EXPORT_BOM = ''
310
+
311
+ function throwIfAborted(signal: AbortSignal | undefined): void {
312
+ if (signal?.aborted) {
313
+ throw new DOMException('Export aborted', 'AbortError')
314
+ }
315
+ }
316
+
317
+ /** Let the event loop breathe (paint a progress bar, honour an abort). */
318
+ const yieldToLoop = (): Promise<void> =>
319
+ new Promise((resolve) => setTimeout(resolve, 0))
320
+
321
+ /** RFC-4180 quoting: wrap in double quotes and double any embedded quote
322
+ * when the value contains the delimiter, a quote, or a newline. */
323
+ function csvCell(value: unknown, delimiter: string): string {
324
+ const s =
325
+ value == null
326
+ ? ''
327
+ : value instanceof Date
328
+ ? value.toISOString()
329
+ : String(value)
330
+ if (s === '') return s
331
+ if (s.includes(delimiter) || s.includes('"') || s.includes('\n') || s.includes('\r')) {
332
+ return `"${s.replace(/"/g, '""')}"`
333
+ }
334
+ return s
335
+ }
336
+
337
+ /**
338
+ * Serialize projected rows to a delimited string (CSV / TSV).
339
+ * `rows[0]` is treated as the header row.
340
+ */
341
+ export async function serializeDelimited(
342
+ rows: ReadonlyArray<Record<string, unknown>>,
343
+ fields: ReadonlyArray<string>,
344
+ opts: SerializeOptions = {},
345
+ ): Promise<string> {
346
+ const delimiter = opts.csv?.delimiter ?? ','
347
+ const eol = opts.csv?.eol ?? '\r\n'
348
+ const useBom = opts.csv?.bom ?? true
349
+ const chunk = Math.max(1, opts.chunkRows ?? 5000)
350
+ const total = rows.length
351
+
352
+ const parts: string[] = []
353
+ for (let i = 0; i < rows.length; i++) {
354
+ throwIfAborted(opts.signal)
355
+ const row = rows[i]!
356
+ parts.push(fields.map((f) => csvCell(row[f], delimiter)).join(delimiter))
357
+ if (i > 0 && i % chunk === 0) {
358
+ opts.onProgress?.({ phase: 'serialize', ratio: i / total, row: i, total })
359
+ await yieldToLoop()
360
+ }
361
+ }
362
+ opts.onProgress?.({ phase: 'serialize', ratio: 1, row: total, total })
363
+ const body = parts.join(eol)
364
+ return (useBom ? EXPORT_BOM : '') + body
365
+ }
366
+
367
+ const HTML_ESCAPE: Record<string, string> = {
368
+ '&': '&amp;',
369
+ '<': '&lt;',
370
+ '>': '&gt;',
371
+ '"': '&quot;',
372
+ "'": '&#39;',
373
+ }
374
+ function htmlCell(value: unknown): string {
375
+ const s =
376
+ value == null ? '' : value instanceof Date ? value.toISOString() : String(value)
377
+ return s.replace(/[&<>"']/g, (c) => HTML_ESCAPE[c]!)
378
+ }
379
+
380
+ export type ExportCellVisual = { fill?: string; color?: string; bold?: boolean; icon?: string }
381
+
382
+ /**
383
+ * Serialize projected rows to a standalone HTML `<table>` document.
384
+ * `rows[0]` is the header row (rendered as `<th>`); the rest are `<td>`.
385
+ */
386
+ export async function serializeHtml(
387
+ rows: ReadonlyArray<Record<string, unknown>>,
388
+ fields: ReadonlyArray<string>,
389
+ opts: SerializeOptions & {
390
+ title?: string
391
+ align?: Record<string, 'left' | 'center' | 'right'>
392
+ /** Per-data-cell conditional-format visual (`rowIdx` is 0-based over data). */
393
+ cellStyle?: (rowIdx: number, colIdx: number) => ExportCellVisual | undefined
394
+ /** Per-data-cell hyperlink URL. */
395
+ cellLink?: (rowIdx: number, colIdx: number) => string | undefined
396
+ } = {},
397
+ ): Promise<string> {
398
+ const chunk = Math.max(1, opts.chunkRows ?? 5000)
399
+ const total = rows.length
400
+ const align = opts.align ?? {}
401
+ const cellStyle = opts.cellStyle
402
+ const cellLink = opts.cellLink
403
+ const title = opts.title ?? 'Grid export'
404
+
405
+ const head = rows[0]
406
+ const th = head
407
+ ? fields.map((f) => `<th>${htmlCell(head[f])}</th>`).join('')
408
+ : ''
409
+
410
+ const bodyParts: string[] = []
411
+ for (let i = 1; i < rows.length; i++) {
412
+ throwIfAborted(opts.signal)
413
+ const row = rows[i]!
414
+ const tds = fields
415
+ .map((f, ci) => {
416
+ const a = align[f]
417
+ const styles: string[] = []
418
+ if (a && a !== 'left') styles.push(`text-align:${a}`)
419
+ const cf = cellStyle?.(i - 1, ci)
420
+ if (cf?.fill) styles.push(`background:${cf.fill}`)
421
+ if (cf?.color) styles.push(`color:${cf.color}`)
422
+ if (cf?.bold) styles.push('font-weight:700')
423
+ const style = styles.length ? ` style="${styles.join(';')}"` : ''
424
+ let text = cf?.icon ? `${cf.icon} ${htmlCell(row[f])}` : htmlCell(row[f])
425
+ const href = cellLink?.(i - 1, ci)
426
+ if (href) text = `<a href="${htmlCell(href)}">${text}</a>`
427
+ return `<td${style}>${text}</td>`
428
+ })
429
+ .join('')
430
+ bodyParts.push(`<tr>${tds}</tr>`)
431
+ if (i > 0 && i % chunk === 0) {
432
+ opts.onProgress?.({ phase: 'serialize', ratio: i / total, row: i, total })
433
+ await yieldToLoop()
434
+ }
435
+ }
436
+ opts.onProgress?.({ phase: 'serialize', ratio: 1, row: total, total })
437
+
438
+ return (
439
+ `<!doctype html><html><head><meta charset="utf-8"><title>${htmlCell(title)}</title>` +
440
+ `<style>table{border-collapse:collapse;font-family:system-ui,sans-serif;font-size:13px}` +
441
+ `th,td{border:1px solid #d0d7de;padding:6px 10px}th{background:#f6f8fa;text-align:left}</style>` +
442
+ `</head><body><table><thead><tr>${th}</tr></thead><tbody>${bodyParts.join('')}</tbody></table></body></html>`
443
+ )
444
+ }
445
+
446
+ /**
447
+ * Serialize projected rows to a JSON array of `{ field: value }` objects.
448
+ * `rows[0]` (the header row) is dropped - JSON keys are the field names.
449
+ */
450
+ export async function serializeJson(
451
+ rows: ReadonlyArray<Record<string, unknown>>,
452
+ fields: ReadonlyArray<string>,
453
+ opts: SerializeOptions = {},
454
+ ): Promise<string> {
455
+ const chunk = Math.max(1, opts.chunkRows ?? 5000)
456
+ const total = rows.length - 1
457
+ const out: Array<Record<string, unknown>> = []
458
+ for (let i = 1; i < rows.length; i++) {
459
+ throwIfAborted(opts.signal)
460
+ const src = rows[i]!
461
+ const obj: Record<string, unknown> = {}
462
+ for (const f of fields) obj[f] = src[f]
463
+ out.push(obj)
464
+ if (i > 0 && i % chunk === 0) {
465
+ opts.onProgress?.({ phase: 'serialize', ratio: i / total, row: i, total })
466
+ await yieldToLoop()
467
+ }
468
+ }
469
+ opts.onProgress?.({ phase: 'serialize', ratio: 1, row: total, total })
470
+ return JSON.stringify(out, null, 2)
471
+ }
472
+
473
+ /** Escape a Markdown table cell: pipes and newlines would break the row. */
474
+ function mdCell(value: unknown): string {
475
+ const s = value == null ? '' : value instanceof Date ? value.toISOString() : String(value)
476
+ return s.replace(/\\/g, '\\\\').replace(/\|/g, '\\|').replace(/\r?\n/g, '<br>')
477
+ }
478
+
479
+ /**
480
+ * Serialize projected rows to a GitHub-flavored Markdown table. `rows[0]` is
481
+ * the header row; `align` sets the `:---`, `:--:`, `---:` markers per column.
482
+ */
483
+ export async function serializeMarkdown(
484
+ rows: ReadonlyArray<Record<string, unknown>>,
485
+ fields: ReadonlyArray<string>,
486
+ opts: SerializeOptions & { align?: Record<string, 'left' | 'center' | 'right'> } = {},
487
+ ): Promise<string> {
488
+ const chunk = Math.max(1, opts.chunkRows ?? 5000)
489
+ const total = rows.length
490
+ const align = opts.align ?? {}
491
+ const head = rows[0]
492
+
493
+ const headerLine = `| ${fields.map((f) => mdCell(head?.[f])).join(' | ')} |`
494
+ const sepLine = `| ${fields
495
+ .map((f) => {
496
+ const a = align[f]
497
+ return a === 'right' ? '---:' : a === 'center' ? ':--:' : '---'
498
+ })
499
+ .join(' | ')} |`
500
+
501
+ const bodyLines: string[] = []
502
+ for (let i = 1; i < rows.length; i++) {
503
+ throwIfAborted(opts.signal)
504
+ const src = rows[i]!
505
+ bodyLines.push(`| ${fields.map((f) => mdCell(src[f])).join(' | ')} |`)
506
+ if (i > 0 && i % chunk === 0) {
507
+ opts.onProgress?.({ phase: 'serialize', ratio: i / total, row: i, total })
508
+ await yieldToLoop()
509
+ }
510
+ }
511
+ opts.onProgress?.({ phase: 'serialize', ratio: 1, row: total, total })
512
+ return [headerLine, sepLine, ...bodyLines].join('\n') + '\n'
513
+ }
514
+
515
+ const XML_ESCAPE: Record<string, string> = {
516
+ '&': '&amp;',
517
+ '<': '&lt;',
518
+ '>': '&gt;',
519
+ '"': '&quot;',
520
+ "'": '&apos;',
521
+ }
522
+ function xmlText(value: unknown): string {
523
+ const s = value == null ? '' : value instanceof Date ? value.toISOString() : String(value)
524
+ return s.replace(/[\x00-\x08\x0B\x0C\x0E-\x1F]/g, '').replace(/[&<>"']/g, (c) => XML_ESCAPE[c]!)
525
+ }
526
+ /** Coerce a field name into a valid XML element name. */
527
+ function xmlTag(field: string): string {
528
+ const t = field.replace(/[^A-Za-z0-9_.-]/g, '_')
529
+ return /^[A-Za-z_]/.test(t) ? t : `_${t}`
530
+ }
531
+
532
+ /**
533
+ * Serialize projected rows to a simple XML document:
534
+ * `<rows><row><field>value</field>…</row>…</rows>`. `rows[0]` (header) is
535
+ * dropped - element names come from the field names.
536
+ */
537
+ export async function serializeXml(
538
+ rows: ReadonlyArray<Record<string, unknown>>,
539
+ fields: ReadonlyArray<string>,
540
+ opts: SerializeOptions & { rootTag?: string; rowTag?: string } = {},
541
+ ): Promise<string> {
542
+ const chunk = Math.max(1, opts.chunkRows ?? 5000)
543
+ const total = rows.length - 1
544
+ const root = opts.rootTag ?? 'rows'
545
+ const rowTag = opts.rowTag ?? 'row'
546
+ const tags = fields.map(xmlTag)
547
+
548
+ const parts: string[] = [`<?xml version="1.0" encoding="UTF-8"?>`, `<${root}>`]
549
+ for (let i = 1; i < rows.length; i++) {
550
+ throwIfAborted(opts.signal)
551
+ const src = rows[i]!
552
+ const cells = fields
553
+ .map((f, ci) => `<${tags[ci]}>${xmlText(src[f])}</${tags[ci]}>`)
554
+ .join('')
555
+ parts.push(` <${rowTag}>${cells}</${rowTag}>`)
556
+ if (i > 0 && i % chunk === 0) {
557
+ opts.onProgress?.({ phase: 'serialize', ratio: i / total, row: i, total })
558
+ await yieldToLoop()
559
+ }
560
+ }
561
+ parts.push(`</${root}>`)
562
+ opts.onProgress?.({ phase: 'serialize', ratio: 1, row: total, total })
563
+ return parts.join('\n')
564
+ }
565
+
566
+ // ----- Delivery: download + clipboard (browser-guarded) --------------------
567
+
568
+ /** Trigger a browser download of an already-built Blob. No-op guard for SSR. */
569
+ export function downloadBlobFile(blob: Blob, filename: string): void {
570
+ if (typeof document === 'undefined' || typeof URL === 'undefined') {
571
+ throw new Error('@svgrid/grid: export requires a browser environment')
572
+ }
573
+ const url = URL.createObjectURL(blob)
574
+ const a = document.createElement('a')
575
+ a.href = url
576
+ a.download = filename
577
+ document.body.appendChild(a)
578
+ a.click()
579
+ a.remove()
580
+ setTimeout(() => URL.revokeObjectURL(url), 0)
581
+ }
582
+
583
+ /** Trigger a browser download of a text blob. No-op guard for SSR. */
584
+ export function downloadTextFile(text: string, filename: string, mime: string): void {
585
+ if (typeof document === 'undefined' || typeof URL === 'undefined') {
586
+ throw new Error('@svgrid/grid: text export requires a browser environment')
587
+ }
588
+ downloadBlobFile(new Blob([text], { type: mime }), filename)
589
+ }
590
+
591
+ /** Write text to the system clipboard. Throws when the API is unavailable
592
+ * (insecure context / SSR). */
593
+ export async function copyTextToClipboard(text: string): Promise<void> {
594
+ if (typeof navigator === 'undefined' || !navigator.clipboard) {
595
+ throw new Error('@svgrid/grid: clipboard API is unavailable in this context')
596
+ }
597
+ await navigator.clipboard.writeText(text)
598
+ }
@@ -13,7 +13,7 @@ import {
13
13
  * engine so we can assert the adapter wires reads/writes correctly without
14
14
  * needing the real ~1MB hyperformula package.
15
15
  */
16
- function makeFakeEngine() {
16
+ function makeFakeEngine(opts: { bulk?: boolean } = {}) {
17
17
  const raw = new Map<string, unknown>()
18
18
  const key = (s: number, r: number, c: number) => `${s}:${r}:${c}`
19
19
 
@@ -61,6 +61,18 @@ function makeFakeEngine() {
61
61
  ),
62
62
  destroy: vi.fn(() => {}),
63
63
  rebuildAndRecalculate: vi.fn(() => {}),
64
+ // Bulk seed path (only when opted in) - fills the same `raw` map so
65
+ // getCellValue/evalCell work identically to the per-cell path.
66
+ ...(opts.bulk
67
+ ? {
68
+ setSheetContent: vi.fn((sheetId: number, values: unknown[][]) => {
69
+ values.forEach((rowVals, r) =>
70
+ rowVals.forEach((v, c) => raw.set(key(sheetId, r, c), v)),
71
+ )
72
+ return []
73
+ }),
74
+ }
75
+ : {}),
64
76
  // test-only introspection
65
77
  _raw: raw,
66
78
  }
@@ -99,6 +111,28 @@ describe('createHyperFormulaSheet', () => {
99
111
  )
100
112
  })
101
113
 
114
+ it('seeds via a single bulk setSheetContent when the engine exposes it', () => {
115
+ const bulkHf = makeFakeEngine({ bulk: true }) as ReturnType<typeof makeFakeEngine> & {
116
+ setSheetContent: ReturnType<typeof vi.fn>
117
+ }
118
+ const rows = [
119
+ { a: 1, b: '=A1+10' },
120
+ { a: 10, b: '=A2+10' },
121
+ ]
122
+ const sheet = createHyperFormulaSheet({ hyperformula: bulkHf, rows, fields: ['a', 'b'] })
123
+
124
+ // Bulk path: ONE setSheetContent, no per-cell setCellContents for the seed.
125
+ expect(bulkHf.setSheetContent).toHaveBeenCalledTimes(1)
126
+ expect(bulkHf.setSheetContent).toHaveBeenCalledWith(0, [
127
+ [1, '=A1+10'],
128
+ [10, '=A2+10'],
129
+ ])
130
+ expect(bulkHf.setCellContents).not.toHaveBeenCalled()
131
+ // Still computes correctly.
132
+ expect(sheet.computed[0]!.b).toBe(11)
133
+ expect(sheet.computed[1]!.b).toBe(20)
134
+ })
135
+
102
136
  it('computed snapshot pulls evaluated values out of the engine', () => {
103
137
  const rows = [{ a: 2, b: 3, total: '=A1+B1' }]
104
138
  const sheet = createHyperFormulaSheet({
@@ -32,6 +32,10 @@ export type HyperFormulaInstance = {
32
32
  contents: unknown,
33
33
  ): Array<{ address: { sheet: number; row: number; col: number }; newValue: unknown }>
34
34
  getCellValue(cell: { sheet: number; row: number; col: number }): unknown
35
+ /** Bulk-load an entire sheet in one call (one recalc instead of one per
36
+ * cell). Optional so minimal / mock instances still satisfy the type;
37
+ * the adapter falls back to per-cell `setCellContents` when it's absent. */
38
+ setSheetContent?(sheetId: number, values: unknown[][]): unknown
35
39
  destroy(): void
36
40
  rebuildAndRecalculate(): void
37
41
  }
@@ -80,12 +84,20 @@ export function createHyperFormulaSheet<T extends Record<string, unknown>>(
80
84
  fields.forEach((f, i) => colByField.set(f as string, i))
81
85
 
82
86
  // 1. Seed HF with every cell. HF expects raw strings for formulas
83
- // (`'=A1+B1'`) and primitives for everything else.
84
- for (let r = 0; r < rows.length; r += 1) {
85
- const row = rows[r]!
86
- for (let c = 0; c < fields.length; c += 1) {
87
- const field = fields[c]! as string
88
- hf.setCellContents({ sheet: sheetId, row: r, col: c }, row[field as keyof T])
87
+ // (`'=A1+B1'`) and primitives for everything else. Prefer a single bulk
88
+ // `setSheetContent` write - it recalculates ONCE instead of once per
89
+ // setCellContents, ~3x faster to mount a large sheet (e.g. 200x26). Fall
90
+ // back to per-cell for instances that don't expose it.
91
+ if (typeof hf.setSheetContent === 'function') {
92
+ const grid = rows.map((row) => fields.map((f) => row[f as keyof T]))
93
+ hf.setSheetContent(sheetId, grid)
94
+ } else {
95
+ for (let r = 0; r < rows.length; r += 1) {
96
+ const row = rows[r]!
97
+ for (let c = 0; c < fields.length; c += 1) {
98
+ const field = fields[c]! as string
99
+ hf.setCellContents({ sheet: sheetId, row: r, col: c }, row[field as keyof T])
100
+ }
89
101
  }
90
102
  }
91
103