@office-kit/xlsx 0.11.1 → 0.13.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 (75) hide show
  1. package/README.md +4 -1
  2. package/dist/cell/cell.d.ts +44 -9
  3. package/dist/cell/index.d.ts +1 -1
  4. package/dist/{cell-BucgGwl3.mjs → cell-Df3cKRIl.mjs} +72 -30
  5. package/dist/cell-Df3cKRIl.mjs.map +1 -0
  6. package/dist/{cell-style-DuvS_Lsg.mjs → cell-style-BFmJOmcx.mjs} +130 -93
  7. package/dist/cell-style-BFmJOmcx.mjs.map +1 -0
  8. package/dist/cell.mjs +2 -2
  9. package/dist/{coordinate-96Ecci4d.mjs → coordinate-Bt5Gni2I.mjs} +19 -8
  10. package/dist/coordinate-Bt5Gni2I.mjs.map +1 -0
  11. package/dist/{defined-names-CviWmtQg.mjs → defined-names-Ctu3F6ls.mjs} +4 -3
  12. package/dist/defined-names-Ctu3F6ls.mjs.map +1 -0
  13. package/dist/{differential-DvKU8fJt.mjs → differential-H9SjEeIU.mjs} +2 -2
  14. package/dist/{differential-DvKU8fJt.mjs.map → differential-H9SjEeIU.mjs.map} +1 -1
  15. package/dist/{drawing-BxzLuryn.mjs → drawing-ZJ3h4VHD.mjs} +2 -2
  16. package/dist/{drawing-BxzLuryn.mjs.map → drawing-ZJ3h4VHD.mjs.map} +1 -1
  17. package/dist/drawing.mjs +1 -1
  18. package/dist/{inference-BrI9uIY4.mjs → inference-BMvv9cUY.mjs} +18 -3
  19. package/dist/inference-BMvv9cUY.mjs.map +1 -0
  20. package/dist/io/save.d.ts +15 -3
  21. package/dist/io.mjs +2 -2
  22. package/dist/{load-Bghb1YHY.mjs → load-CJdGh50R.mjs} +6 -6
  23. package/dist/{load-Bghb1YHY.mjs.map → load-CJdGh50R.mjs.map} +1 -1
  24. package/dist/node.mjs +1 -1
  25. package/dist/{save-Bqcf8w3g.mjs → save-CjarR7Rp.mjs} +10 -8
  26. package/dist/save-CjarR7Rp.mjs.map +1 -0
  27. package/dist/streaming/write-only.d.ts +18 -14
  28. package/dist/streaming.mjs +21 -51
  29. package/dist/streaming.mjs.map +1 -1
  30. package/dist/styles/cell-style.d.ts +78 -32
  31. package/dist/styles/fonts.d.ts +10 -1
  32. package/dist/styles/index.d.ts +3 -3
  33. package/dist/styles/stylesheet.d.ts +26 -0
  34. package/dist/styles.mjs +4 -4
  35. package/dist/{stylesheet-writer-HxaX7bGy.mjs → stylesheet-writer-D7Uug85X.mjs} +31 -18
  36. package/dist/stylesheet-writer-D7Uug85X.mjs.map +1 -0
  37. package/dist/{table-1P8we2gS.mjs → table-Ccro4rrz.mjs} +11 -9
  38. package/dist/table-Ccro4rrz.mjs.map +1 -0
  39. package/dist/utils/coordinate.d.ts +30 -4
  40. package/dist/utils/formula-text.d.ts +7 -0
  41. package/dist/utils/index.d.ts +1 -1
  42. package/dist/utils.mjs +2 -2
  43. package/dist/workbook/calc-properties.d.ts +8 -1
  44. package/dist/workbook/index.d.ts +1 -1
  45. package/dist/{workbook-BlZVXiyG.mjs → workbook-B15-T4cs.mjs} +6 -6
  46. package/dist/{workbook-BlZVXiyG.mjs.map → workbook-B15-T4cs.mjs.map} +1 -1
  47. package/dist/workbook.mjs +45 -3
  48. package/dist/workbook.mjs.map +1 -1
  49. package/dist/worksheet/cell-range.d.ts +10 -3
  50. package/dist/worksheet/data-validations.d.ts +1 -1
  51. package/dist/worksheet/index.d.ts +3 -3
  52. package/dist/worksheet/table-validate.d.ts +7 -0
  53. package/dist/worksheet/table.d.ts +4 -1
  54. package/dist/worksheet/views.d.ts +5 -0
  55. package/dist/worksheet/worksheet.d.ts +106 -65
  56. package/dist/worksheet/writer.d.ts +7 -0
  57. package/dist/{worksheet-C5Ensf_j.mjs → worksheet-4xW-i8j9.mjs} +235 -51
  58. package/dist/worksheet-4xW-i8j9.mjs.map +1 -0
  59. package/dist/worksheet.mjs +3 -3
  60. package/dist/{writer-IyFccCRJ.mjs → writer-Z7cF_CBk.mjs} +60 -8
  61. package/dist/writer-Z7cF_CBk.mjs.map +1 -0
  62. package/dist/zip/index.d.ts +1 -1
  63. package/dist/zip/writer.d.ts +20 -1
  64. package/dist/zip.mjs +1 -1
  65. package/package.json +1 -1
  66. package/dist/cell-BucgGwl3.mjs.map +0 -1
  67. package/dist/cell-style-DuvS_Lsg.mjs.map +0 -1
  68. package/dist/coordinate-96Ecci4d.mjs.map +0 -1
  69. package/dist/defined-names-CviWmtQg.mjs.map +0 -1
  70. package/dist/inference-BrI9uIY4.mjs.map +0 -1
  71. package/dist/save-Bqcf8w3g.mjs.map +0 -1
  72. package/dist/stylesheet-writer-HxaX7bGy.mjs.map +0 -1
  73. package/dist/table-1P8we2gS.mjs.map +0 -1
  74. package/dist/worksheet-C5Ensf_j.mjs.map +0 -1
  75. package/dist/writer-IyFccCRJ.mjs.map +0 -1
@@ -1,4 +1,5 @@
1
- import { on as parseMultiCellRange } from "./worksheet-C5Ensf_j.mjs";
1
+ import { r as normalizeFormulaText } from "./inference-BMvv9cUY.mjs";
2
+ import { a as addTable, sn as parseMultiCellRange } from "./worksheet-4xW-i8j9.mjs";
2
3
  //#region src/worksheet/conditional-formatting.ts
3
4
  function makeConditionalFormatting(opts) {
4
5
  return {
@@ -11,7 +12,7 @@ function makeCfRule(opts) {
11
12
  return {
12
13
  type: opts.type,
13
14
  priority: opts.priority,
14
- formulas: opts.formulas ?? [],
15
+ formulas: (opts.formulas ?? []).map((f) => normalizeFormulaText(f)),
15
16
  ...opts.dxfId !== void 0 ? { dxfId: opts.dxfId } : {},
16
17
  ...opts.stopIfTrue !== void 0 ? { stopIfTrue: opts.stopIfTrue } : {},
17
18
  ...opts.operator !== void 0 ? { operator: opts.operator } : {},
@@ -33,8 +34,8 @@ function makeDataValidation(opts) {
33
34
  type: opts.type,
34
35
  sqref: typeof opts.sqref === "string" ? parseMultiCellRange(opts.sqref) : opts.sqref,
35
36
  ...opts.operator !== void 0 ? { operator: opts.operator } : {},
36
- ...opts.formula1 !== void 0 ? { formula1: opts.formula1 } : {},
37
- ...opts.formula2 !== void 0 ? { formula2: opts.formula2 } : {},
37
+ ...opts.formula1 !== void 0 ? { formula1: normalizeFormulaText(opts.formula1) } : {},
38
+ ...opts.formula2 !== void 0 ? { formula2: normalizeFormulaText(opts.formula2) } : {},
38
39
  ...opts.allowBlank !== void 0 ? { allowBlank: opts.allowBlank } : {},
39
40
  ...opts.showInputMessage !== void 0 ? { showInputMessage: opts.showInputMessage } : {},
40
41
  ...opts.showErrorMessage !== void 0 ? { showErrorMessage: opts.showErrorMessage } : {},
@@ -81,6 +82,9 @@ const nextTableId = (wb) => {
81
82
  * in one call. Auto-assigns the workbook-unique `id`, derives `displayName`
82
83
  * from the supplied `name`, and constructs `TableColumn` records (1-based ids)
83
84
  * from a string-array shorthand.
85
+ *
86
+ * Goes through {@link addTable}, so the definition is checked against the sheet
87
+ * before it lands. Pass `headerRowCount: 0` for a genuinely header-less table.
84
88
  */
85
89
  const addExcelTable = (wb, ws, opts) => {
86
90
  const cols = opts.columns.map((c, i) => typeof c === "string" ? {
@@ -92,7 +96,7 @@ const addExcelTable = (wb, ws, opts) => {
92
96
  showRowStripes: true,
93
97
  showColumnStripes: false
94
98
  } : void 0);
95
- const def = makeTableDefinition({
99
+ return addTable(ws, makeTableDefinition({
96
100
  id: nextTableId(wb),
97
101
  displayName: opts.displayName ?? opts.name,
98
102
  name: opts.name,
@@ -103,11 +107,9 @@ const addExcelTable = (wb, ws, opts) => {
103
107
  ...opts.totalsRowShown !== void 0 ? { totalsRowShown: opts.totalsRowShown } : {},
104
108
  ...styleInfo ? { styleInfo } : {},
105
109
  ...opts.autoFilter ? { autoFilter: opts.autoFilter } : {}
106
- });
107
- ws.tables.push(def);
108
- return def;
110
+ }));
109
111
  };
110
112
  //#endregion
111
113
  export { makeCfRule as a, makeDataValidation as i, makeTableColumn as n, makeConditionalFormatting as o, makeTableDefinition as r, addExcelTable as t };
112
114
 
113
- //# sourceMappingURL=table-1P8we2gS.mjs.map
115
+ //# sourceMappingURL=table-Ccro4rrz.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"table-Ccro4rrz.mjs","names":[],"sources":["../src/worksheet/conditional-formatting.ts","../src/worksheet/data-validations.ts","../src/worksheet/table.ts"],"sourcesContent":["// Conditional formatting.\n//\n// Stage-1 covers the **value-based** rule kinds (cellIs / expression / top10 /\n// aboveAverage / containsText family / containsBlanks family / duplicateValues\n// / uniqueValues / timePeriod). The visual rule kinds — colorScale / dataBar /\n// iconSet — round-trip as opaque inner XML (`innerXml` field) so the data\n// survives a save / load cycle without our needing to model cfvo / colors /\n// iconSets fully.\n\nimport { escapeXmlAttr } from '../utils/escape.js';\nimport { OpenXmlSchemaError } from '../utils/exceptions.js';\nimport { normalizeFormulaText } from '../utils/formula-text.js';\nimport { type MultiCellRange, parseMultiCellRange } from './cell-range.js';\n\nexport type ConditionalFormattingRuleType =\n | 'expression'\n | 'cellIs'\n | 'colorScale'\n | 'dataBar'\n | 'iconSet'\n | 'top10'\n | 'aboveAverage'\n | 'uniqueValues'\n | 'duplicateValues'\n | 'containsText'\n | 'notContainsText'\n | 'beginsWith'\n | 'endsWith'\n | 'containsBlanks'\n | 'notContainsBlanks'\n | 'containsErrors'\n | 'notContainsErrors'\n | 'timePeriod';\n\nexport type CellIsOperator =\n | 'lessThan'\n | 'lessThanOrEqual'\n | 'equal'\n | 'notEqual'\n | 'greaterThanOrEqual'\n | 'greaterThan'\n | 'between'\n | 'notBetween';\n\nexport type TextOperator = 'containsText' | 'notContains' | 'beginsWith' | 'endsWith';\n\nexport type TimePeriod =\n | 'today'\n | 'yesterday'\n | 'tomorrow'\n | 'last7Days'\n | 'thisMonth'\n | 'lastMonth'\n | 'nextMonth'\n | 'thisWeek'\n | 'lastWeek'\n | 'nextWeek';\n\nexport interface ConditionalFormattingRule {\n /** Wire-level rule kind. */\n type: ConditionalFormattingRuleType;\n /** 1-based priority — Excel evaluates lower priority first. */\n priority: number;\n /** Index into Stylesheet.dxfs for the cell-format applied when the rule fires. */\n dxfId?: number;\n /** Stop evaluating subsequent rules on the same cell when this rule matches. */\n stopIfTrue?: boolean;\n /** cellIs operator. */\n operator?: CellIsOperator | TextOperator | string;\n /** Comparison string for the contains-text family. */\n text?: string;\n /** top10: rank percentage flag. */\n percent?: boolean;\n /** top10: bottom-N flag (false = top-N, true = bottom-N). */\n bottom?: boolean;\n /** top10: rank value (defaults to 10). */\n rank?: number;\n /** aboveAverage: aboveAverage=\"0\" → below average. */\n aboveAverage?: boolean;\n /** aboveAverage: equalAverage flag. */\n equalAverage?: boolean;\n /** aboveAverage: stdDev. */\n stdDev?: number;\n /** timePeriod token. */\n timePeriod?: TimePeriod;\n /** 0..3 formula strings — varies by rule type. */\n formulas: string[];\n /**\n * Raw inner XML for colorScale / dataBar / iconSet rules. Stage-1 stores the\n * verbatim child markup so saves round-trip without our needing to model cfvo\n * / colors / iconSets fully.\n */\n innerXml?: string;\n}\n\nexport interface ConditionalFormatting {\n sqref: MultiCellRange;\n rules: ConditionalFormattingRule[];\n pivot?: boolean;\n}\n\nexport function makeConditionalFormatting(opts: {\n sqref: MultiCellRange | string;\n rules?: ConditionalFormattingRule[];\n pivot?: boolean;\n}): ConditionalFormatting {\n return {\n sqref: typeof opts.sqref === 'string' ? parseMultiCellRange(opts.sqref) : opts.sqref,\n rules: opts.rules ?? [],\n ...(opts.pivot !== undefined ? { pivot: opts.pivot } : {}),\n };\n}\n\nexport function makeCfRule(\n opts: Partial<ConditionalFormattingRule> & {\n type: ConditionalFormattingRuleType;\n priority: number;\n },\n): ConditionalFormattingRule {\n return {\n type: opts.type,\n priority: opts.priority,\n formulas: (opts.formulas ?? []).map((f) => normalizeFormulaText(f)),\n ...(opts.dxfId !== undefined ? { dxfId: opts.dxfId } : {}),\n ...(opts.stopIfTrue !== undefined ? { stopIfTrue: opts.stopIfTrue } : {}),\n ...(opts.operator !== undefined ? { operator: opts.operator } : {}),\n ...(opts.text !== undefined ? { text: opts.text } : {}),\n ...(opts.percent !== undefined ? { percent: opts.percent } : {}),\n ...(opts.bottom !== undefined ? { bottom: opts.bottom } : {}),\n ...(opts.rank !== undefined ? { rank: opts.rank } : {}),\n ...(opts.aboveAverage !== undefined ? { aboveAverage: opts.aboveAverage } : {}),\n ...(opts.equalAverage !== undefined ? { equalAverage: opts.equalAverage } : {}),\n ...(opts.stdDev !== undefined ? { stdDev: opts.stdDev } : {}),\n ...(opts.timePeriod !== undefined ? { timePeriod: opts.timePeriod } : {}),\n ...(opts.innerXml !== undefined ? { innerXml: opts.innerXml } : {}),\n };\n}\n\n// ---- Worksheet ergonomic builders ---------------------------------------\n\nimport type { Worksheet } from './worksheet.js';\n\nconst resolveCfSqref = (sqref: MultiCellRange | string): MultiCellRange =>\n typeof sqref === 'string' ? parseMultiCellRange(sqref) : sqref;\n\nconst nextCfPriority = (ws: Worksheet): number => {\n let max = 0;\n for (const cf of ws.conditionalFormatting) {\n for (const r of cf.rules) {\n if (r.priority > max) max = r.priority;\n }\n }\n return max + 1;\n};\n\n/** Push one CF rule onto the worksheet, wrapping it in a ConditionalFormatting block keyed off `sqref`. */\nconst pushRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n rule: ConditionalFormattingRule,\n): ConditionalFormattingRule => {\n ws.conditionalFormatting.push(makeConditionalFormatting({ sqref: resolveCfSqref(sqref), rules: [rule] }));\n return rule;\n};\n\n/**\n * \"If cell value [op] formula → apply dxf\". Mirrors Excel's \"Highlight Cell\n * Rules → ...\" UI.\n */\nexport const addCellIsRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: {\n operator: CellIsOperator;\n formula1: string;\n formula2?: string;\n dxfId?: number;\n stopIfTrue?: boolean;\n priority?: number;\n },\n): ConditionalFormattingRule => {\n const formulas = opts.formula2 !== undefined ? [opts.formula1, opts.formula2] : [opts.formula1];\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: 'cellIs',\n priority: opts.priority ?? nextCfPriority(ws),\n operator: opts.operator,\n formulas,\n ...(opts.dxfId !== undefined ? { dxfId: opts.dxfId } : {}),\n ...(opts.stopIfTrue !== undefined ? { stopIfTrue: opts.stopIfTrue } : {}),\n }),\n );\n};\n\n/** Top-N or bottom-N rule. `bottom: true` → bottom-N. `percent: true` → percentile. */\nexport const addTopNRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: { rank?: number; bottom?: boolean; percent?: boolean; dxfId?: number; priority?: number },\n): ConditionalFormattingRule => {\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: 'top10',\n priority: opts.priority ?? nextCfPriority(ws),\n formulas: [],\n ...(opts.rank !== undefined ? { rank: opts.rank } : {}),\n ...(opts.bottom !== undefined ? { bottom: opts.bottom } : {}),\n ...(opts.percent !== undefined ? { percent: opts.percent } : {}),\n ...(opts.dxfId !== undefined ? { dxfId: opts.dxfId } : {}),\n }),\n );\n};\n\n/** Above/below-average rule. `aboveAverage: false` → below-average; provide `stdDev` for ±N stddev. */\nexport const addAverageRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: {\n aboveAverage?: boolean;\n equalAverage?: boolean;\n stdDev?: number;\n dxfId?: number;\n priority?: number;\n },\n): ConditionalFormattingRule => {\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: 'aboveAverage',\n priority: opts.priority ?? nextCfPriority(ws),\n formulas: [],\n ...(opts.aboveAverage !== undefined ? { aboveAverage: opts.aboveAverage } : {}),\n ...(opts.equalAverage !== undefined ? { equalAverage: opts.equalAverage } : {}),\n ...(opts.stdDev !== undefined ? { stdDev: opts.stdDev } : {}),\n ...(opts.dxfId !== undefined ? { dxfId: opts.dxfId } : {}),\n }),\n );\n};\n\n/** Duplicate-values rule (each cell whose value appears more than once gets the dxf). */\nexport const addDuplicateValuesRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: { dxfId?: number; priority?: number; unique?: boolean } = {},\n): ConditionalFormattingRule => {\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: opts.unique ? 'uniqueValues' : 'duplicateValues',\n priority: opts.priority ?? nextCfPriority(ws),\n formulas: [],\n ...(opts.dxfId !== undefined ? { dxfId: opts.dxfId } : {}),\n }),\n );\n};\n\n/** Free-form formula rule — any `=ISNUMBER(A1)`-style boolean expression. */\nexport const addFormulaRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: { formula: string; dxfId?: number; stopIfTrue?: boolean; priority?: number },\n): ConditionalFormattingRule => {\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: 'expression',\n priority: opts.priority ?? nextCfPriority(ws),\n formulas: [opts.formula],\n ...(opts.dxfId !== undefined ? { dxfId: opts.dxfId } : {}),\n ...(opts.stopIfTrue !== undefined ? { stopIfTrue: opts.stopIfTrue } : {}),\n }),\n );\n};\n\n/** Text-based rule (containsText / notContains / beginsWith / endsWith). */\nexport const addTextRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: { operator: TextOperator; text: string; dxfId?: number; priority?: number },\n): ConditionalFormattingRule => {\n // Excel uses different `type` tokens for the four text operators.\n const typeMap: Record<TextOperator, ConditionalFormattingRuleType> = {\n containsText: 'containsText',\n notContains: 'notContainsText',\n beginsWith: 'beginsWith',\n endsWith: 'endsWith',\n };\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: typeMap[opts.operator],\n priority: opts.priority ?? nextCfPriority(ws),\n operator: opts.operator,\n text: opts.text,\n formulas: [],\n ...(opts.dxfId !== undefined ? { dxfId: opts.dxfId } : {}),\n }),\n );\n};\n\n// ---- Visual rule builders (colorScale / dataBar / iconSet) --------------\n\nexport type CfvoType = 'min' | 'max' | 'num' | 'percent' | 'percentile' | 'formula';\n\nexport interface Cfvo {\n type: CfvoType;\n /** Required for num / percent / percentile / formula; ignored for min / max. */\n val?: string;\n}\n\nexport type IconSetStyle =\n | '3Arrows'\n | '3ArrowsGray'\n | '3Flags'\n | '3Signs'\n | '3Symbols'\n | '3Symbols2'\n | '3TrafficLights1'\n | '3TrafficLights2'\n | '4Arrows'\n | '4ArrowsGray'\n | '4Rating'\n | '4RedToBlack'\n | '4TrafficLights'\n | '5Arrows'\n | '5ArrowsGray'\n | '5Quarters'\n | '5Rating';\n\nconst escapeAttr = escapeXmlAttr;\n\nconst renderCfvo = (c: Cfvo): string => {\n if (c.type === 'min' || c.type === 'max') {\n if (c.val === undefined) return `<cfvo type=\"${c.type}\"/>`;\n return `<cfvo type=\"${c.type}\" val=\"${escapeAttr(c.val)}\"/>`;\n }\n if (c.val === undefined) {\n throw new OpenXmlSchemaError(`cfvo type \"${c.type}\" requires val`);\n }\n return `<cfvo type=\"${c.type}\" val=\"${escapeAttr(c.val)}\"/>`;\n};\n\nconst renderColor = (hex: string): string => `<color rgb=\"${escapeAttr(hex)}\"/>`;\n\n/**\n * Color-scale rule — gradient between 2 or 3 reference points. Each cfvo pairs\n * with one color.\n */\nexport const addColorScaleRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: {\n cfvos: ReadonlyArray<Cfvo>;\n /** Hex strings, e.g. `'FFFF0000'`; one per cfvo. */\n colors: ReadonlyArray<string>;\n priority?: number;\n stopIfTrue?: boolean;\n },\n): ConditionalFormattingRule => {\n if (opts.cfvos.length !== 2 && opts.cfvos.length !== 3) {\n throw new OpenXmlSchemaError(`addColorScaleRule: cfvos must be length 2 or 3; got ${opts.cfvos.length}`);\n }\n if (opts.colors.length !== opts.cfvos.length) {\n throw new OpenXmlSchemaError(\n `addColorScaleRule: colors length (${opts.colors.length}) must match cfvos length (${opts.cfvos.length})`,\n );\n }\n const inner = `<colorScale>${opts.cfvos.map(renderCfvo).join('')}${opts.colors.map(renderColor).join('')}</colorScale>`;\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: 'colorScale',\n priority: opts.priority ?? nextCfPriority(ws),\n formulas: [],\n innerXml: inner,\n ...(opts.stopIfTrue !== undefined ? { stopIfTrue: opts.stopIfTrue } : {}),\n }),\n );\n};\n\n/**\n * Data-bar rule — a gradient bar inside each cell sized to the value. Defaults\n * to `min`/`max` cfvos so the bar spans the visible range.\n */\nexport const addDataBarRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: {\n color: string;\n minCfvo?: Cfvo;\n maxCfvo?: Cfvo;\n minLength?: number;\n maxLength?: number;\n showValue?: boolean;\n priority?: number;\n stopIfTrue?: boolean;\n },\n): ConditionalFormattingRule => {\n const min = opts.minCfvo ?? { type: 'min' };\n const max = opts.maxCfvo ?? { type: 'max' };\n let attrs = '';\n if (opts.minLength !== undefined) attrs += ` minLength=\"${opts.minLength}\"`;\n if (opts.maxLength !== undefined) attrs += ` maxLength=\"${opts.maxLength}\"`;\n if (opts.showValue !== undefined) attrs += ` showValue=\"${opts.showValue ? '1' : '0'}\"`;\n const inner = `<dataBar${attrs}>${renderCfvo(min)}${renderCfvo(max)}${renderColor(opts.color)}</dataBar>`;\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: 'dataBar',\n priority: opts.priority ?? nextCfPriority(ws),\n formulas: [],\n innerXml: inner,\n ...(opts.stopIfTrue !== undefined ? { stopIfTrue: opts.stopIfTrue } : {}),\n }),\n );\n};\n\n/**\n * Icon-set rule — visual icons (arrows / lights / flags) drawn next to each\n * cell value. The number of cfvos depends on the icon set (3 for `3Arrows`, 4\n * for `4Arrows`, 5 for `5Arrows`, etc).\n */\nexport const addIconSetRule = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n opts: {\n iconSet: IconSetStyle | string;\n cfvos: ReadonlyArray<Cfvo>;\n reverse?: boolean;\n showValue?: boolean;\n percent?: boolean;\n priority?: number;\n stopIfTrue?: boolean;\n },\n): ConditionalFormattingRule => {\n if (opts.cfvos.length < 3 || opts.cfvos.length > 5) {\n throw new OpenXmlSchemaError(`addIconSetRule: cfvos must be length 3..5; got ${opts.cfvos.length}`);\n }\n let attrs = ` iconSet=\"${escapeAttr(opts.iconSet)}\"`;\n if (opts.reverse !== undefined) attrs += ` reverse=\"${opts.reverse ? '1' : '0'}\"`;\n if (opts.showValue !== undefined) attrs += ` showValue=\"${opts.showValue ? '1' : '0'}\"`;\n if (opts.percent !== undefined) attrs += ` percent=\"${opts.percent ? '1' : '0'}\"`;\n const inner = `<iconSet${attrs}>${opts.cfvos.map(renderCfvo).join('')}</iconSet>`;\n return pushRule(\n ws,\n sqref,\n makeCfRule({\n type: 'iconSet',\n priority: opts.priority ?? nextCfPriority(ws),\n formulas: [],\n innerXml: inner,\n ...(opts.stopIfTrue !== undefined ? { stopIfTrue: opts.stopIfTrue } : {}),\n }),\n );\n};\n","// Data validations.\n//\n// A DataValidation entry attaches a constraint (one of seven type kinds,\n// optional operator, two formula slots) to a sqref-style MultiCellRange.\n// Stage-1 maps every OOXML attribute we have a use for; imeMode + numeric/value\n// clamps land later when phase 7's Asian-locale support catches up.\n\nimport { normalizeFormulaText } from '../utils/formula-text.js';\nimport { type MultiCellRange, parseMultiCellRange } from './cell-range.js';\n\nexport type DataValidationType = 'whole' | 'decimal' | 'list' | 'date' | 'time' | 'textLength' | 'custom';\nexport type DataValidationOperator =\n | 'between'\n | 'notBetween'\n | 'equal'\n | 'notEqual'\n | 'greaterThan'\n | 'greaterThanOrEqual'\n | 'lessThan'\n | 'lessThanOrEqual';\nexport type DataValidationErrorStyle = 'stop' | 'warning' | 'information';\n\nexport interface DataValidation {\n /** Constraint kind. `'list'` is the dropdown form (formula1 = comma list or range). */\n type: DataValidationType;\n /** Comparison operator — only meaningful for whole/decimal/date/time/textLength. */\n operator?: DataValidationOperator;\n /** Lower-bound formula or list source. Always required for list/whole/decimal/date/time. */\n formula1?: string;\n /** Upper-bound formula. Used by between / notBetween only. */\n formula2?: string;\n /** Allow empty cells. */\n allowBlank?: boolean;\n /** Show the input message popover when the cell is selected. */\n showInputMessage?: boolean;\n /** Show the error message popover on invalid entry. */\n showErrorMessage?: boolean;\n errorTitle?: string;\n error?: string;\n errorStyle?: DataValidationErrorStyle;\n promptTitle?: string;\n prompt?: string;\n /** Excel inverts this attribute: `showDropDown=\"1\"` actually *hides* the dropdown arrow on list-type validators. We mirror the wire form. */\n showDropDown?: boolean;\n /** Apply-to range (sqref). */\n sqref: MultiCellRange;\n}\n\nexport function makeDataValidation(\n opts: Omit<Partial<DataValidation>, 'sqref'> & {\n type: DataValidationType;\n sqref: MultiCellRange | string;\n },\n): DataValidation {\n return {\n type: opts.type,\n sqref: typeof opts.sqref === 'string' ? parseMultiCellRange(opts.sqref) : opts.sqref,\n ...(opts.operator !== undefined ? { operator: opts.operator } : {}),\n ...(opts.formula1 !== undefined ? { formula1: normalizeFormulaText(opts.formula1) } : {}),\n ...(opts.formula2 !== undefined ? { formula2: normalizeFormulaText(opts.formula2) } : {}),\n ...(opts.allowBlank !== undefined ? { allowBlank: opts.allowBlank } : {}),\n ...(opts.showInputMessage !== undefined ? { showInputMessage: opts.showInputMessage } : {}),\n ...(opts.showErrorMessage !== undefined ? { showErrorMessage: opts.showErrorMessage } : {}),\n ...(opts.errorTitle !== undefined ? { errorTitle: opts.errorTitle } : {}),\n ...(opts.error !== undefined ? { error: opts.error } : {}),\n ...(opts.errorStyle !== undefined ? { errorStyle: opts.errorStyle } : {}),\n ...(opts.promptTitle !== undefined ? { promptTitle: opts.promptTitle } : {}),\n ...(opts.prompt !== undefined ? { prompt: opts.prompt } : {}),\n ...(opts.showDropDown !== undefined ? { showDropDown: opts.showDropDown } : {}),\n };\n}\n\n// ---- Worksheet ergonomic builders ---------------------------------------\n\nimport type { Worksheet } from './worksheet.js';\n\nconst resolveSqref = (sqref: MultiCellRange | string): MultiCellRange =>\n typeof sqref === 'string' ? parseMultiCellRange(sqref) : sqref;\n\nexport interface ValidationCommon {\n /** Show the dropdown / input prompt when the cell is selected. */\n prompt?: string;\n promptTitle?: string;\n /** Show an error dialog when the user types an invalid value. */\n error?: string;\n errorTitle?: string;\n errorStyle?: DataValidationErrorStyle;\n allowBlank?: boolean;\n}\n\n/**\n * Add a list-type dropdown validation to a range. `values` may be an inline\n * list (`['Red', 'Green', 'Blue']`) or a sheet reference\n * (`'Sheet1!$A$1:$A$10'`, with or without a leading `=`).\n */\nexport const addListValidation = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n values: ReadonlyArray<string> | string,\n opts: ValidationCommon = {},\n): DataValidation => {\n const formula1 = Array.isArray(values)\n ? `\"${(values as ReadonlyArray<string>).join(',')}\"`\n : (values as string);\n const dv = makeDataValidation({\n type: 'list',\n sqref: resolveSqref(sqref),\n formula1,\n allowBlank: opts.allowBlank ?? true,\n showInputMessage: opts.prompt !== undefined,\n showErrorMessage: opts.error !== undefined || opts.errorStyle !== undefined,\n ...(opts.errorStyle !== undefined ? { errorStyle: opts.errorStyle } : {}),\n ...(opts.error !== undefined ? { error: opts.error } : {}),\n ...(opts.errorTitle !== undefined ? { errorTitle: opts.errorTitle } : {}),\n ...(opts.prompt !== undefined ? { prompt: opts.prompt } : {}),\n ...(opts.promptTitle !== undefined ? { promptTitle: opts.promptTitle } : {}),\n });\n ws.dataValidations.push(dv);\n return dv;\n};\n\n/**\n * Add a number-range validation. `between(min, max)` matches Excel's \"Whole\n * Number\" → \"between\" form by default. Use `kind: 'decimal'` for decimal\n * (default 'whole').\n */\nexport const addNumberValidation = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n range: { min: number; max?: number; operator?: DataValidationOperator; kind?: 'whole' | 'decimal' },\n opts: ValidationCommon = {},\n): DataValidation => {\n const operator: DataValidationOperator =\n range.operator ?? (range.max !== undefined ? 'between' : 'greaterThanOrEqual');\n const dv = makeDataValidation({\n type: range.kind ?? 'whole',\n sqref: resolveSqref(sqref),\n operator,\n formula1: String(range.min),\n ...(range.max !== undefined ? { formula2: String(range.max) } : {}),\n allowBlank: opts.allowBlank ?? true,\n showInputMessage: opts.prompt !== undefined,\n showErrorMessage: opts.error !== undefined || opts.errorStyle !== undefined,\n ...(opts.errorStyle !== undefined ? { errorStyle: opts.errorStyle } : {}),\n ...(opts.error !== undefined ? { error: opts.error } : {}),\n ...(opts.errorTitle !== undefined ? { errorTitle: opts.errorTitle } : {}),\n ...(opts.prompt !== undefined ? { prompt: opts.prompt } : {}),\n ...(opts.promptTitle !== undefined ? { promptTitle: opts.promptTitle } : {}),\n });\n ws.dataValidations.push(dv);\n return dv;\n};\n\n/**\n * Add a date-range validation. Dates are passed as Excel serial numbers (use\n * `dateToExcel` to convert from JS `Date`).\n */\nexport const addDateValidation = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n range: { min: number; max?: number; operator?: DataValidationOperator },\n opts: ValidationCommon = {},\n): DataValidation => {\n const operator: DataValidationOperator =\n range.operator ?? (range.max !== undefined ? 'between' : 'greaterThanOrEqual');\n const dv = makeDataValidation({\n type: 'date',\n sqref: resolveSqref(sqref),\n operator,\n formula1: String(range.min),\n ...(range.max !== undefined ? { formula2: String(range.max) } : {}),\n allowBlank: opts.allowBlank ?? true,\n showInputMessage: opts.prompt !== undefined,\n showErrorMessage: opts.error !== undefined || opts.errorStyle !== undefined,\n ...(opts.errorStyle !== undefined ? { errorStyle: opts.errorStyle } : {}),\n ...(opts.error !== undefined ? { error: opts.error } : {}),\n ...(opts.errorTitle !== undefined ? { errorTitle: opts.errorTitle } : {}),\n ...(opts.prompt !== undefined ? { prompt: opts.prompt } : {}),\n ...(opts.promptTitle !== undefined ? { promptTitle: opts.promptTitle } : {}),\n });\n ws.dataValidations.push(dv);\n return dv;\n};\n\n/** Add a custom-formula validation (`formula1` evaluated for each cell). */\nexport const addCustomValidation = (\n ws: Worksheet,\n sqref: MultiCellRange | string,\n formula: string,\n opts: ValidationCommon = {},\n): DataValidation => {\n const dv = makeDataValidation({\n type: 'custom',\n sqref: resolveSqref(sqref),\n formula1: formula,\n allowBlank: opts.allowBlank ?? true,\n showInputMessage: opts.prompt !== undefined,\n showErrorMessage: opts.error !== undefined || opts.errorStyle !== undefined,\n ...(opts.errorStyle !== undefined ? { errorStyle: opts.errorStyle } : {}),\n ...(opts.error !== undefined ? { error: opts.error } : {}),\n ...(opts.errorTitle !== undefined ? { errorTitle: opts.errorTitle } : {}),\n ...(opts.prompt !== undefined ? { prompt: opts.prompt } : {}),\n ...(opts.promptTitle !== undefined ? { promptTitle: opts.promptTitle } : {}),\n });\n ws.dataValidations.push(dv);\n return dv;\n};\n","// Excel Table object (xl/tables/tableN.xml).\n//\n// Tables ride on top of a worksheet range, give it a name + structured column\n// references, and own their own AutoFilter. Each table sits in a separate part\n// — the worksheet only carries a `<tableParts>` block pointing at the\n// workbook-rels rId. Stage-1 covers the table shell + columns + styleInfo +\n// autoFilter; sortState / totals row formulas / calculated column formulas /\n// xml extlst are reserved for later.\n\nimport type { Workbook } from '../workbook/workbook.js';\nimport type { AutoFilter } from './auto-filter.js';\nimport { addTable, type Worksheet } from './worksheet.js';\n\nexport interface TableColumn {\n /** 1-based column id (per-table). */\n id: number;\n /** Header name. */\n name: string;\n /** Totals-row aggregation function. */\n totalsRowFunction?: 'sum' | 'min' | 'max' | 'count' | 'countNums' | 'average' | 'stdDev' | 'var' | 'custom';\n /** Override label for the totals row. */\n totalsRowLabel?: string;\n /** Custom totals-row formula text. */\n totalsRowFormula?: string;\n /** Calculated-column formula. */\n calculatedColumnFormula?: string;\n}\n\nexport interface TableStyleInfo {\n /** Built-in style name (TableStyleMedium2, etc) or custom. */\n name?: string;\n showFirstColumn?: boolean;\n showLastColumn?: boolean;\n showRowStripes?: boolean;\n showColumnStripes?: boolean;\n}\n\nexport interface TableDefinition {\n /** Workbook-unique id (`<table id=\"N\">`). */\n id: number;\n /** Workbook-unique displayName — Excel surfaces this in formulas. */\n displayName: string;\n /** Optional friendly name; usually matches `displayName`. */\n name?: string;\n /** Range covered by the table, e.g. \"A1:E10\". */\n ref: string;\n /** Number of header rows. Defaults to 1; 0 means a header-less table. */\n headerRowCount?: number;\n /** Number of totals rows. */\n totalsRowCount?: number;\n /** Whether the totals row is currently visible. */\n totalsRowShown?: boolean;\n styleInfo?: TableStyleInfo;\n columns: TableColumn[];\n autoFilter?: AutoFilter;\n /** Worksheet-rels rId — populated on read; the writer assigns its own. */\n rId?: string;\n}\n\nexport function makeTableColumn(opts: { id: number; name: string }): TableColumn {\n return { id: opts.id, name: opts.name };\n}\n\nexport function makeTableDefinition(opts: {\n id: number;\n displayName: string;\n ref: string;\n name?: string;\n columns?: TableColumn[];\n headerRowCount?: number;\n totalsRowCount?: number;\n totalsRowShown?: boolean;\n styleInfo?: TableStyleInfo;\n autoFilter?: AutoFilter;\n}): TableDefinition {\n return {\n id: opts.id,\n displayName: opts.displayName,\n ref: opts.ref,\n columns: opts.columns ?? [],\n ...(opts.name !== undefined ? { name: opts.name } : {}),\n ...(opts.headerRowCount !== undefined ? { headerRowCount: opts.headerRowCount } : {}),\n ...(opts.totalsRowCount !== undefined ? { totalsRowCount: opts.totalsRowCount } : {}),\n ...(opts.totalsRowShown !== undefined ? { totalsRowShown: opts.totalsRowShown } : {}),\n ...(opts.styleInfo ? { styleInfo: opts.styleInfo } : {}),\n ...(opts.autoFilter ? { autoFilter: opts.autoFilter } : {}),\n };\n}\n\nconst nextTableId = (wb: Workbook): number => {\n let max = 0;\n for (const ref of wb.sheets) {\n if (ref.kind !== 'worksheet') continue;\n for (const t of ref.sheet.tables) {\n if (t.id > max) max = t.id;\n }\n }\n return max + 1;\n};\n\n/**\n * High-level wrapper that builds a TableDefinition + pushes it onto `ws.tables`\n * in one call. Auto-assigns the workbook-unique `id`, derives `displayName`\n * from the supplied `name`, and constructs `TableColumn` records (1-based ids)\n * from a string-array shorthand.\n *\n * Goes through {@link addTable}, so the definition is checked against the sheet\n * before it lands. Pass `headerRowCount: 0` for a genuinely header-less table.\n */\nexport const addExcelTable = (\n wb: Workbook,\n ws: Worksheet,\n opts: {\n name: string;\n ref: string;\n columns: ReadonlyArray<string | TableColumn>;\n style?: string;\n styleInfo?: TableStyleInfo;\n headerRowCount?: number;\n totalsRowCount?: number;\n totalsRowShown?: boolean;\n autoFilter?: AutoFilter;\n displayName?: string;\n },\n): TableDefinition => {\n const cols: TableColumn[] = opts.columns.map((c, i): TableColumn =>\n typeof c === 'string' ? { id: i + 1, name: c } : c,\n );\n const styleInfo: TableStyleInfo | undefined =\n opts.styleInfo ??\n (opts.style !== undefined ? { name: opts.style, showRowStripes: true, showColumnStripes: false } : undefined);\n const def: TableDefinition = makeTableDefinition({\n id: nextTableId(wb),\n displayName: opts.displayName ?? opts.name,\n name: opts.name,\n ref: opts.ref,\n columns: cols,\n ...(opts.headerRowCount !== undefined ? { headerRowCount: opts.headerRowCount } : {}),\n ...(opts.totalsRowCount !== undefined ? { totalsRowCount: opts.totalsRowCount } : {}),\n ...(opts.totalsRowShown !== undefined ? { totalsRowShown: opts.totalsRowShown } : {}),\n ...(styleInfo ? { styleInfo } : {}),\n ...(opts.autoFilter ? { autoFilter: opts.autoFilter } : {}),\n });\n return addTable(ws, def);\n};\n"],"mappings":";;;AAqGA,SAAgB,0BAA0B,MAIhB;CACxB,OAAO;EACL,OAAO,OAAO,KAAK,UAAU,WAAW,oBAAoB,KAAK,KAAK,IAAI,KAAK;EAC/E,OAAO,KAAK,SAAS,CAAC;EACtB,GAAI,KAAK,UAAU,KAAA,IAAY,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;CAC1D;AACF;AAEA,SAAgB,WACd,MAI2B;CAC3B,OAAO;EACL,MAAM,KAAK;EACX,UAAU,KAAK;EACf,WAAW,KAAK,YAAY,CAAC,EAAA,CAAG,KAAK,MAAM,qBAAqB,CAAC,CAAC;EAClE,GAAI,KAAK,UAAU,KAAA,IAAY,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;EACxD,GAAI,KAAK,eAAe,KAAA,IAAY,EAAE,YAAY,KAAK,WAAW,IAAI,CAAC;EACvE,GAAI,KAAK,aAAa,KAAA,IAAY,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;EACjE,GAAI,KAAK,SAAS,KAAA,IAAY,EAAE,MAAM,KAAK,KAAK,IAAI,CAAC;EACrD,GAAI,KAAK,YAAY,KAAA,IAAY,EAAE,SAAS,KAAK,QAAQ,IAAI,CAAC;EAC9D,GAAI,KAAK,WAAW,KAAA,IAAY,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;EAC3D,GAAI,KAAK,SAAS,KAAA,IAAY,EAAE,MAAM,KAAK,KAAK,IAAI,CAAC;EACrD,GAAI,KAAK,iBAAiB,KAAA,IAAY,EAAE,cAAc,KAAK,aAAa,IAAI,CAAC;EAC7E,GAAI,KAAK,iBAAiB,KAAA,IAAY,EAAE,cAAc,KAAK,aAAa,IAAI,CAAC;EAC7E,GAAI,KAAK,WAAW,KAAA,IAAY,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;EAC3D,GAAI,KAAK,eAAe,KAAA,IAAY,EAAE,YAAY,KAAK,WAAW,IAAI,CAAC;EACvE,GAAI,KAAK,aAAa,KAAA,IAAY,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;CACnE;AACF;;;ACxFA,SAAgB,mBACd,MAIgB;CAChB,OAAO;EACL,MAAM,KAAK;EACX,OAAO,OAAO,KAAK,UAAU,WAAW,oBAAoB,KAAK,KAAK,IAAI,KAAK;EAC/E,GAAI,KAAK,aAAa,KAAA,IAAY,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;EACjE,GAAI,KAAK,aAAa,KAAA,IAAY,EAAE,UAAU,qBAAqB,KAAK,QAAQ,EAAE,IAAI,CAAC;EACvF,GAAI,KAAK,aAAa,KAAA,IAAY,EAAE,UAAU,qBAAqB,KAAK,QAAQ,EAAE,IAAI,CAAC;EACvF,GAAI,KAAK,eAAe,KAAA,IAAY,EAAE,YAAY,KAAK,WAAW,IAAI,CAAC;EACvE,GAAI,KAAK,qBAAqB,KAAA,IAAY,EAAE,kBAAkB,KAAK,iBAAiB,IAAI,CAAC;EACzF,GAAI,KAAK,qBAAqB,KAAA,IAAY,EAAE,kBAAkB,KAAK,iBAAiB,IAAI,CAAC;EACzF,GAAI,KAAK,eAAe,KAAA,IAAY,EAAE,YAAY,KAAK,WAAW,IAAI,CAAC;EACvE,GAAI,KAAK,UAAU,KAAA,IAAY,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;EACxD,GAAI,KAAK,eAAe,KAAA,IAAY,EAAE,YAAY,KAAK,WAAW,IAAI,CAAC;EACvE,GAAI,KAAK,gBAAgB,KAAA,IAAY,EAAE,aAAa,KAAK,YAAY,IAAI,CAAC;EAC1E,GAAI,KAAK,WAAW,KAAA,IAAY,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;EAC3D,GAAI,KAAK,iBAAiB,KAAA,IAAY,EAAE,cAAc,KAAK,aAAa,IAAI,CAAC;CAC/E;AACF;;;ACXA,SAAgB,gBAAgB,MAAiD;CAC/E,OAAO;EAAE,IAAI,KAAK;EAAI,MAAM,KAAK;CAAK;AACxC;AAEA,SAAgB,oBAAoB,MAWhB;CAClB,OAAO;EACL,IAAI,KAAK;EACT,aAAa,KAAK;EAClB,KAAK,KAAK;EACV,SAAS,KAAK,WAAW,CAAC;EAC1B,GAAI,KAAK,SAAS,KAAA,IAAY,EAAE,MAAM,KAAK,KAAK,IAAI,CAAC;EACrD,GAAI,KAAK,mBAAmB,KAAA,IAAY,EAAE,gBAAgB,KAAK,eAAe,IAAI,CAAC;EACnF,GAAI,KAAK,mBAAmB,KAAA,IAAY,EAAE,gBAAgB,KAAK,eAAe,IAAI,CAAC;EACnF,GAAI,KAAK,mBAAmB,KAAA,IAAY,EAAE,gBAAgB,KAAK,eAAe,IAAI,CAAC;EACnF,GAAI,KAAK,YAAY,EAAE,WAAW,KAAK,UAAU,IAAI,CAAC;EACtD,GAAI,KAAK,aAAa,EAAE,YAAY,KAAK,WAAW,IAAI,CAAC;CAC3D;AACF;AAEA,MAAM,eAAe,OAAyB;CAC5C,IAAI,MAAM;CACV,KAAK,MAAM,OAAO,GAAG,QAAQ;EAC3B,IAAI,IAAI,SAAS,aAAa;EAC9B,KAAK,MAAM,KAAK,IAAI,MAAM,QACxB,IAAI,EAAE,KAAK,KAAK,MAAM,EAAE;CAE5B;CACA,OAAO,MAAM;AACf;;;;;;;;;;AAWA,MAAa,iBACX,IACA,IACA,SAYoB;CACpB,MAAM,OAAsB,KAAK,QAAQ,KAAK,GAAG,MAC/C,OAAO,MAAM,WAAW;EAAE,IAAI,IAAI;EAAG,MAAM;CAAE,IAAI,CACnD;CACA,MAAM,YACJ,KAAK,cACJ,KAAK,UAAU,KAAA,IAAY;EAAE,MAAM,KAAK;EAAO,gBAAgB;EAAM,mBAAmB;CAAM,IAAI,KAAA;CAarG,OAAO,SAAS,IAZa,oBAAoB;EAC/C,IAAI,YAAY,EAAE;EAClB,aAAa,KAAK,eAAe,KAAK;EACtC,MAAM,KAAK;EACX,KAAK,KAAK;EACV,SAAS;EACT,GAAI,KAAK,mBAAmB,KAAA,IAAY,EAAE,gBAAgB,KAAK,eAAe,IAAI,CAAC;EACnF,GAAI,KAAK,mBAAmB,KAAA,IAAY,EAAE,gBAAgB,KAAK,eAAe,IAAI,CAAC;EACnF,GAAI,KAAK,mBAAmB,KAAA,IAAY,EAAE,gBAAgB,KAAK,eAAe,IAAI,CAAC;EACnF,GAAI,YAAY,EAAE,UAAU,IAAI,CAAC;EACjC,GAAI,KAAK,aAAa,EAAE,YAAY,KAAK,WAAW,IAAI,CAAC;CAC3D,CACsB,CAAC;AACzB"}
@@ -29,6 +29,16 @@ export interface CellRangeBoundaries {
29
29
  maxCol: number;
30
30
  maxRow: number;
31
31
  }
32
+ /**
33
+ * What every range-taking helper accepts: an A1 expression (`"A4:H20"`,
34
+ * `"A:A"`, `"1:1"`) or already-computed 1-based bounds. Code that walks rows
35
+ * and columns as integers passes the bounds directly instead of formatting a
36
+ * string for the callee to parse straight back.
37
+ *
38
+ * Two spellings of one parameter, deliberately, rather than a second function
39
+ * per helper: each capability keeps a single canonical path through the API.
40
+ */
41
+ export type RangeRef = string | CellRangeBoundaries;
32
42
  /**
33
43
  * Parse a single-cell coordinate string ("A1", "$XFD$1048576") into its column
34
44
  * letter (always uppercased) and 1-based row.
@@ -39,8 +49,20 @@ export declare function coordinateFromString(coord: string): CellCoordinate;
39
49
  * numeric index. Thin convenience for the worksheet read path.
40
50
  */
41
51
  export declare function coordinateToTuple(coord: string): CellCoordinateNumeric;
42
- /** Compose `"A1"` from a 1-based (col, row). */
43
- export declare function tupleToCoordinate(col: number, row: number): string;
52
+ /** `$` placement for a composed A1 reference. */
53
+ export interface AbsoluteRefOptions {
54
+ /** Prefix the column letter with `$` so it survives a fill-across. */
55
+ absoluteCol?: boolean;
56
+ /** Prefix the row number with `$` so it survives a fill-down. */
57
+ absoluteRow?: boolean;
58
+ }
59
+ /**
60
+ * Compose `"A1"` from a 1-based (col, row). Set `absoluteCol` / `absoluteRow`
61
+ * to get the `$` forms formula text needs (`"$B$5"`, `"B$5"`), so callers
62
+ * tracking integer coordinates never have to concatenate a column letter
63
+ * themselves.
64
+ */
65
+ export declare function tupleToCoordinate(col: number, row: number, opts?: AbsoluteRefOptions): string;
44
66
  /**
45
67
  * Predicate: true iff `s` is a valid single-cell A1 coordinate (`"A1"`,
46
68
  * `"XFD1048576"`). Strings with `$` absolute markers, surrounding whitespace,
@@ -78,8 +100,12 @@ export declare function isValidColumnNumber(n: unknown): n is number;
78
100
  * ranges fill cols to [1, MAX_COL].
79
101
  */
80
102
  export declare function rangeBoundaries(range: string): CellRangeBoundaries;
81
- /** Inverse of {@link rangeBoundaries} for the rectangular case. */
82
- export declare function boundariesToRangeString(b: CellRangeBoundaries): string;
103
+ /**
104
+ * Inverse of {@link rangeBoundaries} for the rectangular case. `opts` forwards
105
+ * to {@link tupleToCoordinate}, so `{ absoluteCol: true, absoluteRow: true }`
106
+ * yields the `"$A$4:$H$20"` form a formula or defined name wants.
107
+ */
108
+ export declare function boundariesToRangeString(b: CellRangeBoundaries, opts?: AbsoluteRefOptions): string;
83
109
  /**
84
110
  * Parse a sheet-qualified range ("Sheet1!A1:B5" / "'Quarter 1'!A1"). Sheet
85
111
  * names with single quotes inside use SQL-style doubling ("'Bob''s Sheet'!A1")
@@ -0,0 +1,7 @@
1
+ /** True iff `text` is spelled the way a spreadsheet UI shows a formula. */
2
+ export declare function startsWithEquals(text: string): boolean;
3
+ /**
4
+ * Drop the leading `=` OOXML formula text must not carry, and the whitespace
5
+ * around it: `' =SUM(A1)'` would otherwise keep the `=` in the stored text.
6
+ */
7
+ export declare function normalizeFormulaText(text: string): string;
@@ -1,4 +1,4 @@
1
- export type { CellCoordinate, CellCoordinateNumeric, CellRangeBoundaries } from './coordinate.js';
1
+ export type { AbsoluteRefOptions, CellCoordinate, CellCoordinateNumeric, CellRangeBoundaries, RangeRef, } from './coordinate.js';
2
2
  export { boundariesToRangeString, columnIndexFromLetter, columnLetterFromIndex, coordinateFromString, coordinateToTuple, formatSheetQualifiedRef, isValidCellRef, isValidColumnLetter, isValidColumnNumber, isValidRangeRef, isValidRowNumber, MAX_COL, MAX_ROW, parseSheetRange, rangeBoundaries, tupleToCoordinate, } from './coordinate.js';
3
3
  export type { ExcelEpoch } from './datetime.js';
4
4
  export { dateToExcel, durationToExcel, excelToDate, excelToDuration, fromIso8601, MAC_EPOCH_MS, toIso8601, WINDOWS_EPOCH_MS, } from './datetime.js';
package/dist/utils.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  import { a as OpenXmlNotImplementedError, i as OpenXmlIoError, n as OpenXmlError, o as OpenXmlSchemaError, r as OpenXmlInvalidWorkbookError, t as OpenXmlDecompressionBombError } from "./exceptions-D-CFwxgm.mjs";
2
- import { a as columnLetterFromIndex, c as formatSheetQualifiedRef, d as isValidColumnNumber, f as isValidRangeRef, g as tupleToCoordinate, h as rangeBoundaries, i as columnIndexFromLetter, l as isValidCellRef, m as parseSheetRange, n as MAX_ROW, o as coordinateFromString, p as isValidRowNumber, r as boundariesToRangeString, s as coordinateToTuple, t as MAX_COL, u as isValidColumnLetter } from "./coordinate-96Ecci4d.mjs";
3
- import { n as inferCellType, t as ERROR_CODES } from "./inference-BrI9uIY4.mjs";
2
+ import { a as columnLetterFromIndex, c as formatSheetQualifiedRef, d as isValidColumnNumber, f as isValidRangeRef, g as tupleToCoordinate, h as rangeBoundaries, i as columnIndexFromLetter, l as isValidCellRef, m as parseSheetRange, n as MAX_ROW, o as coordinateFromString, p as isValidRowNumber, r as boundariesToRangeString, s as coordinateToTuple, t as MAX_COL, u as isValidColumnLetter } from "./coordinate-Bt5Gni2I.mjs";
3
+ import { n as inferCellType, t as ERROR_CODES } from "./inference-BMvv9cUY.mjs";
4
4
  import { a as cmFromEmu, c as emuFromPoint, d as pixelToPoint, f as pointFromEmu, i as EMU_PER_POINT, l as emuFromPx, m as pxFromEmu, n as EMU_PER_INCH, o as emuFromCm, p as pointToPixel, r as EMU_PER_PIXEL, s as emuFromInch, t as EMU_PER_CM, u as inchFromEmu } from "./units-rOMQqXh2.mjs";
5
5
  import { i as unescapeCellString, t as escapeCellString } from "./escape-rnWSPpWY.mjs";
6
6
  import { a as excelToDate, c as toIso8601, i as durationToExcel, n as WINDOWS_EPOCH_MS, o as excelToDuration, r as dateToExcel, s as fromIso8601, t as MAC_EPOCH_MS } from "./datetime-B2ySVlXt.mjs";
@@ -41,7 +41,14 @@ export declare const setIterativeCalc: (wb: Workbook, enable: boolean, opts?: {
41
41
  }) => void;
42
42
  /** Toggle "Recalculate workbook before saving" (workbook-level). */
43
43
  export declare const setCalcOnSave: (wb: Workbook, on: boolean) => void;
44
- /** Toggle "Recalculate workbook on load" — forces a full recalc on open. */
44
+ /**
45
+ * Toggle "Recalculate workbook on load". A calculating app (Excel,
46
+ * LibreOffice, Google Sheets) then recomputes every formula on open instead of
47
+ * trusting the cached values in the file, which is what a generated workbook
48
+ * wants when the producer could not compute a cached value for every formula,
49
+ * or is not certain the ones it wrote are current. Viewers that never
50
+ * calculate ignore the flag and keep showing only what is cached.
51
+ */
45
52
  export declare const setFullCalcOnLoad: (wb: Workbook, on: boolean) => void;
46
53
  /** Toggle "Set precision as displayed" (false = full 15-digit precision). */
47
54
  export declare const setFullPrecision: (wb: Workbook, on: boolean) => void;
@@ -9,7 +9,7 @@ export { addSharedString, getSharedStringAt, getSharedStringIndex, makeSharedStr
9
9
  export type { CustomViewShowComments, CustomViewShowObjects, CustomWorkbookView, WorkbookView, WorkbookViewVisibility, } from './views.js';
10
10
  export { makeCustomWorkbookView, makeWorkbookView } from './views.js';
11
11
  export type { CalcMode, CalcProperties, RefMode } from './calc-properties.js';
12
- export { makeCalcProperties } from './calc-properties.js';
12
+ export { makeCalcProperties, setCalcMode, setCalcOnSave, setFullCalcOnLoad, setFullPrecision, setIterativeCalc, } from './calc-properties.js';
13
13
  export type { ShowObjectsMode, UpdateLinksMode, WorkbookProperties, } from './workbook-properties.js';
14
14
  export { makeWorkbookProperties } from './workbook-properties.js';
15
15
  export type { FileVersion } from './file-version.js';
@@ -1,13 +1,13 @@
1
1
  import { o as OpenXmlSchemaError } from "./exceptions-D-CFwxgm.mjs";
2
- import { m as parseSheetRange, s as coordinateToTuple } from "./coordinate-96Ecci4d.mjs";
3
- import { h as isFormulaValue } from "./cell-BucgGwl3.mjs";
2
+ import { m as parseSheetRange, s as coordinateToTuple } from "./coordinate-Bt5Gni2I.mjs";
3
+ import { h as isFormulaValue } from "./cell-Df3cKRIl.mjs";
4
4
  import { t as makeChartsheet } from "./chartsheet-C3-tqkPy.mjs";
5
- import { a as makeChartDrawingItem, d as makeAbsoluteAnchor, o as makeDrawing } from "./drawing-BxzLuryn.mjs";
5
+ import { a as makeChartDrawingItem, d as makeAbsoluteAnchor, o as makeDrawing } from "./drawing-ZJ3h4VHD.mjs";
6
6
  import { i as unescapeCellString, n as escapeXmlAttr, r as escapeXmlText, t as escapeCellString } from "./escape-rnWSPpWY.mjs";
7
7
  import { a as findChildren, ft as SHEET_MAIN_NS, i as findChild, jt as qname } from "./tree-BX-sRRVp.mjs";
8
8
  import { t as parseXml } from "./parser-By6RWZVW.mjs";
9
- import { D as getCellHyperlink, E as getCellComment, L as getMergedRangeAt, _ as countCellsByKind, _n as colorToHex, at as makeWorksheet, dn as rangeToString, in as multiCellRangeContainsCell, ln as rangeContainsCell, sn as parseRange, u as classifyCellValue, w as getCell, xt as setCellByCoord } from "./worksheet-C5Ensf_j.mjs";
10
- import { Zt as stableStringify, _ as getCellNumberFormat, ft as makeStylesheet, g as getCellFont, h as getCellFill, m as getCellBorder, p as getCellAlignment, v as getCellProtection } from "./cell-style-DuvS_Lsg.mjs";
9
+ import { D as getCellComment, O as getCellHyperlink, R as getMergedRangeAt, St as setCellByCoord, T as getCell, _ as countCellsByKind, an as multiCellRangeContainsCell, cn as parseRange, fn as rangeToString, ot as makeWorksheet, u as classifyCellValue, un as rangeContainsCell, vn as colorToHex } from "./worksheet-4xW-i8j9.mjs";
10
+ import { _ as getCellNumberFormat, en as stableStringify, g as getCellFont, h as getCellFill, ht as makeStylesheet, m as getCellBorder, p as getCellAlignment, v as getCellProtection } from "./cell-style-BFmJOmcx.mjs";
11
11
  //#region src/workbook/shared-strings.ts
12
12
  const SST_TAG = `{${SHEET_MAIN_NS}}sst`;
13
13
  const SI_TAG = `{${SHEET_MAIN_NS}}si`;
@@ -658,4 +658,4 @@ function listCustomXmlParts(wb) {
658
658
  //#endregion
659
659
  export { sharedStringCount as A, addSharedRichText as C, makeSharedStrings as D, getSharedStringIndex as E, parseRichString as O, validateSheetTitle as S, getSharedStringAt as T, renameSheet as _, getActiveSheet as a, setSheetState as b, getChartsheet as c, getWorkbookCellsByKind as d, getWorkbookStats as f, removeSheet as g, moveSheet as h, describeWorkbook as i, sharedStringsToBytes as j, parseSharedStringsXml as k, getSheet as l, listCustomXmlParts as m, addWorksheet as n, getCellAtAddress as o, iterWorksheets as p, createWorkbook as r, getCellSummary as s, addChartsheet as t, getSheetState as u, setActiveSheet as v, addSharedString as w, sheetNames as x, setCellAtAddress as y };
660
660
 
661
- //# sourceMappingURL=workbook-BlZVXiyG.mjs.map
661
+ //# sourceMappingURL=workbook-B15-T4cs.mjs.map