@office-kit/xlsx 0.16.0 → 0.17.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 (62) hide show
  1. package/README.md +12 -1
  2. package/dist/cell/cell.d.ts +12 -19
  3. package/dist/{cell-Df3cKRIl.mjs → cell-B5OUUdfI.mjs} +13 -7
  4. package/dist/cell-B5OUUdfI.mjs.map +1 -0
  5. package/dist/{cell-style-CNsET6WU.mjs → cell-style-DjKKPWDL.mjs} +2 -2
  6. package/dist/{cell-style-CNsET6WU.mjs.map → cell-style-DjKKPWDL.mjs.map} +1 -1
  7. package/dist/cell.mjs +1 -1
  8. package/dist/{coordinate-Bt5Gni2I.mjs → coordinate-CxC88uBk.mjs} +31 -2
  9. package/dist/coordinate-CxC88uBk.mjs.map +1 -0
  10. package/dist/{defined-names-Ctu3F6ls.mjs → defined-names-Cmp8rbvI.mjs} +2 -2
  11. package/dist/{defined-names-Ctu3F6ls.mjs.map → defined-names-Cmp8rbvI.mjs.map} +1 -1
  12. package/dist/{differential-BPKa7wXi.mjs → differential-7KGzbliB.mjs} +2 -2
  13. package/dist/{differential-BPKa7wXi.mjs.map → differential-7KGzbliB.mjs.map} +1 -1
  14. package/dist/{drawing-ZJ3h4VHD.mjs → drawing-Cv6UtInY.mjs} +2 -2
  15. package/dist/{drawing-ZJ3h4VHD.mjs.map → drawing-Cv6UtInY.mjs.map} +1 -1
  16. package/dist/drawing.mjs +1 -1
  17. package/dist/{escape-rnWSPpWY.mjs → escape-rA5UpibT.mjs} +26 -3
  18. package/dist/escape-rA5UpibT.mjs.map +1 -0
  19. package/dist/io/load.d.ts +28 -0
  20. package/dist/io.mjs +2 -2
  21. package/dist/{load-B1sK-LjT.mjs → load-DIdQ_zum.mjs} +66 -39
  22. package/dist/{load-B1sK-LjT.mjs.map → load-DIdQ_zum.mjs.map} +1 -1
  23. package/dist/{manifest-pLmx7KYh.mjs → manifest-BHUYpjUG.mjs} +3 -3
  24. package/dist/{manifest-pLmx7KYh.mjs.map → manifest-BHUYpjUG.mjs.map} +1 -1
  25. package/dist/node.mjs +1 -1
  26. package/dist/packaging.mjs +1 -1
  27. package/dist/{reader-DHMxLBQV.mjs → reader-pC7bxYAs.mjs} +30 -7
  28. package/dist/reader-pC7bxYAs.mjs.map +1 -0
  29. package/dist/{save-DmdWwxmw.mjs → save-ax11Gsw0.mjs} +7 -7
  30. package/dist/{save-DmdWwxmw.mjs.map → save-ax11Gsw0.mjs.map} +1 -1
  31. package/dist/schema.mjs +1 -1
  32. package/dist/{serialize-BC2Wu3bR.mjs → serialize-Dmb6Vtt9.mjs} +23 -6
  33. package/dist/serialize-Dmb6Vtt9.mjs.map +1 -0
  34. package/dist/{serializer-C6nm0mRJ.mjs → serializer-dhv07Z6F.mjs} +2 -2
  35. package/dist/{serializer-C6nm0mRJ.mjs.map → serializer-dhv07Z6F.mjs.map} +1 -1
  36. package/dist/streaming.mjs +103 -68
  37. package/dist/streaming.mjs.map +1 -1
  38. package/dist/styles.mjs +3 -3
  39. package/dist/{stylesheet-writer-oXSuGnJy.mjs → stylesheet-writer-BBYjNSMA.mjs} +184 -113
  40. package/dist/stylesheet-writer-BBYjNSMA.mjs.map +1 -0
  41. package/dist/{table-BrP0RwUd.mjs → table-BFi2WmgG.mjs} +2 -2
  42. package/dist/{table-BrP0RwUd.mjs.map → table-BFi2WmgG.mjs.map} +1 -1
  43. package/dist/utils/cell-number.d.ts +10 -0
  44. package/dist/utils/coordinate.d.ts +11 -0
  45. package/dist/utils/escape.d.ts +17 -0
  46. package/dist/utils/xsd-boolean.d.ts +9 -0
  47. package/dist/utils.mjs +2 -2
  48. package/dist/{workbook-DOTFzCpz.mjs → workbook-CMel6UcI.mjs} +7 -7
  49. package/dist/{workbook-DOTFzCpz.mjs.map → workbook-CMel6UcI.mjs.map} +1 -1
  50. package/dist/workbook.mjs +2 -2
  51. package/dist/{worksheet-B2NOQ6dM.mjs → worksheet-Cxn2c-jz.mjs} +3 -3
  52. package/dist/{worksheet-B2NOQ6dM.mjs.map → worksheet-Cxn2c-jz.mjs.map} +1 -1
  53. package/dist/worksheet.mjs +2 -2
  54. package/dist/xml.mjs +2 -2
  55. package/dist/zip.mjs +1 -1
  56. package/package.json +1 -1
  57. package/dist/cell-Df3cKRIl.mjs.map +0 -1
  58. package/dist/coordinate-Bt5Gni2I.mjs.map +0 -1
  59. package/dist/escape-rnWSPpWY.mjs.map +0 -1
  60. package/dist/reader-DHMxLBQV.mjs.map +0 -1
  61. package/dist/serialize-BC2Wu3bR.mjs.map +0 -1
  62. package/dist/stylesheet-writer-oXSuGnJy.mjs.map +0 -1
@@ -1,5 +1,5 @@
1
1
  import { r as normalizeFormulaText } from "./inference-BMvv9cUY.mjs";
2
- import { a as addTable, ln as parseMultiCellRange } from "./worksheet-B2NOQ6dM.mjs";
2
+ import { a as addTable, ln as parseMultiCellRange } from "./worksheet-Cxn2c-jz.mjs";
3
3
  //#region src/worksheet/conditional-formatting.ts
4
4
  function makeConditionalFormatting(opts) {
5
5
  return {
@@ -112,4 +112,4 @@ const addExcelTable = (wb, ws, opts) => {
112
112
  //#endregion
113
113
  export { makeCfRule as a, makeDataValidation as i, makeTableColumn as n, makeConditionalFormatting as o, makeTableDefinition as r, addExcelTable as t };
114
114
 
115
- //# sourceMappingURL=table-BrP0RwUd.mjs.map
115
+ //# sourceMappingURL=table-BFi2WmgG.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"table-BrP0RwUd.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"}
1
+ {"version":3,"file":"table-BFi2WmgG.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"}
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Value of a numeric cell's `<v>`: a finite number, or `null` when the element
3
+ * is absent or blank, which is an empty cell.
4
+ *
5
+ * `Number.parseFloat` answers NaN for text and ±Infinity for an exponent past
6
+ * the double range. The writer refuses to serialise either, so a file carrying
7
+ * one is rejected here, while the sheet and cell that hold it are still known,
8
+ * rather than at the far end of the pipeline on save.
9
+ */
10
+ export declare function parseCellNumber(raw: string | undefined, sheet: string, col: number, row: number): number | null;
@@ -89,6 +89,17 @@ export declare function isValidColumnLetter(s: unknown): s is string;
89
89
  * Non-finite / non-integer / out-of-bound fails.
90
90
  */
91
91
  export declare function isValidRowNumber(n: unknown): n is number;
92
+ /**
93
+ * Row number carried by a `<row>`'s `@r`. A malformed or out-of-range value
94
+ * throws: renumbering it would shift every row after it, and the file is
95
+ * already one no reader can agree on.
96
+ */
97
+ export declare function rowNumberFromAttr(raw: string, where: string): number;
98
+ /**
99
+ * Row number for a `<row>` that omits `@r` and holds no cell to locate it:
100
+ * `fallback`, the slot after the highest row read so far.
101
+ */
102
+ export declare function derivedRowNumber(fallback: number, where: string): number;
92
103
  /**
93
104
  * Predicate: true iff `n` is a valid 1-based column index in `[1, 16384]`.
94
105
  * Non-finite / non-integer / out-of-bound fails.
@@ -30,3 +30,20 @@ export declare function escapeXmlText(s: string): string;
30
30
  * `loadWorkbook`. Leaving them literal also matches what Excel itself emits.
31
31
  */
32
32
  export declare function escapeXmlAttr(s: string): string;
33
+ /**
34
+ * Escape text for an OOXML text node the reader hands back verbatim: `<f>`,
35
+ * `<formula>`, `<formula1>`, `<formula2>` and a `t="str"` cached formula
36
+ * result. The `_xHHHH_` convention of {@link escapeCellString} must not be
37
+ * applied to these: nothing decodes them on read, so an encoded sequence would
38
+ * reach Excel as the literal text `_x000D_`.
39
+ *
40
+ * Tab and LF stay literal; CR becomes a numeric character reference, which
41
+ * survives the CR-to-LF normalisation every conforming parser applies to raw
42
+ * text. A codepoint XML 1.0 cannot represent therefore has nowhere to go and is
43
+ * rejected rather than silently rewritten.
44
+ *
45
+ * `node` and `at` name the offending value in that error (`worksheet: formula`
46
+ * / `A1`). They stay separate so that a formula-heavy sheet does not build one
47
+ * message string per cell for an error it never raises.
48
+ */
49
+ export declare function escapeXmlTextVerbatim(s: string, node: string, at: string): string;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Parse an xsd:boolean, or `undefined` when the text is outside its lexical
3
+ * space. The type's whiteSpace facet is `collapse`, so the padding a
4
+ * pretty-printer leaves around the text is insignificant and a reformatted
5
+ * part reads the same as a compact one. `t` / `f` and mixed case are outside
6
+ * the lexical space proper, but openpyxl accepts them, so the readers here do
7
+ * too rather than rejecting a file another tool opens.
8
+ */
9
+ export declare const parseXsdBoolean: (raw: string | undefined) => boolean | undefined;
package/dist/utils.mjs CHANGED
@@ -1,8 +1,8 @@
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-Bt5Gni2I.mjs";
2
+ import { a as columnLetterFromIndex, d as isValidColumnLetter, f as isValidColumnNumber, g as rangeBoundaries, h as parseSheetRange, i as columnIndexFromLetter, l as formatSheetQualifiedRef, m as isValidRowNumber, n as MAX_ROW, o as coordinateFromString, p as isValidRangeRef, r as boundariesToRangeString, s as coordinateToTuple, t as MAX_COL, u as isValidCellRef, v as tupleToCoordinate } from "./coordinate-CxC88uBk.mjs";
3
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
- import { i as unescapeCellString, t as escapeCellString } from "./escape-rnWSPpWY.mjs";
5
+ import { a as unescapeCellString, t as escapeCellString } from "./escape-rA5UpibT.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";
7
7
  //#region src/utils/css.ts
8
8
  /**
@@ -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-Bt5Gni2I.mjs";
3
- import { h as isFormulaValue } from "./cell-Df3cKRIl.mjs";
2
+ import { h as parseSheetRange, s as coordinateToTuple } from "./coordinate-CxC88uBk.mjs";
3
+ import { h as isFormulaValue } from "./cell-B5OUUdfI.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-ZJ3h4VHD.mjs";
6
- import { i as unescapeCellString, n as escapeXmlAttr, r as escapeXmlText, t as escapeCellString } from "./escape-rnWSPpWY.mjs";
5
+ import { a as makeChartDrawingItem, d as makeAbsoluteAnchor, o as makeDrawing } from "./drawing-Cv6UtInY.mjs";
6
+ import { a as unescapeCellString, n as escapeXmlAttr, r as escapeXmlText, t as escapeCellString } from "./escape-rA5UpibT.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 getCellComment, O as getCellHyperlink, R as getMergedRangeAt, St as setCellByCoord, T as getCell, _ as countCellsByKind, bn as colorToHex, fn as rangeContainsCell, mn as rangeToString, ot as makeWorksheet, sn as multiCellRangeContainsCell, u as classifyCellValue, un as parseRange } from "./worksheet-B2NOQ6dM.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-CNsET6WU.mjs";
9
+ import { D as getCellComment, O as getCellHyperlink, R as getMergedRangeAt, St as setCellByCoord, T as getCell, _ as countCellsByKind, bn as colorToHex, fn as rangeContainsCell, mn as rangeToString, ot as makeWorksheet, sn as multiCellRangeContainsCell, u as classifyCellValue, un as parseRange } from "./worksheet-Cxn2c-jz.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-DjKKPWDL.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`;
@@ -659,4 +659,4 @@ function listCustomXmlParts(wb) {
659
659
  //#endregion
660
660
  export { serializeRichString as A, addSharedRichText as C, makeSharedStrings as D, getSharedStringIndex as E, sharedStringsToBytes as M, 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, sharedStringCount 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 };
661
661
 
662
- //# sourceMappingURL=workbook-DOTFzCpz.mjs.map
662
+ //# sourceMappingURL=workbook-CMel6UcI.mjs.map