@sheetxl/io-xlsx 0.8.0-beta.9 → 1.0.2

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 (205) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/BPn0BJd77_Q1lYVz.mjs +7021 -0
  3. package/browser/esm/BfV9IAl46gJxLRsa.mjs +2474 -0
  4. package/browser/esm/{DsSIg46AR7IFBN5N.mjs → C1Ql7gO6TtQglsOH.mjs} +939 -804
  5. package/browser/esm/{CxtFawTfwRTCC4Xr.mjs → C74cxGSvdlAfqeqF.mjs} +2 -2
  6. package/browser/esm/CZ3s0Cfjqm3BRszF.mjs +104 -0
  7. package/browser/esm/ChMFy3Rg97YbbuTB.mjs +4632 -0
  8. package/browser/esm/D2WBxzN8ubzIrJ4h.mjs +10323 -0
  9. package/browser/esm/{D-epcZSoKLbsAIaC.mjs → DtUTX1O34sAvjw_I.mjs} +3 -3
  10. package/browser/esm/{C-2KaUyV4gs-sDTZ.mjs → K9Sy1I7Pix2m7GJj.mjs} +194 -144
  11. package/browser/esm/{CRrTMRdN_IcSA_pm.mjs → cjLbism9wq4om43B.mjs} +3 -3
  12. package/browser/esm/index.mjs +3 -4
  13. package/browser/esm/rF6yS_NgcKLlMbGR.mjs +24 -0
  14. package/licenses/dependencies.txt +2 -2
  15. package/node/esm/BMVTOvvr98SnUmif.mjs +2478 -0
  16. package/node/esm/BXHjX5Jr7ZO7XFp1.mjs +6957 -0
  17. package/node/esm/{CBtj0-a4l2qux2hA.mjs → BeAzln1Wp4oOc7xJ.mjs} +3 -3
  18. package/node/esm/C2FEO68INNEEnWCd.mjs +4746 -0
  19. package/node/esm/DDI2JK7U9TLsIobf.mjs +2562 -0
  20. package/node/esm/DhIaDwktkAy1xpDs.mjs +7284 -0
  21. package/node/esm/{BCr4lCI6qQXXN0K1.mjs → el-uWAcXKFVwmwZ-.mjs} +3 -3
  22. package/node/esm/index.mjs +65 -28
  23. package/node/esm/{BsTMtvwpQoPNv95M.mjs → kFd-ABtolhQt-Hqv.mjs} +2 -2
  24. package/package.json +9 -10
  25. package/types/src/AutoFilterRules.d.ts +34 -44
  26. package/types/src/ConditionalFormatRules.d.ts +2 -2
  27. package/types/src/DataTableFormula.d.ts +26 -0
  28. package/types/src/DataValidationRules.d.ts +0 -5
  29. package/types/src/DefinedNameAttributes.d.ts +8 -0
  30. package/types/src/ExcelCalcStamp.d.ts +0 -36
  31. package/types/src/ExcelCompat.d.ts +15 -143
  32. package/types/src/ExcelFunctionFacts.d.ts +0 -272
  33. package/types/src/ExcelReservedNames.d.ts +0 -65
  34. package/types/src/KnownFonts.d.ts +37 -0
  35. package/types/src/LegacyFormula.d.ts +1 -46
  36. package/types/src/OOXMLExtensions.d.ts +24 -2
  37. package/types/src/PageLayoutAttributes.d.ts +8 -0
  38. package/types/src/Plugin.d.ts +15 -3
  39. package/types/src/ProtectionAttributes.d.ts +2 -2
  40. package/types/src/SheetKinds.d.ts +42 -0
  41. package/types/src/SheetViewAttributes.d.ts +4 -0
  42. package/types/src/SortExtent.d.ts +16 -0
  43. package/types/src/SourcePackage.d.ts +0 -44
  44. package/types/src/SparklineGroups.d.ts +52 -0
  45. package/types/src/Types.d.ts +13 -3
  46. package/types/src/XlsxHeader.d.ts +19 -0
  47. package/types/src/chart/ChartExXml.d.ts +38 -0
  48. package/types/src/chart/ChartPartXml.d.ts +47 -0
  49. package/types/src/chart/ChartSpaceXml.d.ts +37 -0
  50. package/types/src/chart/_XmlTree.d.ts +34 -0
  51. package/types/src/chart/_chartCodecs.d.ts +12 -0
  52. package/types/src/chart/_chartExCodecs.d.ts +7 -0
  53. package/types/src/chart/_chartExFold.d.ts +14 -0
  54. package/types/src/chart/_chartExMarkup.d.ts +236 -0
  55. package/types/src/chart/_chartExStyle.d.ts +13 -0
  56. package/types/src/chart/_codec.d.ts +78 -0
  57. package/types/src/chart/_drawingml.d.ts +10 -0
  58. package/types/src/chart/_xml.d.ts +70 -0
  59. package/types/src/pivot/PivotArea.d.ts +20 -0
  60. package/types/src/pivot/PivotCacheRead.d.ts +30 -0
  61. package/types/src/pivot/PivotCacheWrite.d.ts +23 -0
  62. package/types/src/pivot/PivotFilters.d.ts +29 -0
  63. package/types/src/pivot/PivotFormats.d.ts +60 -0
  64. package/types/src/pivot/PivotTableRead.d.ts +44 -0
  65. package/types/src/pivot/PivotTableWrite.d.ts +13 -0
  66. package/types/src/pivot/_PivotCacheXml.d.ts +48 -0
  67. package/types/src/pivot/_PivotTableXml.d.ts +23 -0
  68. package/types/src/reader/CellControls.d.ts +18 -0
  69. package/types/src/reader/DocumentPropertiesRead.d.ts +16 -0
  70. package/types/src/reader/DummyFunctionUnwrap.d.ts +43 -23
  71. package/types/src/reader/HeaderStyles.d.ts +15 -0
  72. package/types/src/reader/IsoDateCell.d.ts +20 -0
  73. package/types/src/reader/LibreOfficeDataTable.d.ts +12 -0
  74. package/types/src/reader/PivotButtons.d.ts +14 -0
  75. package/types/src/reader/PivotCellFormats.d.ts +22 -0
  76. package/types/src/reader/SlicerJoin.d.ts +26 -0
  77. package/types/src/reader/ZipReader.d.ts +1 -1
  78. package/types/src/reader/_SlicerRecord.d.ts +59 -0
  79. package/types/src/reader/dom/DOMTransformer.d.ts +2 -2
  80. package/types/src/reader/domVisitors/AppPropertiesVisitor.d.ts +13 -1
  81. package/types/src/reader/domVisitors/AutoFilterVisitor.d.ts +3 -11
  82. package/types/src/reader/domVisitors/ColorContainerVisitor.d.ts +8 -1
  83. package/types/src/reader/domVisitors/CommentVisitor.d.ts +2 -2
  84. package/types/src/reader/domVisitors/DrawingElementVisitor.d.ts +13 -6
  85. package/types/src/reader/domVisitors/DrawingGraphicFrameVisitor.d.ts +9 -0
  86. package/types/src/reader/domVisitors/DrawingGrpSpVisitor.d.ts +10 -7
  87. package/types/src/reader/domVisitors/DrawingPicVisitor.d.ts +22 -13
  88. package/types/src/reader/domVisitors/DrawingSpVisitor.d.ts +5 -5
  89. package/types/src/reader/domVisitors/DrawingVisitor.d.ts +4 -2
  90. package/types/src/reader/domVisitors/ExternalLinkVisitor.d.ts +1 -11
  91. package/types/src/reader/domVisitors/FeaturePropertyBagVisitor.d.ts +18 -0
  92. package/types/src/reader/domVisitors/FmtSchemeVisitor.d.ts +0 -11
  93. package/types/src/reader/domVisitors/FontSchemeVisitor.d.ts +3 -2
  94. package/types/src/reader/domVisitors/ObjectDefaultsVisitor.d.ts +11 -0
  95. package/types/src/reader/domVisitors/SheetColorContainerVisitor.d.ts +2 -2
  96. package/types/src/reader/domVisitors/SheetStyleVisitor.d.ts +26 -5
  97. package/types/src/reader/domVisitors/SlicerCacheDefinitionVisitor.d.ts +11 -2
  98. package/types/src/reader/domVisitors/SlicersVisitor.d.ts +9 -3
  99. package/types/src/reader/domVisitors/SortStateVisitor.d.ts +2 -2
  100. package/types/src/reader/domVisitors/ThreadedCommentsVisitor.d.ts +2 -2
  101. package/types/src/reader/domVisitors/TimelinesVisitor.d.ts +13 -0
  102. package/types/src/reader/domVisitors/WorkbookVisitor.d.ts +0 -9
  103. package/types/src/reader/domVisitors/_Dxfs.d.ts +10 -0
  104. package/types/src/reader/domVisitors/index.d.ts +6 -34
  105. package/types/src/reader/saxVisitors/ContentTypesVisitor.d.ts +1 -0
  106. package/types/src/reader/saxVisitors/SharedStringsVisitor.d.ts +31 -6
  107. package/types/src/reader/saxVisitors/WorksheetVisitor.d.ts +26 -8
  108. package/types/src/richValue/ErrorRichValueHandler.d.ts +22 -0
  109. package/types/src/richValue/IRichValueHandler.d.ts +109 -0
  110. package/types/src/richValue/LocalImageRichValueHandler.d.ts +18 -0
  111. package/types/src/richValue/RichDataParts.d.ts +69 -0
  112. package/types/src/richValue/RichRecordWriter.d.ts +61 -0
  113. package/types/src/richValue/RichValueHandlers.d.ts +25 -0
  114. package/types/src/richValue/RichValueResolver.d.ts +54 -0
  115. package/types/src/richValue/WebImageRichValueHandler.d.ts +37 -0
  116. package/types/src/richValue/index.d.ts +7 -0
  117. package/types/src/utils/DrawingMLText.d.ts +2 -2
  118. package/types/src/utils/FormControls.d.ts +79 -6
  119. package/types/src/utils/SharedNames.d.ts +13 -0
  120. package/types/src/utils/SpreadsheetFont.d.ts +38 -0
  121. package/types/src/utils/VmlNoteShapes.d.ts +25 -32
  122. package/types/src/utils/VmlNoteStyle.d.ts +25 -0
  123. package/types/src/utils/VmlPrefixes.d.ts +24 -0
  124. package/types/src/vba/VBAProject.d.ts +0 -19
  125. package/types/src/writer/EvaluationSheet.d.ts +5 -0
  126. package/types/src/writer/builder/OpcXmlUtils.d.ts +0 -8
  127. package/types/src/writer/builder/PackageBuilder.d.ts +2 -41
  128. package/types/src/writer/builder/Types.d.ts +18 -28
  129. package/types/src/writer/emitters/CommentsEmitter.d.ts +3 -3
  130. package/types/src/writer/emitters/DrawingEmitter.d.ts +2 -2
  131. package/types/src/writer/emitters/ExternalLinkEmitter.d.ts +0 -11
  132. package/types/src/writer/emitters/FeaturePropertyBagEmitter.d.ts +8 -0
  133. package/types/src/writer/emitters/LegacyDrawingEmitter.d.ts +4 -4
  134. package/types/src/writer/emitters/PivotTableEmitter.d.ts +30 -1
  135. package/types/src/writer/emitters/PropsCoreEmitter.d.ts +7 -2
  136. package/types/src/writer/emitters/PropsCustomEmitter.d.ts +15 -0
  137. package/types/src/writer/emitters/RichValuePartsEmitters.d.ts +36 -0
  138. package/types/src/writer/emitters/RichValueRelEmitter.d.ts +12 -0
  139. package/types/src/writer/emitters/RichValueStructureEmitter.d.ts +4 -3
  140. package/types/src/writer/emitters/RichValueTypesEmitter.d.ts +3 -2
  141. package/types/src/writer/emitters/RichValueWebImageEmitter.d.ts +24 -0
  142. package/types/src/writer/emitters/SharedStringsEmitter.d.ts +6 -3
  143. package/types/src/writer/emitters/SlicerEmitter.d.ts +132 -0
  144. package/types/src/writer/emitters/StylesEmitter.d.ts +35 -2
  145. package/types/src/writer/emitters/TableEmitter.d.ts +14 -0
  146. package/types/src/writer/emitters/WorkbookEmitter.d.ts +24 -2
  147. package/types/src/writer/emitters/WorksheetEmitter.d.ts +4 -3
  148. package/types/src/writer/utils/AutoFilter.d.ts +3 -3
  149. package/types/src/writer/utils/CellControlComplements.d.ts +29 -0
  150. package/types/src/writer/utils/DateSystem.d.ts +6 -0
  151. package/types/src/writer/utils/DefaultRows.d.ts +22 -0
  152. package/types/src/writer/utils/DrawMLUtils.d.ts +8 -6
  153. package/types/src/writer/utils/DummyFunction.d.ts +0 -25
  154. package/types/src/writer/utils/DxfCollector.d.ts +14 -11
  155. package/types/src/writer/utils/PrstGeomUtils.d.ts +11 -3
  156. package/types/src/writer/utils/RichValueCollector.d.ts +81 -129
  157. package/types/src/writer/utils/SheetStyleLayout.d.ts +86 -0
  158. package/types/src/writer/utils/TextUtils.d.ts +6 -1
  159. package/types/src/writer/utils/UnsupportedFunctions.d.ts +2 -2
  160. package/types/src/writer/utils/XfVariants.d.ts +61 -0
  161. package/browser/cjs/B0Ugu_crqQYpdfQz.cjs +0 -1
  162. package/browser/cjs/B6sirGz6w-Bm7Ofo.cjs +0 -1
  163. package/browser/cjs/BHM3_D9PsNURVAVy.cjs +0 -1
  164. package/browser/cjs/BHWdwAQ322YA8JAZ.cjs +0 -6
  165. package/browser/cjs/CeuX8p1aBuKTuagi.cjs +0 -2
  166. package/browser/cjs/D3EWCPfCu-qMOIGd.cjs +0 -1
  167. package/browser/cjs/DSM4q1dhVVXvsgby.cjs +0 -30
  168. package/browser/cjs/DiAHwNv2I8RHE9GY.cjs +0 -1
  169. package/browser/cjs/index.cjs +0 -1
  170. package/browser/cjs/wrpXlaSBGEicQf6_.cjs +0 -6
  171. package/browser/cjs/xQ6-wbTw5UzZUM1Y.cjs +0 -1
  172. package/browser/esm/Bu64BYvRAlVftMr1.mjs +0 -67
  173. package/browser/esm/CWt4fDYEbj2hvsl_.mjs +0 -3346
  174. package/browser/esm/Ccnxz-y2WBEgfvvh.mjs +0 -6498
  175. package/browser/esm/Dx64JMAGwNNDBkC1.mjs +0 -4928
  176. package/browser/esm/Sv4twwEJDb9dZ91h.mjs +0 -149
  177. package/node/esm/BPn5XBizKkwaUqXB.mjs +0 -4285
  178. package/node/esm/BVV11IlqF6Lmlv8D.mjs +0 -154
  179. package/node/esm/BiJEEgltJzx94zIR.mjs +0 -3433
  180. package/node/esm/CkmZuMvRTpva7eQu.mjs +0 -5074
  181. package/node/esm/j0RE2usgdljRw_gr.mjs +0 -2345
  182. package/types/src/legacyChart/OOXMLMappings.d.ts +0 -8
  183. package/types/src/legacyChart/OOXMLUtils.d.ts +0 -78
  184. package/types/src/legacyChart/ToOOXMLConverter.d.ts +0 -30
  185. package/types/src/reader/domVisitors/AxisVisitor.d.ts +0 -12
  186. package/types/src/reader/domVisitors/BarChartTypeVisitor.d.ts +0 -6
  187. package/types/src/reader/domVisitors/ChartSpaceVisitor.d.ts +0 -6
  188. package/types/src/reader/domVisitors/ChartTypeVisitor.d.ts +0 -7
  189. package/types/src/reader/domVisitors/ChartVisitor.d.ts +0 -7
  190. package/types/src/reader/domVisitors/DataLabelsVisitor.d.ts +0 -8
  191. package/types/src/reader/domVisitors/DataPointVisitor.d.ts +0 -6
  192. package/types/src/reader/domVisitors/LayoutVisitor.d.ts +0 -5
  193. package/types/src/reader/domVisitors/LegendEntryVisitor.d.ts +0 -5
  194. package/types/src/reader/domVisitors/LegendVisitor.d.ts +0 -5
  195. package/types/src/reader/domVisitors/MarkerVisitor.d.ts +0 -5
  196. package/types/src/reader/domVisitors/NegativeShapeVisitor.d.ts +0 -6
  197. package/types/src/reader/domVisitors/PlotAreaVisitor.d.ts +0 -5
  198. package/types/src/reader/domVisitors/RichValueDataVisitor.d.ts +0 -7
  199. package/types/src/reader/domVisitors/RichValueStructureVisitor.d.ts +0 -6
  200. package/types/src/reader/domVisitors/SeriesVisitor.d.ts +0 -8
  201. package/types/src/reader/domVisitors/TitleVisitor.d.ts +0 -9
  202. package/types/src/writer/emitters/ChartColorsEmitter.d.ts +0 -7
  203. package/types/src/writer/emitters/ChartEmitter.d.ts +0 -14
  204. package/types/src/writer/emitters/ChartStyleEmitter.d.ts +0 -46
  205. package/types/src/writer/utils/HiddenFormulaXfs.d.ts +0 -28
@@ -1,4 +1,4 @@
1
- import { IFill, IStroke, IEffect, IHyperlink, IResource, IShape, IStyleCollection, ITheme } from '@sheetxl/sdk';
1
+ import { IFill, IStroke, IEffect, IHyperlink, IResource, IStyleCollection, ITheme } from '@sheetxl/sdk';
2
2
  import { EmitContext, IXmlWriter } from '../builder';
3
3
  /**
4
4
  * A `hlinkClick`/`hlinkHover` element for a hyperlink: its address becomes an external
@@ -11,9 +11,9 @@ export declare const writeHyperlinkElement: (ctx: EmitContext, xml: IXmlWriter,
11
11
  /**
12
12
  * Writes fill definitions (patterns and gradients).
13
13
  */
14
- export declare function writeFill(ctx: EmitContext, xml: IXmlWriter, fill: IFill.NoneProperties | IFill.SolidProperties | IFill.PatternProperties | IFill.GradientProperties | IFill.ImageProperties, styles: IStyleCollection, spreadsheetML?: boolean, // SpreadsheetML uses pattern fills but standard DrawML does not.
14
+ export declare function writeFill(ctx: EmitContext, xml: IXmlWriter, fill: IFill.NoneProperties | IFill.SolidProperties | IFill.PatternProperties | IFill.GradientProperties | IFill.ImageProperties | IFill.GroupProperties, styles: IStyleCollection, spreadsheetML?: boolean, // SpreadsheetML uses pattern fills but standard DrawML does not.
15
15
  isDxf?: boolean): void;
16
- export declare const writeLn: (ctx: EmitContext, xml: IXmlWriter, line: IStroke.JSON | Record<string, any>, styles: IStyleCollection) => void;
16
+ export declare const writeLn: (ctx: EmitContext, xml: IXmlWriter, line: IStroke.JSON | string | null | undefined, styles: IStyleCollection) => void;
17
17
  export declare const writeFillLnEffects: (ctx: EmitContext, styles: IStyleCollection, json: any, element?: string | undefined, includeEmptyEffects?: boolean) => void;
18
18
  /**
19
19
  * Writes an `<a:effectLst>` from a list of parsed effects (see `ColorContainerVisitor.getEffects`) —
@@ -56,10 +56,12 @@ export declare const imagePartFor: (ctx: EmitContext, resource: IResource) => Im
56
56
  */
57
57
  export declare const resourceById: (ctx: EmitContext, resId: number | undefined) => IResource | undefined;
58
58
  /**
59
- * Relates every image a shape's fills name — its own and, in a group, its members' — before the
60
- * shape is written: fills are written synchronously, the parts they cite are added asynchronously.
59
+ * Relates the image a shape's or a group's fill names before it is written: fills are written
60
+ * synchronously, the parts they cite are added asynchronously.
61
61
  */
62
- export declare const addImageFillParts: (ctx: EmitContext, json: IShape.JSON | undefined) => Promise<void>;
62
+ export declare const addImageFillParts: (ctx: EmitContext, json: {
63
+ fill?: IFill.JSON;
64
+ } | undefined) => Promise<void>;
63
65
  /**
64
66
  * The children of a `blipFill` — the `blip`, the source rectangle and the tile or stretch — in
65
67
  * the writer's current default namespace. A `pic` writes them inside its own `xdr:blipFill`.
@@ -1,29 +1,4 @@
1
1
  import { Scalar, IWorkbook } from '@sheetxl/sdk';
2
- /**
3
- * Exporting a formula Excel cannot evaluate.
4
- *
5
- * Excel has no notion of "a function I do not know but should keep working". A name it does not
6
- * have evaluates to `#NAME?` and the computed value is gone — so a user's own UDF, or one of the
7
- * 29 built-ins Excel lacks, survives a save as an error and nothing else.
8
- *
9
- * Google Sheets solved this years ago and the shape is a de-facto convention, so we emit THEIR
10
- * spelling rather than inventing one — the same text is then understood by Sheets, by Grid, and by
11
- * our own reader, which needs a single unwrap path either way:
12
- *
13
- * ```
14
- * IFERROR(__xludf.DUMMYFUNCTION("ISEMAIL(""biggie"")"),FALSE)
15
- * ```
16
- *
17
- * The unknown call errors in Excel, `IFERROR` yields the literal, and the cell keeps showing the
18
- * right answer. The original formula text rides along as a string argument, which is what lets the
19
- * round trip back into SheetXL be lossless.
20
- *
21
- * The trade is real and worth stating: **the formula is dead in Excel.** It never recalculates, so
22
- * editing a precedent leaves a stale value with no visual cue. That is Google's trade too; the
23
- * alternative (emit bare, show `#NAME?`) loses the value instead. See CALC-ISSUES item 7.
24
- *
25
- * @see https://docs.grid.is/apiary/explain/gsdv/
26
- */
27
2
  /** Google's marker. Deliberately their exact spelling — see the note above. */
28
3
  export declare const DUMMY_FUNCTION = "__xludf.DUMMYFUNCTION";
29
4
  /**
@@ -1,22 +1,25 @@
1
- import { IStyle } from '@sheetxl/sdk';
1
+ import { ICellStyle } from '@sheetxl/sdk';
2
2
  /**
3
- * Accumulates conditional-format differential styles (dxfs) as worksheets emit, so the styles
4
- * part — written after the worksheets — can include them in `<dxfs>`.
3
+ * Accumulates the differential styles (dxfs) a worksheet and its parts cite — conditional formats,
4
+ * color filters, color sorts — so the styles part, written after the worksheets, can include them
5
+ * in `<dxfs>`.
5
6
  *
6
- * Index contract: conditional-format dxfs take `0..count-1`; the table-style dxfs the styles
7
- * emitter denormalizes are appended after and offset by {@link getCount}. This keeps the
8
- * `dxfId` written into worksheet XML final at worksheet-emit time.
7
+ * Index contract: collected dxfs take `0..count-1`; the table-style dxfs the styles emitter
8
+ * denormalizes are appended after and offset by {@link getCount}. This keeps the `dxfId` written
9
+ * into worksheet and table XML final at the time it is written.
9
10
  *
10
- * Shared via `EmitContext.getSharedStates()` under the `"cfDxfs"` key (see `MetadataCollector`
11
- * for the pattern).
11
+ * Shared via `EmitContext.getSharedStates()` under {@link DXFS_SHARED_STATE}; use
12
+ * {@link dxfCollectorOf} (see `MetadataCollector` for the pattern).
12
13
  */
13
14
  export declare class DxfCollector {
14
15
  private readonly _dxfs;
15
16
  private readonly _byKey;
16
17
  /** Returns the dxf index for the style, adding it if not yet collected. */
17
- add(style: IStyle.JSON): number;
18
- getDxfs(): readonly IStyle.JSON[];
18
+ add(style: ICellStyle.JSON): number;
19
+ getDxfs(): readonly ICellStyle.JSON[];
19
20
  getCount(): number;
20
21
  }
21
- export declare const CF_DXFS_SHARED_STATE = "cfDxfs";
22
+ export declare const DXFS_SHARED_STATE = "dxfs";
23
+ /** The write's collector, created on first use. */
24
+ export declare const dxfCollectorOf: (sharedStates: Map<string, any>) => DxfCollector;
22
25
  //# sourceMappingURL=DxfCollector.d.ts.map
@@ -1,6 +1,14 @@
1
+ import { IGeometry } from '@sheetxl/sdk';
1
2
  /**
2
- * The `prstGeom` element: a preset name plus its adjust values.
3
+ * `[name, fmla]` pairs for an `avLst`. Values are integers in the file.
4
+ *
5
+ * @remarks
6
+ * Excel rejects an `avLst` that lists some of a preset's adjust values but not all of them, so
7
+ * from a geometry every value is written, defaults included, once any is adjusted. Without one
8
+ * (a preset this SDK does not define) the values are written as they are.
9
+ *
10
+ * @param geometry The shape's evaluated geometry, or `null` when there is none.
11
+ * @param adjustments The values the shape sets.
3
12
  */
4
- /** `[name, fmla]` pairs for an `avLst`, in a stable order. Values are integers in the file. */
5
- export declare const adjustValueEntries: (adjustments: Record<string, number> | undefined | null) => [string, string][];
13
+ export declare const adjustValueEntries: (geometry: IGeometry | null, adjustments: Record<string, number> | undefined | null) => [string, string][];
6
14
  //# sourceMappingURL=PrstGeomUtils.d.ts.map
@@ -1,4 +1,6 @@
1
- import { Scalar } from '@sheetxl/sdk';
1
+ import { IWorkbook, Scalar } from '@sheetxl/sdk';
2
+ import { EmitContext } from '../builder';
3
+ import { RichItemText, RichStructureKey, RichStyleDef, RichValueKeyFlags, RichValueSink, RichValueStructureDef } from '../../richValue';
2
4
  import { MetadataCollector } from './MetadataCollector';
3
5
  /**
4
6
  * Accumulates rich-value entries so that RichValueEmitter and
@@ -20,84 +22,33 @@ import { MetadataCollector } from './MetadataCollector';
20
22
  * ## XML output relationship
21
23
  *
22
24
  * ```
23
- * rdrichvaluestructure.xml – one <s> per unique handler type
25
+ * rdrichvaluestructure.xml – one <s> per structure written
24
26
  * rdrichvalue.xml – one <rv> per registered entry (s= → structure index)
25
27
  * metadata.xml futureMetadata XLRICHVALUE – one <bk> per unique rdrichvalue entry
26
28
  * metadata.xml valueMetadata – one <bk> per cell (vm= index)
27
29
  * ```
28
- */
29
- /**
30
- * OOXML primitive-value type codes used in `<k t="…">` attributes inside
31
- * `<rvStructures>`.
32
- *
33
- * "d" - Date/Time (ISO-8601 string)
34
- * "i" - Integer (32-bit signed)
35
- * "b" - Boolean
36
- * "e" - Error value
37
- * "s" - Inline string
38
- * "r" - Nested rich value
39
- * "a" - Array data (rdarray.xml)
40
- * "spb" - Supporting property bag
41
- */
42
- export type RichPrimitiveType = 'd' | 'i' | 'b' | 'e' | 's' | 'r' | 'a' | 'spb';
43
- /**
44
- * One property slot in a rich-value schema.
45
30
  *
46
- * - `name` – OOXML key name (`n=` attribute on `<k>`).
47
- * - `type` – OOXML primitive type (`t=` attribute on `<k>`).
48
- * - `defaultValue` – Serialized fallback used when the property is absent or
49
- * `undefined` on the raw value object. Defaults to `''`.
31
+ * What each value writes is its {@link IRichValueHandler}'s ({@link RichValueHandlers}).
50
32
  */
51
- export type RichValueProp = [name: string, type: RichPrimitiveType, defaultValue?: string];
52
- /**
53
- * Base class (and usable concrete class) for rich-value handler/schema types.
54
- *
55
- * Instantiate directly for pure-schema handlers:
56
- * ```ts
57
- * const MyHandler = new RichValueHandler('_myType', [
58
- * ['foo', 'i', '0'],
59
- * ['bar', 's', ''],
60
- * ]);
61
- * ```
62
- *
63
- * Subclass and override {@link getValues} for handlers that need custom
64
- * serialization logic.
65
- *
66
- * Pass instances to {@link RichValueCollector.register}.
67
- */
68
- export declare class RichValueHandler {
69
- /**
70
- * The OOXML structure type name (value of the `t=` attribute on `<s>`
71
- * inside `<rvStructures>`). E.g. `"_error"`.
72
- */
73
- readonly type: string;
74
- /**
75
- * Ordered property definitions written as `<k n="…" t="…"/>` inside the
76
- * matching `<s>` element in `rdrichvaluestructure.xml`.
77
- */
78
- readonly props: ReadonlyArray<RichValueProp>;
79
- constructor(type: string, props: ReadonlyArray<RichValueProp>);
80
- /**
81
- * Extracts the serializable string values for one `<rv>` entry in
82
- * `rdrichvalue.xml`. The array is parallel to {@link props}.
83
- *
84
- * The default implementation reads each property by name from `rawValue`
85
- * (treated as a `Record<string, unknown>`) and falls back to the prop's
86
- * `defaultValue` (or `''`) when the property is absent or `undefined`.
87
- *
88
- * Override in subclasses for custom serialization logic.
89
- *
90
- * @param rawValue The raw value that was passed to
91
- * {@link RichValueCollector.add} / `_register`.
92
- */
93
- getValues(rawValue: Record<string, unknown>): string[];
94
- }
95
33
  /** One registered rich-value entry. */
96
34
  export interface RichValueEntry {
97
- /** The handler (type descriptor / callback) for this entry. */
98
- handler: RichValueHandler;
99
- /** The raw value provided at registration time. */
100
- rawValue: any;
35
+ /** The structure the entry is written as. */
36
+ structure: RichValueStructureDef;
37
+ /** The `<v>`s, parallel to the structure's keys. */
38
+ values: readonly string[];
39
+ /** The `<fb>` cached number, for a formatted number. */
40
+ fb?: string;
41
+ }
42
+ /** One `<a>` of rdarray.xml. */
43
+ export interface RichArrayEntry {
44
+ rows: number;
45
+ columns: number;
46
+ items: readonly RichItemText[];
47
+ }
48
+ /** One `<spb>`: its bag structure's index and its `<v>`s. */
49
+ export interface RichBagEntry {
50
+ s: number;
51
+ values: readonly string[];
101
52
  }
102
53
  /**
103
54
  * Accumulates rich-value entries across all sheets.
@@ -107,12 +58,29 @@ export interface RichValueEntry {
107
58
  *
108
59
  * Stored in `sharedStates` under the key `"persistRichTypes"`.
109
60
  */
110
- export declare class RichValueCollector {
61
+ export declare class RichValueCollector implements RichValueSink {
111
62
  private readonly _metaCollector;
63
+ private readonly _workbook;
112
64
  private readonly _entries;
113
65
  private readonly _keyMap;
66
+ /** The writers started, by handler, in the order their structures are first written. */
67
+ private readonly _writers;
68
+ private readonly _structureIndex;
69
+ private readonly _structures;
70
+ private readonly _arrays;
71
+ private readonly _arrayKeys;
72
+ private readonly _bagStructures;
73
+ private readonly _bagStructureKeys;
74
+ private readonly _bags;
75
+ private readonly _bagKeys;
76
+ private readonly _bagArrays;
77
+ private readonly _bagArrayKeys;
78
+ private readonly _richStyles;
79
+ private readonly _richStyleKeys;
80
+ private readonly _keyFlags;
81
+ private readonly _records;
114
82
  private _onWarn;
115
- constructor(metaCollector: MetadataCollector, onWarn?: (message: string, value?: any) => void);
83
+ constructor(metaCollector: MetadataCollector, workbook: IWorkbook, onWarn?: (message: string, value?: any) => void);
116
84
  /**
117
85
  * Registers a cell value and returns the **1-based `vm=`** attribute value
118
86
  * to write on the `<c>` element — exactly like `persistStrings.add(text)`
@@ -122,37 +90,32 @@ export declare class RichValueCollector {
122
90
  * attrsCol.vm = '' + persistRichTypes.add(value);
123
91
  * ```
124
92
  *
125
- * Internally:
126
- * 1. Deduplicates the raw value → 0-based rdrichvalue.xml index (`rdRvIdx`)
127
- * 2. Deduplicates the futureMetadata XLRICHVALUE block (`rvFMBkIdx`)
128
- * 3. Appends a per-cell valueMetadata entry → 1-based `vm=`
129
- *
130
- * Dispatches on value type:
131
- * - `ScalarType.Error` with code > 7 → built-in `_error` handler
132
- * - Future: `ScalarType.RichData` → IRichType registry
93
+ * A value no handler writes is written as `#UNKNOWN!`.
133
94
  *
134
95
  * @param value The raw `Scalar` value from the cell iterator.
96
+ * @param formula The cell's formula text, or `null` for a literal: where a picture came from.
135
97
  * @returns 1-based `vm=` attribute value.
136
98
  */
137
- add(value: Scalar): number;
138
- /**
139
- * Registers (and deduplicates) a single `#UNKNOWN!` fallback rich-value entry.
140
- *
141
- * Used whenever a value cannot be serialized — produces valid OOXML and renders
142
- * as `#UNKNOWN!` in Excel rather than silently corrupting the `vm=` index.
143
- *
144
- * `#UNKNOWN!` is FormulaError code 12; OOXML `errorType` is `code - 1 = 11`.
145
- */
146
- private _registerFallback;
147
- /**
148
- * Low-level deduplicated entry registration.
149
- *
150
- * @param key Deduplication key (e.g. `"_error:9"`).
151
- * @param rawValue Forwarded to `handler.getValues()`.
152
- * @param handler Callback descriptor for this rich-value type.
153
- * @returns 0-based index into `rdrichvalue.xml`.
154
- */
155
- private _register;
99
+ add(value: Scalar, formula?: string | null): number;
100
+ /** {@inheritDoc RichValueSink.addHandled} */
101
+ addHandled(value: Scalar): number | null;
102
+ private _addHandled;
103
+ private _writerFor;
104
+ /** {@inheritDoc RichValueSink.structureFor} */
105
+ structureFor(t: string, keys: readonly RichStructureKey[]): RichValueStructureDef;
106
+ /** {@inheritDoc RichValueSink.addValue} */
107
+ addValue(structure: RichValueStructureDef, values: readonly string[], fb?: string): number;
108
+ /** {@inheritDoc RichValueSink.addArray} */
109
+ addArray(rows: number, columns: number, items: readonly RichItemText[]): number;
110
+ /** {@inheritDoc RichValueSink.addBag} */
111
+ addBag(keys: readonly RichStructureKey[], values: readonly string[]): number;
112
+ /** {@inheritDoc RichValueSink.addBagArray} */
113
+ addBagArray(items: readonly RichItemText[]): number;
114
+ /** {@inheritDoc RichValueSink.addRichStyle} */
115
+ addRichStyle(style: RichStyleDef): number;
116
+ /** {@inheritDoc RichValueSink.addKeyFlags} */
117
+ addKeyFlags(t: string, key: string, flags: readonly (readonly [name: string, value: string])[]): void;
118
+ private _intern;
156
119
  /** Number of registered (deduplicated) entries. */
157
120
  getCount(): number;
158
121
  /** Whether any entries have been registered. */
@@ -162,39 +125,28 @@ export declare class RichValueCollector {
162
125
  */
163
126
  getEntries(): readonly RichValueEntry[];
164
127
  /**
165
- * Returns the unique handler types in the order they are first encountered.
128
+ * The structures written, in the order they are first encountered.
166
129
  * Used by RichValueStructureEmitter to build `<rvStructures>`.
167
130
  */
168
- uniqueHandlers(): RichValueHandler[];
131
+ getStructures(): RichValueStructureDef[];
169
132
  /**
170
- * Returns the 0-based index of `handler` within the unique-handlers list
171
- * produced by {@link uniqueHandlers}. This is the `s=` attribute value on
133
+ * The 0-based index of `structure` within {@link getStructures}: the `s=` attribute value on
172
134
  * `<rv>` in `rdrichvalue.xml`.
173
135
  */
174
- handlerStructureIndex(handler: RichValueHandler): number;
136
+ getStructureIndex(structure: RichValueStructureDef): number;
137
+ /** The arrays written (rdarray.xml), in index order. */
138
+ getArrays(): readonly RichArrayEntry[];
139
+ /** The supporting property bag structures, bags and bag arrays written. */
140
+ getBags(): {
141
+ structures: readonly (readonly RichStructureKey[])[];
142
+ bags: readonly RichBagEntry[];
143
+ arrays: readonly (readonly RichItemText[])[];
144
+ };
145
+ /** The rich styles written, in index order (a bag names the first as 1). */
146
+ getRichStyles(): readonly RichStyleDef[];
147
+ /** The key flags each written structure declares in `rdRichValueTypes.xml`. */
148
+ getKeyFlags(): [structure: string, flags: readonly RichValueKeyFlags[]][];
149
+ /** Adds the parts the written structures need beyond the rich values. */
150
+ addParts(ctx: EmitContext): void;
175
151
  }
176
- /**
177
- // #PYTHON! contains a correlationId
178
- <s t="_error">
179
- <k n="correlationId" t="s"/>
180
- <k n="errorMessage" t="s"/>
181
- <k n="errorName" t="s"/>
182
- <k n="errorType" t="i"/>
183
- <k n="subType" t="i"/>
184
- </s>
185
-
186
-
187
- // #SPILL! contains row column offset
188
- <s t="_error">
189
- <k n="colOffset" t="i"/>
190
- <k n="errorType" t="i"/>
191
- <k n="rwOffset" t="i"/>
192
- <k n="subType" t="i"/>
193
- </s>
194
-
195
- // unknown has no subtype
196
- <s t="_error">
197
- <k n="errorType" t="i"/>
198
- </s>
199
- */
200
152
  //# sourceMappingURL=RichValueCollector.d.ts.map
@@ -0,0 +1,86 @@
1
+ import { IRange, ICellStyle, ITypes, IWorkbook, IWorksheet } from '@sheetxl/sdk';
2
+ import { XlsxHeader } from '../../XlsxHeader';
3
+ import { CellControlComplements } from './CellControlComplements';
4
+ export { type XlsxHeader };
5
+ /**
6
+ * A worksheet as the sheet part writes it: the model's JSON with whole-row and whole-column styles
7
+ * moved onto `rows`/`cols` and borders split so every cell of a range draws the same edges.
8
+ */
9
+ export interface XlsxWorksheetJSON extends Omit<IWorksheet.JSON, 'rows' | 'cols'> {
10
+ cols?: IRange.JSONReference<XlsxHeader>[];
11
+ rows?: IRange.JSONReference<XlsxHeader>[];
12
+ }
13
+ type StyledCells = [coords: IRange.Coords, styleId: number][];
14
+ /**
15
+ * Looks style JSON up by direct style id, and mints ids for new JSON.
16
+ *
17
+ * @remarks
18
+ * An id is an xf: a style plus the cell control complement it carries, if any (see
19
+ * `CellControlComplements`). The two stay apart; they meet only in the id.
20
+ */
21
+ export interface StyleIdScope {
22
+ getElementJSON(id: number): ICellStyle.JSON;
23
+ /** The control complement xf `id` carries, or `undefined`. */
24
+ getElementComplement?(id: number): number | undefined;
25
+ getElementID(json: ICellStyle.JSON, complement?: number): number | null;
26
+ }
27
+ /**
28
+ * Direct style ids keyed by the style's JSON, the same way the SDK's persist scope keys them
29
+ * (`JSONStableStringify`, Normal at 0), so a style keeps one xf however often it is minted. A style
30
+ * under a cell control is a second xf, keyed by the pair.
31
+ */
32
+ export declare class StyleIds implements StyleIdScope {
33
+ private _byKey;
34
+ readonly list: ICellStyle.JSON[];
35
+ /** The control complement each xf carries, by id; parallel to {@link list}. */
36
+ readonly complements: (number | undefined)[];
37
+ constructor(normal: ICellStyle.JSON | null | undefined);
38
+ getElementJSON(id: number): ICellStyle.JSON;
39
+ getElementComplement(id: number): number | undefined;
40
+ getElementID(json: ICellStyle.JSON | null | undefined, complement?: number): number;
41
+ }
42
+ /**
43
+ * Lays out every worksheet's styles the way xlsx stores them, re-minting the workbook's direct styles
44
+ * in the order the sheets cite them.
45
+ *
46
+ * @remarks
47
+ * Replaces `json.styles.direct`. Cell xf indices are direct style ids, so the list is minted sheet by
48
+ * sheet and range by range, with each split piece in its range's place and each re-derived border
49
+ * after.
50
+ *
51
+ * @returns The sheet part's JSON for each worksheet, keyed by the model's JSON for it.
52
+ */
53
+ export declare function layoutWorkbookStyles(json: IWorkbook.JSON, sheets: readonly (IWorksheet | null)[], complements?: CellControlComplements, warn?: (message: string, onceKey: string) => void): Map<IWorksheet.JSON, XlsxWorksheetJSON>;
54
+ /**
55
+ * Breaks a bordered range into pieces whose every cell draws the same edges, which is all a cell xf
56
+ * can say.
57
+ *
58
+ * @remarks
59
+ * A range that reaches the grid's terminal row or column (a `<col style>` reads back as a
60
+ * full-height range) has no closing border at the boundary, so no end sliver is split off there: a
61
+ * style-only piece at the last row or column materializes real `<c>` records, and Excel then treats
62
+ * the whole grid as the used range.
63
+ */
64
+ export declare function splitStyleBordersIntoSame(coords: IRange.Coords, json: ICellStyle.JSON, entireCoords?: IRange.Coords): IRange.JSONReferenceTuple<ICellStyle.JSON>[];
65
+ export interface StyleRanges {
66
+ cols: ITypes.RunCoordValue<XlsxHeader>[];
67
+ rows: ITypes.RunCoordValue<XlsxHeader>[];
68
+ cells: StyledCells;
69
+ }
70
+ /**
71
+ * Moves styles that cover most of a row or column onto `<row s>` / `<col style>`, leaving the cells
72
+ * only what the headers do not already say.
73
+ *
74
+ * @remarks
75
+ * 1. A style whose cells cover more than half of a column (or row) and reach the grid's edge
76
+ * becomes that column's (or row's) style. A style the columns already carry across most of the
77
+ * sheet is not repeated on rows.
78
+ * 2. An overlap sweep then finds what each crossing of cells and headers still has to write.
79
+ *
80
+ * A style's border is relative to the range it is stored with (a row or column style's range is the
81
+ * whole row or column), so ids are not position-independent: wherever a range is written smaller
82
+ * than the entry it came from, its id is re-derived from the style's JSON through `ids`, and two
83
+ * entries sharing an id agree on a crossing only if they draw the same edges there.
84
+ */
85
+ export declare function promoteStylesToHeaders(styles: StyleRanges, entireCoords: IRange.Coords, ids: StyleIdScope): StyleRanges;
86
+ //# sourceMappingURL=SheetStyleLayout.d.ts.map
@@ -1,4 +1,4 @@
1
- import { IStyleCollection, IText } from '@sheetxl/sdk';
1
+ import { IStyleCollection, IText, ITextFrame } from '@sheetxl/sdk';
2
2
  import { EmitContext } from '../builder';
3
3
  /**
4
4
  * The attributes of an `rPr`/`defRPr`/`endParaRPr` from run properties. Keys the chart style
@@ -22,6 +22,11 @@ export declare const writeParagraphProperties: (ctx: EmitContext, styles: IStyle
22
22
  * DrawingML's differs (overflow, a run's size) the default is stated, so the file means the same.
23
23
  */
24
24
  export declare const writeTxBody: (ctx: EmitContext, styles: IStyleCollection, jsonText: any) => void;
25
+ /**
26
+ * A text body's `bodyPr` and `lstStyle` without its paragraphs, as a theme's object default states
27
+ * them. Both are written, empty when there is no text.
28
+ */
29
+ export declare const writeBodyAndListStyle: (ctx: EmitContext, styles: IStyleCollection, text: ITextFrame.JSON | undefined) => void;
25
30
  export declare const writeDefaultRProperties: (ctx: EmitContext, styles: IStyleCollection, defRPr: Record<string, any>) => void;
26
31
  export declare const writeBodyProperties: (ctx: EmitContext, styles: IStyleCollection, bodyPr: Record<string, any> | undefined) => void;
27
32
  //# sourceMappingURL=TextUtils.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ISheet, IRange } from '@sheetxl/sdk';
1
+ import { IWorksheet, IRange } from '@sheetxl/sdk';
2
2
  /**
3
3
  * Which formulas on a sheet call a function Excel does not have.
4
4
  *
@@ -15,5 +15,5 @@ export interface UnsupportedFunctions {
15
15
  /** Whether formula `index` calls anything in {@link names}. */
16
16
  affects(index: number): boolean;
17
17
  }
18
- export declare const collectUnsupportedFunctions: (sheet: ISheet, jsonFormulas: IRange.JSONReferenceTuple<string>[] | undefined) => Promise<UnsupportedFunctions>;
18
+ export declare const collectUnsupportedFunctions: (sheet: IWorksheet, jsonFormulas: IRange.JSONReferenceTuple<string>[] | undefined) => Promise<UnsupportedFunctions>;
19
19
  //# sourceMappingURL=UnsupportedFunctions.d.ts.map
@@ -0,0 +1,61 @@
1
+ import { ICellStyle, IStyleCollection } from '@sheetxl/sdk';
2
+ export declare const XF_VARIANTS_SHARED_STATE = "xfVariants";
3
+ /**
4
+ * The cell xfs written as twins of a direct style, carrying what the model keeps somewhere other
5
+ * than the style:
6
+ *
7
+ * - `hidden="1"`, for sheets whose protection hides formulas. xlsx has no sheet-level form of
8
+ * `IWorksheetProtection.showFormulas: false`; Excel only hides a formula whose format says
9
+ * `hidden="1"`. So a sheet that hides formulas writes every format it uses as a hidden twin,
10
+ * unless the format itself grants `showFormulas`.
11
+ * - `pivotButton="1"`, for the cells a pivot table shows a field button on. The button is the
12
+ * table's (`IPivotTable.JSON.buttons`), not the format's.
13
+ * - what a pivot table's definition gives a cell (`IPivotTable.getStyleAt`): a row label set left
14
+ * and indented by its level, a data field's or a field's number format, and the formats a user
15
+ * put on the table (`IPivotTable.JSON.formats`). Excel reads them from the cell's format; the
16
+ * model derives them from the table's definition. The cell's own format wins where it sets them,
17
+ * as it does in the model.
18
+ *
19
+ * Twins are appended after the direct styles and shared by every sheet that asks for one.
20
+ * `cellXfs[0]` is never changed in place: it is workbook-wide, and each twin is per sheet or per
21
+ * cell.
22
+ *
23
+ * Worksheets allocate while they emit; `StylesEmitter` writes the twins afterwards.
24
+ */
25
+ export declare class XfVariants {
26
+ private _json;
27
+ private _styles;
28
+ /** The cellXfs written for the direct styles; the twins start here. */
29
+ private _directCount;
30
+ /** Twin by xf, flags, label indent, number format and user format. */
31
+ private _variants;
32
+ /** A user format's key, by the object a table answered with. */
33
+ private _userKeys;
34
+ private _sources;
35
+ private _shown;
36
+ constructor(json: IStyleCollection.JSON | undefined, styles: IStyleCollection);
37
+ /**
38
+ * The xf to write in place of `xf`.
39
+ *
40
+ * @param hidden The sheet hides formulas.
41
+ * @param pivotButton The cell shows a pivot table's field button.
42
+ * @param labelIndent The cell is a pivot table's row label, indented by this many characters.
43
+ * @param numberFormat The number format a pivot table gives the cell.
44
+ * @param user The style the formats a user put on a pivot table give the cell.
45
+ */
46
+ getXf(xf: number, hidden: boolean, pivotButton: boolean, labelIndent?: number | null, numberFormat?: string | null, user?: ICellStyle.Properties | null): number;
47
+ /** The direct xf behind each twin and its flags, in twin order. */
48
+ getSources(): readonly XfVariants.Source[];
49
+ private _isShown;
50
+ }
51
+ export declare namespace XfVariants {
52
+ interface Source {
53
+ xf: number;
54
+ hidden: boolean;
55
+ pivotButton: boolean;
56
+ labelIndent: number | null;
57
+ numberFormat: string | null;
58
+ user: ICellStyle.Properties | null;
59
+ }
60
+ }
61
+ //# sourceMappingURL=XfVariants.d.ts.map