docxmlater 10.1.4 → 10.1.6

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 (372) hide show
  1. package/README.md +759 -754
  2. package/dist/constants/legacyCompatFlags.js +1 -1
  3. package/dist/constants/legacyCompatFlags.js.map +1 -1
  4. package/dist/constants/limits.js.map +1 -1
  5. package/dist/core/Document.d.ts +51 -50
  6. package/dist/core/Document.d.ts.map +1 -1
  7. package/dist/core/Document.js +486 -471
  8. package/dist/core/Document.js.map +1 -1
  9. package/dist/core/DocumentContent.d.ts +9 -9
  10. package/dist/core/DocumentContent.d.ts.map +1 -1
  11. package/dist/core/DocumentContent.js +1 -1
  12. package/dist/core/DocumentContent.js.map +1 -1
  13. package/dist/core/DocumentGenerator.d.ts +11 -11
  14. package/dist/core/DocumentGenerator.d.ts.map +1 -1
  15. package/dist/core/DocumentGenerator.js +251 -251
  16. package/dist/core/DocumentGenerator.js.map +1 -1
  17. package/dist/core/DocumentIdManager.js.map +1 -1
  18. package/dist/core/DocumentParser.d.ts +15 -15
  19. package/dist/core/DocumentParser.d.ts.map +1 -1
  20. package/dist/core/DocumentParser.js +2123 -2155
  21. package/dist/core/DocumentParser.js.map +1 -1
  22. package/dist/core/DocumentValidator.d.ts.map +1 -1
  23. package/dist/core/DocumentValidator.js +2 -5
  24. package/dist/core/DocumentValidator.js.map +1 -1
  25. package/dist/core/Relationship.js.map +1 -1
  26. package/dist/core/RelationshipManager.d.ts.map +1 -1
  27. package/dist/core/RelationshipManager.js +3 -3
  28. package/dist/core/RelationshipManager.js.map +1 -1
  29. package/dist/elements/AlternateContent.js.map +1 -1
  30. package/dist/elements/Bookmark.d.ts.map +1 -1
  31. package/dist/elements/Bookmark.js +3 -1
  32. package/dist/elements/Bookmark.js.map +1 -1
  33. package/dist/elements/BookmarkManager.d.ts.map +1 -1
  34. package/dist/elements/BookmarkManager.js.map +1 -1
  35. package/dist/elements/Comment.d.ts.map +1 -1
  36. package/dist/elements/Comment.js +9 -6
  37. package/dist/elements/Comment.js.map +1 -1
  38. package/dist/elements/CommentManager.d.ts.map +1 -1
  39. package/dist/elements/CommentManager.js +18 -17
  40. package/dist/elements/CommentManager.js.map +1 -1
  41. package/dist/elements/CommonTypes.d.ts +21 -21
  42. package/dist/elements/CommonTypes.d.ts.map +1 -1
  43. package/dist/elements/CommonTypes.js +56 -56
  44. package/dist/elements/CommonTypes.js.map +1 -1
  45. package/dist/elements/CustomXml.js.map +1 -1
  46. package/dist/elements/Endnote.d.ts.map +1 -1
  47. package/dist/elements/Endnote.js +6 -6
  48. package/dist/elements/Endnote.js.map +1 -1
  49. package/dist/elements/EndnoteManager.d.ts.map +1 -1
  50. package/dist/elements/EndnoteManager.js +6 -7
  51. package/dist/elements/EndnoteManager.js.map +1 -1
  52. package/dist/elements/Field.d.ts.map +1 -1
  53. package/dist/elements/Field.js +82 -25
  54. package/dist/elements/Field.js.map +1 -1
  55. package/dist/elements/FieldHelpers.d.ts.map +1 -1
  56. package/dist/elements/FieldHelpers.js.map +1 -1
  57. package/dist/elements/FontManager.d.ts.map +1 -1
  58. package/dist/elements/FontManager.js +1 -1
  59. package/dist/elements/FontManager.js.map +1 -1
  60. package/dist/elements/Footer.js +2 -2
  61. package/dist/elements/Footer.js.map +1 -1
  62. package/dist/elements/Footnote.d.ts.map +1 -1
  63. package/dist/elements/Footnote.js +6 -6
  64. package/dist/elements/Footnote.js.map +1 -1
  65. package/dist/elements/FootnoteManager.d.ts.map +1 -1
  66. package/dist/elements/FootnoteManager.js +6 -7
  67. package/dist/elements/FootnoteManager.js.map +1 -1
  68. package/dist/elements/Header.js +2 -2
  69. package/dist/elements/Header.js.map +1 -1
  70. package/dist/elements/HeaderFooterManager.js.map +1 -1
  71. package/dist/elements/Hyperlink.d.ts +5 -3
  72. package/dist/elements/Hyperlink.d.ts.map +1 -1
  73. package/dist/elements/Hyperlink.js +134 -76
  74. package/dist/elements/Hyperlink.js.map +1 -1
  75. package/dist/elements/Image.d.ts.map +1 -1
  76. package/dist/elements/Image.js +238 -106
  77. package/dist/elements/Image.js.map +1 -1
  78. package/dist/elements/ImageManager.d.ts.map +1 -1
  79. package/dist/elements/ImageManager.js +1 -1
  80. package/dist/elements/ImageManager.js.map +1 -1
  81. package/dist/elements/ImageRun.js +1 -1
  82. package/dist/elements/ImageRun.js.map +1 -1
  83. package/dist/elements/MathElement.js.map +1 -1
  84. package/dist/elements/Paragraph.d.ts +24 -24
  85. package/dist/elements/Paragraph.d.ts.map +1 -1
  86. package/dist/elements/Paragraph.js +181 -188
  87. package/dist/elements/Paragraph.js.map +1 -1
  88. package/dist/elements/PreservedElement.js.map +1 -1
  89. package/dist/elements/PropertyChangeTypes.d.ts.map +1 -1
  90. package/dist/elements/PropertyChangeTypes.js +6 -6
  91. package/dist/elements/PropertyChangeTypes.js.map +1 -1
  92. package/dist/elements/RangeMarker.d.ts.map +1 -1
  93. package/dist/elements/RangeMarker.js.map +1 -1
  94. package/dist/elements/Revision.d.ts.map +1 -1
  95. package/dist/elements/Revision.js +4 -5
  96. package/dist/elements/Revision.js.map +1 -1
  97. package/dist/elements/RevisionContent.js.map +1 -1
  98. package/dist/elements/RevisionManager.d.ts.map +1 -1
  99. package/dist/elements/RevisionManager.js +40 -48
  100. package/dist/elements/RevisionManager.js.map +1 -1
  101. package/dist/elements/Run.d.ts +16 -16
  102. package/dist/elements/Run.d.ts.map +1 -1
  103. package/dist/elements/Run.js +256 -238
  104. package/dist/elements/Run.js.map +1 -1
  105. package/dist/elements/Section.d.ts.map +1 -1
  106. package/dist/elements/Section.js +36 -11
  107. package/dist/elements/Section.js.map +1 -1
  108. package/dist/elements/Shape.d.ts.map +1 -1
  109. package/dist/elements/Shape.js.map +1 -1
  110. package/dist/elements/StructuredDocumentTag.d.ts +6 -6
  111. package/dist/elements/StructuredDocumentTag.d.ts.map +1 -1
  112. package/dist/elements/StructuredDocumentTag.js +99 -104
  113. package/dist/elements/StructuredDocumentTag.js.map +1 -1
  114. package/dist/elements/Table.d.ts +11 -11
  115. package/dist/elements/Table.d.ts.map +1 -1
  116. package/dist/elements/Table.js +102 -107
  117. package/dist/elements/Table.js.map +1 -1
  118. package/dist/elements/TableCell.d.ts +10 -10
  119. package/dist/elements/TableCell.d.ts.map +1 -1
  120. package/dist/elements/TableCell.js +105 -106
  121. package/dist/elements/TableCell.js.map +1 -1
  122. package/dist/elements/TableGridChange.d.ts.map +1 -1
  123. package/dist/elements/TableGridChange.js.map +1 -1
  124. package/dist/elements/TableOfContents.d.ts.map +1 -1
  125. package/dist/elements/TableOfContents.js +4 -4
  126. package/dist/elements/TableOfContents.js.map +1 -1
  127. package/dist/elements/TableOfContentsElement.js.map +1 -1
  128. package/dist/elements/TableRow.d.ts.map +1 -1
  129. package/dist/elements/TableRow.js +13 -6
  130. package/dist/elements/TableRow.js.map +1 -1
  131. package/dist/elements/TextBox.d.ts.map +1 -1
  132. package/dist/elements/TextBox.js +3 -5
  133. package/dist/elements/TextBox.js.map +1 -1
  134. package/dist/formatting/AbstractNumbering.d.ts +4 -4
  135. package/dist/formatting/AbstractNumbering.d.ts.map +1 -1
  136. package/dist/formatting/AbstractNumbering.js +54 -49
  137. package/dist/formatting/AbstractNumbering.js.map +1 -1
  138. package/dist/formatting/NumberingInstance.d.ts.map +1 -1
  139. package/dist/formatting/NumberingInstance.js +1 -3
  140. package/dist/formatting/NumberingInstance.js.map +1 -1
  141. package/dist/formatting/NumberingLevel.d.ts +5 -5
  142. package/dist/formatting/NumberingLevel.d.ts.map +1 -1
  143. package/dist/formatting/NumberingLevel.js +119 -125
  144. package/dist/formatting/NumberingLevel.js.map +1 -1
  145. package/dist/formatting/NumberingManager.d.ts +1 -0
  146. package/dist/formatting/NumberingManager.d.ts.map +1 -1
  147. package/dist/formatting/NumberingManager.js +27 -9
  148. package/dist/formatting/NumberingManager.js.map +1 -1
  149. package/dist/formatting/Style.d.ts +11 -11
  150. package/dist/formatting/Style.d.ts.map +1 -1
  151. package/dist/formatting/Style.js +219 -247
  152. package/dist/formatting/Style.js.map +1 -1
  153. package/dist/formatting/StylesManager.d.ts +2 -2
  154. package/dist/formatting/StylesManager.d.ts.map +1 -1
  155. package/dist/formatting/StylesManager.js +96 -102
  156. package/dist/formatting/StylesManager.js.map +1 -1
  157. package/dist/helpers/CleanupHelper.d.ts +1 -1
  158. package/dist/helpers/CleanupHelper.d.ts.map +1 -1
  159. package/dist/helpers/CleanupHelper.js +6 -6
  160. package/dist/helpers/CleanupHelper.js.map +1 -1
  161. package/dist/images/ImageOptimizer.js +7 -7
  162. package/dist/images/ImageOptimizer.js.map +1 -1
  163. package/dist/index.d.ts +9 -9
  164. package/dist/index.d.ts.map +1 -1
  165. package/dist/index.js.map +1 -1
  166. package/dist/managers/DrawingManager.js.map +1 -1
  167. package/dist/tracking/DocumentTrackingContext.d.ts.map +1 -1
  168. package/dist/tracking/DocumentTrackingContext.js +23 -7
  169. package/dist/tracking/DocumentTrackingContext.js.map +1 -1
  170. package/dist/tracking/TrackingContext.d.ts.map +1 -1
  171. package/dist/tracking/TrackingContext.js.map +1 -1
  172. package/dist/types/compatibility-types.js.map +1 -1
  173. package/dist/types/formatting.js.map +1 -1
  174. package/dist/types/list-types.d.ts +6 -6
  175. package/dist/types/list-types.js.map +1 -1
  176. package/dist/types/settings-types.js.map +1 -1
  177. package/dist/types/styleConfig.d.ts +2 -2
  178. package/dist/types/styleConfig.js.map +1 -1
  179. package/dist/utils/ChangelogGenerator.d.ts.map +1 -1
  180. package/dist/utils/ChangelogGenerator.js +97 -101
  181. package/dist/utils/ChangelogGenerator.js.map +1 -1
  182. package/dist/utils/CompatibilityUpgrader.d.ts.map +1 -1
  183. package/dist/utils/CompatibilityUpgrader.js +1 -1
  184. package/dist/utils/CompatibilityUpgrader.js.map +1 -1
  185. package/dist/utils/InMemoryRevisionAcceptor.d.ts.map +1 -1
  186. package/dist/utils/InMemoryRevisionAcceptor.js +1 -6
  187. package/dist/utils/InMemoryRevisionAcceptor.js.map +1 -1
  188. package/dist/utils/MoveOperationHelper.d.ts.map +1 -1
  189. package/dist/utils/MoveOperationHelper.js +1 -1
  190. package/dist/utils/MoveOperationHelper.js.map +1 -1
  191. package/dist/utils/RevisionAwareProcessor.d.ts.map +1 -1
  192. package/dist/utils/RevisionAwareProcessor.js +2 -4
  193. package/dist/utils/RevisionAwareProcessor.js.map +1 -1
  194. package/dist/utils/RevisionWalker.d.ts.map +1 -1
  195. package/dist/utils/RevisionWalker.js +4 -12
  196. package/dist/utils/RevisionWalker.js.map +1 -1
  197. package/dist/utils/SelectiveRevisionAcceptor.d.ts.map +1 -1
  198. package/dist/utils/SelectiveRevisionAcceptor.js +2 -6
  199. package/dist/utils/SelectiveRevisionAcceptor.js.map +1 -1
  200. package/dist/utils/ShadingResolver.d.ts.map +1 -1
  201. package/dist/utils/ShadingResolver.js +1 -1
  202. package/dist/utils/ShadingResolver.js.map +1 -1
  203. package/dist/utils/acceptRevisions.d.ts.map +1 -1
  204. package/dist/utils/acceptRevisions.js +23 -12
  205. package/dist/utils/acceptRevisions.js.map +1 -1
  206. package/dist/utils/cnfStyleDecoder.d.ts +1 -1
  207. package/dist/utils/cnfStyleDecoder.d.ts.map +1 -1
  208. package/dist/utils/cnfStyleDecoder.js +40 -40
  209. package/dist/utils/cnfStyleDecoder.js.map +1 -1
  210. package/dist/utils/corruptionDetection.d.ts.map +1 -1
  211. package/dist/utils/corruptionDetection.js.map +1 -1
  212. package/dist/utils/dateFormatting.js.map +1 -1
  213. package/dist/utils/deepClone.js +1 -1
  214. package/dist/utils/deepClone.js.map +1 -1
  215. package/dist/utils/diagnostics.d.ts.map +1 -1
  216. package/dist/utils/diagnostics.js +1 -1
  217. package/dist/utils/diagnostics.js.map +1 -1
  218. package/dist/utils/errorHandling.js.map +1 -1
  219. package/dist/utils/formatting.d.ts.map +1 -1
  220. package/dist/utils/formatting.js +10 -2
  221. package/dist/utils/formatting.js.map +1 -1
  222. package/dist/utils/list-detection.d.ts +2 -2
  223. package/dist/utils/list-detection.d.ts.map +1 -1
  224. package/dist/utils/list-detection.js +21 -23
  225. package/dist/utils/list-detection.js.map +1 -1
  226. package/dist/utils/logger.d.ts.map +1 -1
  227. package/dist/utils/logger.js +12 -7
  228. package/dist/utils/logger.js.map +1 -1
  229. package/dist/utils/parsingHelpers.js.map +1 -1
  230. package/dist/utils/stripTrackedChanges.d.ts.map +1 -1
  231. package/dist/utils/stripTrackedChanges.js +3 -3
  232. package/dist/utils/stripTrackedChanges.js.map +1 -1
  233. package/dist/utils/textDiff.d.ts +1 -1
  234. package/dist/utils/textDiff.js +8 -8
  235. package/dist/utils/textDiff.js.map +1 -1
  236. package/dist/utils/units.js.map +1 -1
  237. package/dist/utils/validation.d.ts.map +1 -1
  238. package/dist/utils/validation.js +24 -7
  239. package/dist/utils/validation.js.map +1 -1
  240. package/dist/utils/xmlSanitization.d.ts.map +1 -1
  241. package/dist/utils/xmlSanitization.js +3 -3
  242. package/dist/utils/xmlSanitization.js.map +1 -1
  243. package/dist/validation/RevisionAutoFixer.d.ts.map +1 -1
  244. package/dist/validation/RevisionAutoFixer.js +5 -5
  245. package/dist/validation/RevisionAutoFixer.js.map +1 -1
  246. package/dist/validation/RevisionValidator.d.ts.map +1 -1
  247. package/dist/validation/RevisionValidator.js +7 -9
  248. package/dist/validation/RevisionValidator.js.map +1 -1
  249. package/dist/validation/ValidationRules.js +3 -3
  250. package/dist/validation/ValidationRules.js.map +1 -1
  251. package/dist/validation/index.js.map +1 -1
  252. package/dist/xml/XMLBuilder.d.ts +1 -1
  253. package/dist/xml/XMLBuilder.d.ts.map +1 -1
  254. package/dist/xml/XMLBuilder.js +98 -100
  255. package/dist/xml/XMLBuilder.js.map +1 -1
  256. package/dist/xml/XMLParser.d.ts.map +1 -1
  257. package/dist/xml/XMLParser.js +61 -66
  258. package/dist/xml/XMLParser.js.map +1 -1
  259. package/dist/zip/ZipHandler.d.ts.map +1 -1
  260. package/dist/zip/ZipHandler.js.map +1 -1
  261. package/dist/zip/ZipReader.d.ts.map +1 -1
  262. package/dist/zip/ZipReader.js +1 -3
  263. package/dist/zip/ZipReader.js.map +1 -1
  264. package/dist/zip/ZipWriter.d.ts +1 -1
  265. package/dist/zip/ZipWriter.d.ts.map +1 -1
  266. package/dist/zip/ZipWriter.js +28 -36
  267. package/dist/zip/ZipWriter.js.map +1 -1
  268. package/dist/zip/types.js +1 -1
  269. package/dist/zip/types.js.map +1 -1
  270. package/package.json +92 -92
  271. package/src/__tests__/helper-methods.test.ts +512 -512
  272. package/src/constants/legacyCompatFlags.ts +138 -138
  273. package/src/constants/limits.ts +50 -50
  274. package/src/core/Document.ts +1010 -1145
  275. package/src/core/DocumentContent.ts +461 -467
  276. package/src/core/DocumentGenerator.ts +1133 -1104
  277. package/src/core/DocumentIdManager.ts +158 -158
  278. package/src/core/DocumentParser.ts +2347 -2716
  279. package/src/core/DocumentValidator.ts +363 -372
  280. package/src/core/Relationship.ts +367 -367
  281. package/src/core/RelationshipManager.ts +429 -428
  282. package/src/elements/AlternateContent.ts +42 -42
  283. package/src/elements/Bookmark.ts +212 -210
  284. package/src/elements/BookmarkManager.ts +247 -250
  285. package/src/elements/Comment.ts +356 -359
  286. package/src/elements/CommentManager.ts +499 -502
  287. package/src/elements/CommonTypes.ts +524 -549
  288. package/src/elements/CustomXml.ts +36 -36
  289. package/src/elements/Endnote.ts +221 -217
  290. package/src/elements/EndnoteManager.ts +246 -249
  291. package/src/elements/Field.ts +1292 -1233
  292. package/src/elements/FieldHelpers.ts +329 -333
  293. package/src/elements/FontManager.ts +336 -339
  294. package/src/elements/Footer.ts +269 -269
  295. package/src/elements/Footnote.ts +221 -217
  296. package/src/elements/FootnoteManager.ts +246 -249
  297. package/src/elements/Header.ts +269 -269
  298. package/src/elements/HeaderFooterManager.ts +219 -219
  299. package/src/elements/Hyperlink.ts +1288 -1193
  300. package/src/elements/Image.ts +1982 -1756
  301. package/src/elements/ImageManager.ts +437 -432
  302. package/src/elements/ImageRun.ts +59 -59
  303. package/src/elements/MathElement.ts +65 -65
  304. package/src/elements/Paragraph.ts +4347 -4287
  305. package/src/elements/PreservedElement.ts +53 -53
  306. package/src/elements/PropertyChangeTypes.ts +458 -442
  307. package/src/elements/RangeMarker.ts +382 -400
  308. package/src/elements/Revision.ts +1198 -1217
  309. package/src/elements/RevisionContent.ts +73 -73
  310. package/src/elements/RevisionManager.ts +1070 -1070
  311. package/src/elements/Run.ts +3103 -3073
  312. package/src/elements/Section.ts +1521 -1421
  313. package/src/elements/Shape.ts +884 -873
  314. package/src/elements/StructuredDocumentTag.ts +1176 -1207
  315. package/src/elements/Table.ts +2468 -2524
  316. package/src/elements/TableCell.ts +1617 -1621
  317. package/src/elements/TableGridChange.ts +149 -151
  318. package/src/elements/TableOfContents.ts +701 -691
  319. package/src/elements/TableOfContentsElement.ts +89 -89
  320. package/src/elements/TableRow.ts +960 -929
  321. package/src/elements/TextBox.ts +766 -768
  322. package/src/formatting/AbstractNumbering.ts +580 -579
  323. package/src/formatting/NumberingInstance.ts +295 -299
  324. package/src/formatting/NumberingLevel.ts +981 -1040
  325. package/src/formatting/NumberingManager.ts +875 -827
  326. package/src/formatting/Style.ts +1785 -1879
  327. package/src/formatting/StylesManager.ts +1090 -1130
  328. package/src/helpers/CleanupHelper.ts +524 -524
  329. package/src/images/ImageOptimizer.ts +274 -274
  330. package/src/index.ts +559 -554
  331. package/src/managers/DrawingManager.ts +319 -319
  332. package/src/tracking/DocumentTrackingContext.ts +687 -674
  333. package/src/tracking/TrackingContext.ts +175 -173
  334. package/src/types/compatibility-types.ts +49 -49
  335. package/src/types/formatting.ts +210 -210
  336. package/src/types/list-types.ts +14 -14
  337. package/src/types/settings-types.ts +59 -59
  338. package/src/types/styleConfig.ts +189 -189
  339. package/src/utils/ChangelogGenerator.ts +1583 -1581
  340. package/src/utils/CompatibilityUpgrader.ts +235 -237
  341. package/src/utils/InMemoryRevisionAcceptor.ts +691 -696
  342. package/src/utils/MoveOperationHelper.ts +233 -238
  343. package/src/utils/RevisionAwareProcessor.ts +518 -526
  344. package/src/utils/RevisionWalker.ts +427 -457
  345. package/src/utils/SelectiveRevisionAcceptor.ts +662 -683
  346. package/src/utils/ShadingResolver.ts +105 -107
  347. package/src/utils/acceptRevisions.ts +723 -714
  348. package/src/utils/cnfStyleDecoder.ts +212 -217
  349. package/src/utils/corruptionDetection.ts +346 -345
  350. package/src/utils/dateFormatting.ts +20 -20
  351. package/src/utils/deepClone.ts +77 -78
  352. package/src/utils/diagnostics.ts +125 -129
  353. package/src/utils/errorHandling.ts +80 -80
  354. package/src/utils/formatting.ts +220 -213
  355. package/src/utils/list-detection.ts +32 -42
  356. package/src/utils/logger.ts +412 -404
  357. package/src/utils/parsingHelpers.ts +190 -190
  358. package/src/utils/stripTrackedChanges.ts +356 -353
  359. package/src/utils/textDiff.ts +100 -100
  360. package/src/utils/units.ts +421 -421
  361. package/src/utils/validation.ts +553 -542
  362. package/src/utils/xmlSanitization.ts +179 -182
  363. package/src/validation/RevisionAutoFixer.ts +541 -542
  364. package/src/validation/RevisionValidator.ts +470 -460
  365. package/src/validation/ValidationRules.ts +338 -338
  366. package/src/validation/index.ts +30 -30
  367. package/src/xml/XMLBuilder.ts +857 -871
  368. package/src/xml/XMLParser.ts +877 -919
  369. package/src/zip/ZipHandler.ts +629 -637
  370. package/src/zip/ZipReader.ts +295 -299
  371. package/src/zip/ZipWriter.ts +374 -390
  372. package/src/zip/types.ts +116 -116
@@ -1,579 +1,580 @@
1
- /**
2
- * AbstractNumbering - Defines a multi-level numbering scheme
3
- *
4
- * An abstract numbering definition is a template that defines up to 9 levels of
5
- * list formatting. It's referenced by numbering instances which link it to actual
6
- * paragraphs in the document.
7
- */
8
-
9
- import { XMLBuilder, XMLElement } from "../xml/XMLBuilder";
10
- import { NumberingLevel } from "./NumberingLevel";
11
- import { defaultLogger } from "../utils/logger";
12
-
13
- /**
14
- * Properties for creating an abstract numbering definition
15
- */
16
- export interface AbstractNumberingProperties {
17
- /** Unique identifier for this abstract numbering */
18
- abstractNumId: number;
19
-
20
- /** Optional name for the numbering scheme */
21
- name?: string;
22
-
23
- /** The numbering levels (up to 9 levels, 0-8) */
24
- levels?: NumberingLevel[];
25
-
26
- /** Optional multiLevel type (0 = single level, 1 = multilevel) */
27
- multiLevelType?: number;
28
-
29
- /** Optional link to a numbering style definition (ECMA-376 §17.9.21) */
30
- numStyleLink?: string;
31
-
32
- /** Optional link to a style that uses this abstract numbering (ECMA-376 §17.9.27) */
33
- styleLink?: string;
34
-
35
- /** Template code (ECMA-376 §17.9.30) - 8-char hex string identifying the template */
36
- tmpl?: string;
37
- }
38
-
39
- /**
40
- * Represents an abstract numbering definition
41
- *
42
- * Abstract numbering defines the template for a multi-level list. Each instance
43
- * of a list in the document references an abstract numbering definition.
44
- */
45
- export class AbstractNumbering {
46
- private abstractNumId: number;
47
- private name?: string;
48
- private levels: Map<number, NumberingLevel>;
49
- private multiLevelType: number;
50
- private numStyleLink?: string;
51
- private styleLink?: string;
52
- private tmpl?: string;
53
-
54
- /**
55
- * Creates a new abstract numbering definition
56
- * @param idOrProps The abstract numbering ID (number) or properties object
57
- * @param name Optional name (if first param is a number)
58
- */
59
- constructor(idOrProps: number | AbstractNumberingProperties, name?: string) {
60
- // Support both simple (numId) and object constructor patterns
61
- if (typeof idOrProps === "number") {
62
- // Simple constructor: new AbstractNumbering(id)
63
- this.abstractNumId = idOrProps;
64
- this.name = name;
65
- this.levels = new Map();
66
- this.multiLevelType = 1; // default multilevel
67
- } else {
68
- // Object constructor: new AbstractNumbering({ abstractNumId, ... })
69
- const properties = idOrProps;
70
- this.abstractNumId = properties.abstractNumId;
71
- this.name = properties.name;
72
- this.levels = new Map();
73
- this.multiLevelType =
74
- properties.multiLevelType !== undefined ? properties.multiLevelType : 1;
75
- this.numStyleLink = properties.numStyleLink;
76
- this.styleLink = properties.styleLink;
77
- this.tmpl = properties.tmpl;
78
-
79
- if (properties.levels) {
80
- properties.levels.forEach((level) => {
81
- this.addLevel(level);
82
- });
83
- }
84
- }
85
-
86
- this.validate();
87
- }
88
-
89
- /**
90
- * Validates the abstract numbering
91
- */
92
- private validate(): void {
93
- if (this.abstractNumId < 0) {
94
- throw new Error("Abstract numbering ID must be non-negative");
95
- }
96
-
97
- if (this.levels.size > 9) {
98
- throw new Error("Cannot have more than 9 levels (0-8)");
99
- }
100
- }
101
-
102
- /**
103
- * Gets the abstract numbering ID
104
- */
105
- getAbstractNumId(): number {
106
- return this.abstractNumId;
107
- }
108
-
109
- /**
110
- * Alias for getAbstractNumId for backward compatibility
111
- */
112
- getId(): number {
113
- return this.abstractNumId;
114
- }
115
-
116
- /**
117
- * Gets the name
118
- */
119
- getName(): string | undefined {
120
- return this.name;
121
- }
122
-
123
- /**
124
- * Sets the name
125
- * @param name The numbering scheme name
126
- */
127
- setName(name: string): this {
128
- this.name = name;
129
- return this;
130
- }
131
-
132
- /**
133
- * Gets the multi-level type
134
- */
135
- getMultiLevelType(): string {
136
- if (this.multiLevelType === 1) {
137
- return "multilevel";
138
- } else if (this.multiLevelType === 2) {
139
- return "hybridMultilevel";
140
- } else {
141
- return "singleLevel";
142
- }
143
- }
144
-
145
- /**
146
- * Sets the multi-level type
147
- * @param type The multi-level type ('multilevel' or 'singleLevel')
148
- */
149
- setMultiLevelType(
150
- type: "multilevel" | "singleLevel" | "hybridMultilevel"
151
- ): this {
152
- if (type === "multilevel") {
153
- this.multiLevelType = 1;
154
- } else if (type === "hybridMultilevel") {
155
- this.multiLevelType = 2;
156
- } else {
157
- this.multiLevelType = 0;
158
- }
159
- return this;
160
- }
161
-
162
- /**
163
- * Gets the numStyleLink (reference to a numbering style definition)
164
- */
165
- getNumStyleLink(): string | undefined {
166
- return this.numStyleLink;
167
- }
168
-
169
- /**
170
- * Sets the numStyleLink
171
- * @param link The numbering style name
172
- */
173
- setNumStyleLink(link: string | undefined): this {
174
- this.numStyleLink = link;
175
- return this;
176
- }
177
-
178
- /**
179
- * Gets the styleLink (reference to a style that uses this abstract numbering)
180
- */
181
- getStyleLink(): string | undefined {
182
- return this.styleLink;
183
- }
184
-
185
- /**
186
- * Sets the styleLink
187
- * @param link The style name
188
- */
189
- setStyleLink(link: string | undefined): this {
190
- this.styleLink = link;
191
- return this;
192
- }
193
-
194
- /**
195
- * Gets the template code (w:tmpl per ECMA-376 §17.9.30)
196
- */
197
- getTemplate(): string | undefined {
198
- return this.tmpl;
199
- }
200
-
201
- /**
202
- * Sets the template code
203
- * @param tmpl 8-char hex string identifying the template
204
- */
205
- setTemplate(tmpl: string): this {
206
- this.tmpl = tmpl;
207
- return this;
208
- }
209
-
210
- /**
211
- * Adds a numbering level
212
- * @param level The numbering level to add
213
- */
214
- addLevel(level: NumberingLevel): this {
215
- const levelIndex = level.getLevel();
216
-
217
- if (levelIndex < 0 || levelIndex > 8) {
218
- throw new Error(`Level must be between 0 and 8, got ${levelIndex}`);
219
- }
220
-
221
- this.levels.set(levelIndex, level);
222
- return this;
223
- }
224
-
225
- /**
226
- * Adds multiple numbering levels at once
227
- * @param levels The numbering levels to add
228
- */
229
- addLevels(levels: NumberingLevel[]): this {
230
- levels.forEach((level) => this.addLevel(level));
231
- return this;
232
- }
233
-
234
- /**
235
- * Gets a numbering level by index
236
- * @param levelIndex The level index (0-8)
237
- */
238
- getLevel(levelIndex: number): NumberingLevel | undefined {
239
- return this.levels.get(levelIndex);
240
- }
241
-
242
- /**
243
- * Gets all levels
244
- */
245
- getAllLevels(): NumberingLevel[] {
246
- return Array.from(this.levels.values()).sort(
247
- (a, b) => a.getLevel() - b.getLevel()
248
- );
249
- }
250
-
251
- /**
252
- * Alias for getAllLevels for backward compatibility
253
- */
254
- getLevels(): NumberingLevel[] {
255
- return this.getAllLevels();
256
- }
257
-
258
- /**
259
- * Gets the number of levels defined
260
- */
261
- getLevelCount(): number {
262
- return this.levels.size;
263
- }
264
-
265
- /**
266
- * Checks if a level exists
267
- * @param levelIndex The level index (0-8)
268
- */
269
- hasLevel(levelIndex: number): boolean {
270
- return this.levels.has(levelIndex);
271
- }
272
-
273
- /**
274
- * Removes a level
275
- * @param levelIndex The level index (0-8)
276
- */
277
- removeLevel(levelIndex: number): boolean {
278
- return this.levels.delete(levelIndex);
279
- }
280
-
281
- /**
282
- * Generates the WordprocessingML XML for this abstract numbering
283
- */
284
- toXML(): XMLElement {
285
- const children: XMLElement[] = [];
286
-
287
- // CT_AbstractNum order per ECMA-376: nsid → multiLevelType → tmpl → name → styleLink → numStyleLink → lvl*
288
-
289
- // Add multiLevelType
290
- let multiLevelTypeValue: string;
291
- if (this.multiLevelType === 1) {
292
- multiLevelTypeValue = "multilevel";
293
- } else if (this.multiLevelType === 2) {
294
- multiLevelTypeValue = "hybridMultilevel";
295
- } else {
296
- multiLevelTypeValue = "singleLevel";
297
- }
298
-
299
- children.push(
300
- XMLBuilder.wSelf("multiLevelType", {
301
- "w:val": multiLevelTypeValue,
302
- })
303
- );
304
-
305
- // Add template code (position 3 per CT_AbstractNum)
306
- if (this.tmpl) {
307
- children.push(XMLBuilder.wSelf("tmpl", { "w:val": this.tmpl }));
308
- }
309
-
310
- // Add name if present
311
- if (this.name) {
312
- children.push(XMLBuilder.wSelf("name", { "w:val": this.name }));
313
- }
314
-
315
- // Add styleLink / numStyleLink if present
316
- if (this.styleLink) {
317
- children.push(XMLBuilder.wSelf("styleLink", { "w:val": this.styleLink }));
318
- }
319
- if (this.numStyleLink) {
320
- children.push(XMLBuilder.wSelf("numStyleLink", { "w:val": this.numStyleLink }));
321
- }
322
-
323
- // Add all levels in order
324
- const sortedLevels = this.getAllLevels();
325
- sortedLevels.forEach((level) => {
326
- children.push(level.toXML());
327
- });
328
-
329
- // If no levels defined, add a default level 0
330
- if (sortedLevels.length === 0) {
331
- children.push(NumberingLevel.createDecimalLevel(0).toXML());
332
- }
333
-
334
- return XMLBuilder.w(
335
- "abstractNum",
336
- { "w:abstractNumId": this.abstractNumId.toString() },
337
- children
338
- );
339
- }
340
-
341
- /**
342
- * Creates a bullet list abstract numbering with specified levels
343
- *
344
- * Uses Calibri font for better UI compatibility. For advanced bullet symbol selection,
345
- * use NumberingLevel.getBulletSymbolWithFont() to get recommended symbol/font pairs.
346
- *
347
- * @param abstractNumId The abstract numbering ID
348
- * @param levels Number of levels (default: 9)
349
- * @param bullets Array of bullet characters (default: ['•', '○', '▪'])
350
- *
351
- * @example
352
- * // Standard bullet list
353
- * const bulletList = AbstractNumbering.createBulletList(1);
354
- *
355
- * @example
356
- * // Custom bullets using helper method
357
- * const bullets = [];
358
- * for (let i = 0; i < 9; i++) {
359
- * const { symbol } = NumberingLevel.getBulletSymbolWithFont(i, 'square');
360
- * bullets.push(symbol);
361
- * }
362
- * const squareList = AbstractNumbering.createBulletList(2, 9, bullets);
363
- */
364
- static createBulletList(
365
- abstractNumId: number,
366
- levels = 9,
367
- bullets?: string[] // Optional: custom bullets. If not provided, uses Word-native encoding
368
- ): AbstractNumbering {
369
- const abstractNum = new AbstractNumbering({
370
- abstractNumId,
371
- name: "Bullet List",
372
- multiLevelType: 1,
373
- });
374
-
375
- for (let i = 0; i < levels && i < 9; i++) {
376
- if (bullets && bullets.length > 0) {
377
- // Custom bullets provided - use them with default font
378
- const bullet = bullets[i % bullets.length] || "•";
379
- abstractNum.addLevel(NumberingLevel.createBulletLevel(i, bullet));
380
- } else {
381
- // No custom bullets - use Word-native encoding (correct font per level)
382
- abstractNum.addLevel(NumberingLevel.createBulletLevel(i));
383
- }
384
- }
385
-
386
- return abstractNum;
387
- }
388
-
389
- /**
390
- * Creates a numbered list abstract numbering with specified levels
391
- * @param abstractNumId The abstract numbering ID
392
- * @param levels Number of levels (default: 9)
393
- * @param formats Array of formats for each level
394
- */
395
- static createNumberedList(
396
- abstractNumId: number,
397
- levels = 9,
398
- formats: ("decimal" | "lowerLetter" | "lowerRoman" | "upperLetter" | "upperRoman")[] = ["decimal", "lowerLetter", "lowerRoman", "upperLetter", "upperRoman"]
399
- ): AbstractNumbering {
400
- const abstractNum = new AbstractNumbering({
401
- abstractNumId,
402
- name: "Numbered List",
403
- multiLevelType: 1,
404
- });
405
-
406
- for (let i = 0; i < levels && i < 9; i++) {
407
- const format = formats[i % formats.length] || "decimal";
408
- const template = `%${i + 1}.`;
409
-
410
- let level: NumberingLevel;
411
- switch (format) {
412
- case "lowerLetter":
413
- level = NumberingLevel.createLowerLetterLevel(i, template);
414
- break;
415
- case "lowerRoman":
416
- level = NumberingLevel.createLowerRomanLevel(i, template);
417
- break;
418
- case "upperLetter":
419
- level = NumberingLevel.createUpperLetterLevel(i, template);
420
- break;
421
- case "upperRoman":
422
- level = NumberingLevel.createUpperRomanLevel(i, template);
423
- break;
424
- case "decimal":
425
- default:
426
- level = NumberingLevel.createDecimalLevel(i, template);
427
- break;
428
- }
429
-
430
- abstractNum.addLevel(level);
431
- }
432
-
433
- return abstractNum;
434
- }
435
-
436
- /**
437
- * Creates a multi-level list with mixed formats
438
- * @param abstractNumId The abstract numbering ID
439
- */
440
- static createMultiLevelList(abstractNumId: number): AbstractNumbering {
441
- const abstractNum = new AbstractNumbering({
442
- abstractNumId,
443
- name: "Multi-Level List",
444
- multiLevelType: 1,
445
- });
446
-
447
- // Level 0: 1, 2, 3, ...
448
- abstractNum.addLevel(NumberingLevel.createDecimalLevel(0, "%1."));
449
-
450
- // Level 1: a, b, c, ...
451
- abstractNum.addLevel(NumberingLevel.createLowerLetterLevel(1, "%2."));
452
-
453
- // Level 2: i, ii, iii, ...
454
- abstractNum.addLevel(NumberingLevel.createLowerRomanLevel(2, "%3."));
455
-
456
- // Level 3: 1, 2, 3, ... (with more indent)
457
- abstractNum.addLevel(NumberingLevel.createDecimalLevel(3, "%4."));
458
-
459
- return abstractNum;
460
- }
461
-
462
- /**
463
- * Creates an outline list abstract numbering
464
- * @param abstractNumId The abstract numbering ID
465
- */
466
- static createOutlineList(abstractNumId: number): AbstractNumbering {
467
- const abstractNum = new AbstractNumbering({
468
- abstractNumId,
469
- name: "Outline List",
470
- multiLevelType: 1,
471
- });
472
-
473
- // Level 0: I, II, III, ...
474
- abstractNum.addLevel(NumberingLevel.createUpperRomanLevel(0, "%1."));
475
-
476
- // Level 1: A, B, C, ...
477
- abstractNum.addLevel(NumberingLevel.createUpperLetterLevel(1, "%2."));
478
-
479
- // Level 2: 1, 2, 3, ...
480
- abstractNum.addLevel(NumberingLevel.createDecimalLevel(2, "%3."));
481
-
482
- // Level 3: a, b, c, ...
483
- abstractNum.addLevel(NumberingLevel.createLowerLetterLevel(3, "%4."));
484
-
485
- // Level 4: i, ii, iii, ...
486
- abstractNum.addLevel(NumberingLevel.createLowerRomanLevel(4, "%5."));
487
-
488
- // Level 5: A, B, C, ... (repeating)
489
- abstractNum.addLevel(NumberingLevel.createUpperLetterLevel(5, "%6."));
490
-
491
- // Level 6: 1, 2, 3, ... (repeating)
492
- abstractNum.addLevel(NumberingLevel.createDecimalLevel(6, "%7."));
493
-
494
- // Level 7: a, b, c, ... (repeating)
495
- abstractNum.addLevel(NumberingLevel.createLowerLetterLevel(7, "%8."));
496
-
497
- // Level 8: i, ii, iii, ... (repeating)
498
- abstractNum.addLevel(NumberingLevel.createLowerRomanLevel(8, "%9."));
499
-
500
- return abstractNum;
501
- }
502
-
503
- /**
504
- * Factory method for creating an abstract numbering definition
505
- * @param properties The abstract numbering properties
506
- */
507
- static create(properties: AbstractNumberingProperties): AbstractNumbering {
508
- return new AbstractNumbering(properties);
509
- }
510
-
511
- /**
512
- * Creates an AbstractNumbering from XML element
513
- * @param xml The XML string of the <w:abstractNum> element
514
- * @returns AbstractNumbering instance
515
- */
516
- static fromXML(xml: string): AbstractNumbering {
517
- // Extract abstractNumId (required)
518
- const abstractNumIdMatch = /<w:abstractNum[^>]*w:abstractNumId="([^"]+)"/.exec(xml);
519
- if (!abstractNumIdMatch?.[1]) {
520
- throw new Error("Missing required w:abstractNumId attribute");
521
- }
522
- const abstractNumId = parseInt(abstractNumIdMatch[1], 10);
523
-
524
- // Extract name (optional)
525
- const nameMatch = /<w:name[^>]*w:val="([^"]+)"/.exec(xml);
526
- const name = nameMatch?.[1] ? nameMatch[1] : undefined;
527
-
528
- // Extract multiLevelType (optional)
529
- // Values: "singleLevel" = 0, "multilevel" = 1, "hybridMultilevel" = 2
530
- const multiLevelTypeMatch = /<w:multiLevelType[^>]*w:val="([^"]+)"/.exec(xml);
531
- let multiLevelType = 1; // default to multilevel
532
- if (multiLevelTypeMatch?.[1]) {
533
- const value = multiLevelTypeMatch[1];
534
- if (value === "singleLevel") multiLevelType = 0;
535
- else if (value === "multilevel") multiLevelType = 1;
536
- else if (value === "hybridMultilevel") multiLevelType = 2;
537
- }
538
-
539
- // Extract numStyleLink (optional, ECMA-376 §17.9.21)
540
- const numStyleLinkMatch = /<w:numStyleLink[^>]*w:val="([^"]+)"/.exec(xml);
541
- const numStyleLink = numStyleLinkMatch?.[1] || undefined;
542
-
543
- // Extract styleLink (optional, ECMA-376 §17.9.27)
544
- const styleLinkMatch = /<w:styleLink[^>]*w:val="([^"]+)"/.exec(xml);
545
- const styleLink = styleLinkMatch?.[1] || undefined;
546
-
547
- // Extract template code (optional, ECMA-376 §17.9.30)
548
- const tmplMatch = /<w:tmpl[^>]*w:val="([^"]+)"/.exec(xml);
549
- const tmpl = tmplMatch?.[1] || undefined;
550
-
551
- // Create abstract numbering
552
- const abstractNum = new AbstractNumbering({
553
- abstractNumId,
554
- name,
555
- multiLevelType,
556
- numStyleLink,
557
- styleLink,
558
- tmpl,
559
- });
560
-
561
- // Extract and parse all levels
562
- const lvlRegex = /<w:lvl[^>]*>[\s\S]*?<\/w:lvl>/g;
563
- const lvlMatches = xml.match(lvlRegex);
564
-
565
- if (lvlMatches) {
566
- for (const lvlXml of lvlMatches) {
567
- try {
568
- const level = NumberingLevel.fromXML(lvlXml);
569
- abstractNum.addLevel(level);
570
- } catch (error: unknown) {
571
- // Skip malformed levels but continue parsing
572
- defaultLogger.warn(`Failed to parse level: ${error}`);
573
- }
574
- }
575
- }
576
-
577
- return abstractNum;
578
- }
579
- }
1
+ /**
2
+ * AbstractNumbering - Defines a multi-level numbering scheme
3
+ *
4
+ * An abstract numbering definition is a template that defines up to 9 levels of
5
+ * list formatting. It's referenced by numbering instances which link it to actual
6
+ * paragraphs in the document.
7
+ */
8
+
9
+ import { XMLBuilder, XMLElement } from '../xml/XMLBuilder';
10
+ import { NumberingLevel } from './NumberingLevel';
11
+ import { defaultLogger } from '../utils/logger';
12
+
13
+ /**
14
+ * Properties for creating an abstract numbering definition
15
+ */
16
+ export interface AbstractNumberingProperties {
17
+ /** Unique identifier for this abstract numbering */
18
+ abstractNumId: number;
19
+
20
+ /** Optional name for the numbering scheme */
21
+ name?: string;
22
+
23
+ /** The numbering levels (up to 9 levels, 0-8) */
24
+ levels?: NumberingLevel[];
25
+
26
+ /** Optional multiLevel type (0 = single level, 1 = multilevel) */
27
+ multiLevelType?: number;
28
+
29
+ /** Optional link to a numbering style definition (ECMA-376 §17.9.21) */
30
+ numStyleLink?: string;
31
+
32
+ /** Optional link to a style that uses this abstract numbering (ECMA-376 §17.9.27) */
33
+ styleLink?: string;
34
+
35
+ /** Template code (ECMA-376 §17.9.30) - 8-char hex string identifying the template */
36
+ tmpl?: string;
37
+ }
38
+
39
+ /**
40
+ * Represents an abstract numbering definition
41
+ *
42
+ * Abstract numbering defines the template for a multi-level list. Each instance
43
+ * of a list in the document references an abstract numbering definition.
44
+ */
45
+ export class AbstractNumbering {
46
+ private abstractNumId: number;
47
+ private name?: string;
48
+ private levels: Map<number, NumberingLevel>;
49
+ private multiLevelType: number;
50
+ private numStyleLink?: string;
51
+ private styleLink?: string;
52
+ private tmpl?: string;
53
+
54
+ /**
55
+ * Creates a new abstract numbering definition
56
+ * @param idOrProps The abstract numbering ID (number) or properties object
57
+ * @param name Optional name (if first param is a number)
58
+ */
59
+ constructor(idOrProps: number | AbstractNumberingProperties, name?: string) {
60
+ // Support both simple (numId) and object constructor patterns
61
+ if (typeof idOrProps === 'number') {
62
+ // Simple constructor: new AbstractNumbering(id)
63
+ this.abstractNumId = idOrProps;
64
+ this.name = name;
65
+ this.levels = new Map();
66
+ this.multiLevelType = 1; // default multilevel
67
+ } else {
68
+ // Object constructor: new AbstractNumbering({ abstractNumId, ... })
69
+ const properties = idOrProps;
70
+ this.abstractNumId = properties.abstractNumId;
71
+ this.name = properties.name;
72
+ this.levels = new Map();
73
+ this.multiLevelType = properties.multiLevelType !== undefined ? properties.multiLevelType : 1;
74
+ this.numStyleLink = properties.numStyleLink;
75
+ this.styleLink = properties.styleLink;
76
+ this.tmpl = properties.tmpl;
77
+
78
+ if (properties.levels) {
79
+ properties.levels.forEach((level) => {
80
+ this.addLevel(level);
81
+ });
82
+ }
83
+ }
84
+
85
+ this.validate();
86
+ }
87
+
88
+ /**
89
+ * Validates the abstract numbering
90
+ */
91
+ private validate(): void {
92
+ if (this.abstractNumId < 0) {
93
+ throw new Error('Abstract numbering ID must be non-negative');
94
+ }
95
+
96
+ if (this.levels.size > 9) {
97
+ throw new Error('Cannot have more than 9 levels (0-8)');
98
+ }
99
+ }
100
+
101
+ /**
102
+ * Gets the abstract numbering ID
103
+ */
104
+ getAbstractNumId(): number {
105
+ return this.abstractNumId;
106
+ }
107
+
108
+ /**
109
+ * Alias for getAbstractNumId for backward compatibility
110
+ */
111
+ getId(): number {
112
+ return this.abstractNumId;
113
+ }
114
+
115
+ /**
116
+ * Gets the name
117
+ */
118
+ getName(): string | undefined {
119
+ return this.name;
120
+ }
121
+
122
+ /**
123
+ * Sets the name
124
+ * @param name The numbering scheme name
125
+ */
126
+ setName(name: string): this {
127
+ this.name = name;
128
+ return this;
129
+ }
130
+
131
+ /**
132
+ * Gets the multi-level type
133
+ */
134
+ getMultiLevelType(): string {
135
+ if (this.multiLevelType === 1) {
136
+ return 'multilevel';
137
+ } else if (this.multiLevelType === 2) {
138
+ return 'hybridMultilevel';
139
+ } else {
140
+ return 'singleLevel';
141
+ }
142
+ }
143
+
144
+ /**
145
+ * Sets the multi-level type
146
+ * @param type The multi-level type ('multilevel' or 'singleLevel')
147
+ */
148
+ setMultiLevelType(type: 'multilevel' | 'singleLevel' | 'hybridMultilevel'): this {
149
+ if (type === 'multilevel') {
150
+ this.multiLevelType = 1;
151
+ } else if (type === 'hybridMultilevel') {
152
+ this.multiLevelType = 2;
153
+ } else {
154
+ this.multiLevelType = 0;
155
+ }
156
+ return this;
157
+ }
158
+
159
+ /**
160
+ * Gets the numStyleLink (reference to a numbering style definition)
161
+ */
162
+ getNumStyleLink(): string | undefined {
163
+ return this.numStyleLink;
164
+ }
165
+
166
+ /**
167
+ * Sets the numStyleLink
168
+ * @param link The numbering style name
169
+ */
170
+ setNumStyleLink(link: string | undefined): this {
171
+ this.numStyleLink = link;
172
+ return this;
173
+ }
174
+
175
+ /**
176
+ * Gets the styleLink (reference to a style that uses this abstract numbering)
177
+ */
178
+ getStyleLink(): string | undefined {
179
+ return this.styleLink;
180
+ }
181
+
182
+ /**
183
+ * Sets the styleLink
184
+ * @param link The style name
185
+ */
186
+ setStyleLink(link: string | undefined): this {
187
+ this.styleLink = link;
188
+ return this;
189
+ }
190
+
191
+ /**
192
+ * Gets the template code (w:tmpl per ECMA-376 §17.9.30)
193
+ */
194
+ getTemplate(): string | undefined {
195
+ return this.tmpl;
196
+ }
197
+
198
+ /**
199
+ * Sets the template code
200
+ * @param tmpl 8-char hex string identifying the template
201
+ */
202
+ setTemplate(tmpl: string): this {
203
+ this.tmpl = tmpl;
204
+ return this;
205
+ }
206
+
207
+ /**
208
+ * Adds a numbering level
209
+ * @param level The numbering level to add
210
+ */
211
+ addLevel(level: NumberingLevel): this {
212
+ const levelIndex = level.getLevel();
213
+
214
+ if (levelIndex < 0 || levelIndex > 8) {
215
+ throw new Error(`Level must be between 0 and 8, got ${levelIndex}`);
216
+ }
217
+
218
+ this.levels.set(levelIndex, level);
219
+ return this;
220
+ }
221
+
222
+ /**
223
+ * Adds multiple numbering levels at once
224
+ * @param levels The numbering levels to add
225
+ */
226
+ addLevels(levels: NumberingLevel[]): this {
227
+ levels.forEach((level) => this.addLevel(level));
228
+ return this;
229
+ }
230
+
231
+ /**
232
+ * Gets a numbering level by index
233
+ * @param levelIndex The level index (0-8)
234
+ */
235
+ getLevel(levelIndex: number): NumberingLevel | undefined {
236
+ return this.levels.get(levelIndex);
237
+ }
238
+
239
+ /**
240
+ * Gets all levels
241
+ */
242
+ getAllLevels(): NumberingLevel[] {
243
+ return Array.from(this.levels.values()).sort((a, b) => a.getLevel() - b.getLevel());
244
+ }
245
+
246
+ /**
247
+ * Alias for getAllLevels for backward compatibility
248
+ */
249
+ getLevels(): NumberingLevel[] {
250
+ return this.getAllLevels();
251
+ }
252
+
253
+ /**
254
+ * Gets the number of levels defined
255
+ */
256
+ getLevelCount(): number {
257
+ return this.levels.size;
258
+ }
259
+
260
+ /**
261
+ * Checks if a level exists
262
+ * @param levelIndex The level index (0-8)
263
+ */
264
+ hasLevel(levelIndex: number): boolean {
265
+ return this.levels.has(levelIndex);
266
+ }
267
+
268
+ /**
269
+ * Removes a level
270
+ * @param levelIndex The level index (0-8)
271
+ */
272
+ removeLevel(levelIndex: number): boolean {
273
+ return this.levels.delete(levelIndex);
274
+ }
275
+
276
+ /**
277
+ * Generates the WordprocessingML XML for this abstract numbering
278
+ */
279
+ toXML(): XMLElement {
280
+ const children: XMLElement[] = [];
281
+
282
+ // CT_AbstractNum order per ECMA-376: nsid multiLevelType → tmpl → name → styleLink → numStyleLink → lvl*
283
+
284
+ // Add multiLevelType
285
+ let multiLevelTypeValue: string;
286
+ if (this.multiLevelType === 1) {
287
+ multiLevelTypeValue = 'multilevel';
288
+ } else if (this.multiLevelType === 2) {
289
+ multiLevelTypeValue = 'hybridMultilevel';
290
+ } else {
291
+ multiLevelTypeValue = 'singleLevel';
292
+ }
293
+
294
+ children.push(
295
+ XMLBuilder.wSelf('multiLevelType', {
296
+ 'w:val': multiLevelTypeValue,
297
+ })
298
+ );
299
+
300
+ // Add template code (position 3 per CT_AbstractNum)
301
+ if (this.tmpl) {
302
+ children.push(XMLBuilder.wSelf('tmpl', { 'w:val': this.tmpl }));
303
+ }
304
+
305
+ // Add name if present
306
+ if (this.name) {
307
+ children.push(XMLBuilder.wSelf('name', { 'w:val': this.name }));
308
+ }
309
+
310
+ // Add styleLink / numStyleLink if present
311
+ if (this.styleLink) {
312
+ children.push(XMLBuilder.wSelf('styleLink', { 'w:val': this.styleLink }));
313
+ }
314
+ if (this.numStyleLink) {
315
+ children.push(XMLBuilder.wSelf('numStyleLink', { 'w:val': this.numStyleLink }));
316
+ }
317
+
318
+ // Add all levels in order
319
+ const sortedLevels = this.getAllLevels();
320
+ sortedLevels.forEach((level) => {
321
+ children.push(level.toXML());
322
+ });
323
+
324
+ // If no levels defined, add a default level 0
325
+ if (sortedLevels.length === 0) {
326
+ children.push(NumberingLevel.createDecimalLevel(0).toXML());
327
+ }
328
+
329
+ return XMLBuilder.w(
330
+ 'abstractNum',
331
+ { 'w:abstractNumId': this.abstractNumId.toString() },
332
+ children
333
+ );
334
+ }
335
+
336
+ /**
337
+ * Creates a bullet list abstract numbering with specified levels
338
+ *
339
+ * Uses Calibri font for better UI compatibility. For advanced bullet symbol selection,
340
+ * use NumberingLevel.getBulletSymbolWithFont() to get recommended symbol/font pairs.
341
+ *
342
+ * @param abstractNumId The abstract numbering ID
343
+ * @param levels Number of levels (default: 9)
344
+ * @param bullets Array of bullet characters (default: ['•', '○', '▪'])
345
+ *
346
+ * @example
347
+ * // Standard bullet list
348
+ * const bulletList = AbstractNumbering.createBulletList(1);
349
+ *
350
+ * @example
351
+ * // Custom bullets using helper method
352
+ * const bullets = [];
353
+ * for (let i = 0; i < 9; i++) {
354
+ * const { symbol } = NumberingLevel.getBulletSymbolWithFont(i, 'square');
355
+ * bullets.push(symbol);
356
+ * }
357
+ * const squareList = AbstractNumbering.createBulletList(2, 9, bullets);
358
+ */
359
+ static createBulletList(
360
+ abstractNumId: number,
361
+ levels = 9,
362
+ bullets?: string[] // Optional: custom bullets. If not provided, uses Word-native encoding
363
+ ): AbstractNumbering {
364
+ const abstractNum = new AbstractNumbering({
365
+ abstractNumId,
366
+ name: 'Bullet List',
367
+ multiLevelType: 1,
368
+ });
369
+
370
+ for (let i = 0; i < levels && i < 9; i++) {
371
+ if (bullets && bullets.length > 0) {
372
+ // Custom bullets provided - use them with default font
373
+ const bullet = bullets[i % bullets.length] || '•';
374
+ abstractNum.addLevel(NumberingLevel.createBulletLevel(i, bullet));
375
+ } else {
376
+ // No custom bullets - use Word-native encoding (correct font per level)
377
+ abstractNum.addLevel(NumberingLevel.createBulletLevel(i));
378
+ }
379
+ }
380
+
381
+ return abstractNum;
382
+ }
383
+
384
+ /**
385
+ * Creates a numbered list abstract numbering with specified levels
386
+ * @param abstractNumId The abstract numbering ID
387
+ * @param levels Number of levels (default: 9)
388
+ * @param formats Array of formats for each level
389
+ */
390
+ static createNumberedList(
391
+ abstractNumId: number,
392
+ levels = 9,
393
+ formats: ('decimal' | 'lowerLetter' | 'lowerRoman' | 'upperLetter' | 'upperRoman')[] = [
394
+ 'decimal',
395
+ 'lowerLetter',
396
+ 'lowerRoman',
397
+ 'upperLetter',
398
+ 'upperRoman',
399
+ ]
400
+ ): AbstractNumbering {
401
+ const abstractNum = new AbstractNumbering({
402
+ abstractNumId,
403
+ name: 'Numbered List',
404
+ multiLevelType: 1,
405
+ });
406
+
407
+ for (let i = 0; i < levels && i < 9; i++) {
408
+ const format = formats[i % formats.length] || 'decimal';
409
+ const template = `%${i + 1}.`;
410
+
411
+ let level: NumberingLevel;
412
+ switch (format) {
413
+ case 'lowerLetter':
414
+ level = NumberingLevel.createLowerLetterLevel(i, template);
415
+ break;
416
+ case 'lowerRoman':
417
+ level = NumberingLevel.createLowerRomanLevel(i, template);
418
+ break;
419
+ case 'upperLetter':
420
+ level = NumberingLevel.createUpperLetterLevel(i, template);
421
+ break;
422
+ case 'upperRoman':
423
+ level = NumberingLevel.createUpperRomanLevel(i, template);
424
+ break;
425
+ case 'decimal':
426
+ default:
427
+ level = NumberingLevel.createDecimalLevel(i, template);
428
+ break;
429
+ }
430
+
431
+ abstractNum.addLevel(level);
432
+ }
433
+
434
+ return abstractNum;
435
+ }
436
+
437
+ /**
438
+ * Creates a multi-level list with mixed formats
439
+ * @param abstractNumId The abstract numbering ID
440
+ */
441
+ static createMultiLevelList(abstractNumId: number): AbstractNumbering {
442
+ const abstractNum = new AbstractNumbering({
443
+ abstractNumId,
444
+ name: 'Multi-Level List',
445
+ multiLevelType: 1,
446
+ });
447
+
448
+ // Level 0: 1, 2, 3, ...
449
+ abstractNum.addLevel(NumberingLevel.createDecimalLevel(0, '%1.'));
450
+
451
+ // Level 1: a, b, c, ...
452
+ abstractNum.addLevel(NumberingLevel.createLowerLetterLevel(1, '%2.'));
453
+
454
+ // Level 2: i, ii, iii, ...
455
+ abstractNum.addLevel(NumberingLevel.createLowerRomanLevel(2, '%3.'));
456
+
457
+ // Level 3: 1, 2, 3, ... (with more indent)
458
+ abstractNum.addLevel(NumberingLevel.createDecimalLevel(3, '%4.'));
459
+
460
+ return abstractNum;
461
+ }
462
+
463
+ /**
464
+ * Creates an outline list abstract numbering
465
+ * @param abstractNumId The abstract numbering ID
466
+ */
467
+ static createOutlineList(abstractNumId: number): AbstractNumbering {
468
+ const abstractNum = new AbstractNumbering({
469
+ abstractNumId,
470
+ name: 'Outline List',
471
+ multiLevelType: 1,
472
+ });
473
+
474
+ // Level 0: I, II, III, ...
475
+ abstractNum.addLevel(NumberingLevel.createUpperRomanLevel(0, '%1.'));
476
+
477
+ // Level 1: A, B, C, ...
478
+ abstractNum.addLevel(NumberingLevel.createUpperLetterLevel(1, '%2.'));
479
+
480
+ // Level 2: 1, 2, 3, ...
481
+ abstractNum.addLevel(NumberingLevel.createDecimalLevel(2, '%3.'));
482
+
483
+ // Level 3: a, b, c, ...
484
+ abstractNum.addLevel(NumberingLevel.createLowerLetterLevel(3, '%4.'));
485
+
486
+ // Level 4: i, ii, iii, ...
487
+ abstractNum.addLevel(NumberingLevel.createLowerRomanLevel(4, '%5.'));
488
+
489
+ // Level 5: A, B, C, ... (repeating)
490
+ abstractNum.addLevel(NumberingLevel.createUpperLetterLevel(5, '%6.'));
491
+
492
+ // Level 6: 1, 2, 3, ... (repeating)
493
+ abstractNum.addLevel(NumberingLevel.createDecimalLevel(6, '%7.'));
494
+
495
+ // Level 7: a, b, c, ... (repeating)
496
+ abstractNum.addLevel(NumberingLevel.createLowerLetterLevel(7, '%8.'));
497
+
498
+ // Level 8: i, ii, iii, ... (repeating)
499
+ abstractNum.addLevel(NumberingLevel.createLowerRomanLevel(8, '%9.'));
500
+
501
+ return abstractNum;
502
+ }
503
+
504
+ /**
505
+ * Factory method for creating an abstract numbering definition
506
+ * @param properties The abstract numbering properties
507
+ */
508
+ static create(properties: AbstractNumberingProperties): AbstractNumbering {
509
+ return new AbstractNumbering(properties);
510
+ }
511
+
512
+ /**
513
+ * Creates an AbstractNumbering from XML element
514
+ * @param xml The XML string of the <w:abstractNum> element
515
+ * @returns AbstractNumbering instance
516
+ */
517
+ static fromXML(xml: string): AbstractNumbering {
518
+ // Extract abstractNumId (required)
519
+ const abstractNumIdMatch = /<w:abstractNum[^>]*w:abstractNumId="([^"]+)"/.exec(xml);
520
+ if (!abstractNumIdMatch?.[1]) {
521
+ throw new Error('Missing required w:abstractNumId attribute');
522
+ }
523
+ const abstractNumId = parseInt(abstractNumIdMatch[1], 10);
524
+
525
+ // Extract name (optional)
526
+ const nameMatch = /<w:name[^>]*w:val="([^"]+)"/.exec(xml);
527
+ const name = nameMatch?.[1] ? nameMatch[1] : undefined;
528
+
529
+ // Extract multiLevelType (optional)
530
+ // Values: "singleLevel" = 0, "multilevel" = 1, "hybridMultilevel" = 2
531
+ const multiLevelTypeMatch = /<w:multiLevelType[^>]*w:val="([^"]+)"/.exec(xml);
532
+ let multiLevelType = 1; // default to multilevel
533
+ if (multiLevelTypeMatch?.[1]) {
534
+ const value = multiLevelTypeMatch[1];
535
+ if (value === 'singleLevel') multiLevelType = 0;
536
+ else if (value === 'multilevel') multiLevelType = 1;
537
+ else if (value === 'hybridMultilevel') multiLevelType = 2;
538
+ }
539
+
540
+ // Extract numStyleLink (optional, ECMA-376 §17.9.21)
541
+ const numStyleLinkMatch = /<w:numStyleLink[^>]*w:val="([^"]+)"/.exec(xml);
542
+ const numStyleLink = numStyleLinkMatch?.[1] || undefined;
543
+
544
+ // Extract styleLink (optional, ECMA-376 §17.9.27)
545
+ const styleLinkMatch = /<w:styleLink[^>]*w:val="([^"]+)"/.exec(xml);
546
+ const styleLink = styleLinkMatch?.[1] || undefined;
547
+
548
+ // Extract template code (optional, ECMA-376 §17.9.30)
549
+ const tmplMatch = /<w:tmpl[^>]*w:val="([^"]+)"/.exec(xml);
550
+ const tmpl = tmplMatch?.[1] || undefined;
551
+
552
+ // Create abstract numbering
553
+ const abstractNum = new AbstractNumbering({
554
+ abstractNumId,
555
+ name,
556
+ multiLevelType,
557
+ numStyleLink,
558
+ styleLink,
559
+ tmpl,
560
+ });
561
+
562
+ // Extract and parse all levels
563
+ const lvlRegex = /<w:lvl[^>]*>[\s\S]*?<\/w:lvl>/g;
564
+ const lvlMatches = xml.match(lvlRegex);
565
+
566
+ if (lvlMatches) {
567
+ for (const lvlXml of lvlMatches) {
568
+ try {
569
+ const level = NumberingLevel.fromXML(lvlXml);
570
+ abstractNum.addLevel(level);
571
+ } catch (error: unknown) {
572
+ // Skip malformed levels but continue parsing
573
+ defaultLogger.warn(`Failed to parse level: ${error}`);
574
+ }
575
+ }
576
+ }
577
+
578
+ return abstractNum;
579
+ }
580
+ }