docxmlater 10.1.3 → 10.1.5

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 (371) 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 +50 -50
  6. package/dist/core/Document.d.ts.map +1 -1
  7. package/dist/core/Document.js +483 -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.map +1 -1
  146. package/dist/formatting/NumberingManager.js +9 -9
  147. package/dist/formatting/NumberingManager.js.map +1 -1
  148. package/dist/formatting/Style.d.ts +11 -11
  149. package/dist/formatting/Style.d.ts.map +1 -1
  150. package/dist/formatting/Style.js +219 -247
  151. package/dist/formatting/Style.js.map +1 -1
  152. package/dist/formatting/StylesManager.d.ts +2 -2
  153. package/dist/formatting/StylesManager.d.ts.map +1 -1
  154. package/dist/formatting/StylesManager.js +96 -102
  155. package/dist/formatting/StylesManager.js.map +1 -1
  156. package/dist/helpers/CleanupHelper.d.ts +1 -1
  157. package/dist/helpers/CleanupHelper.d.ts.map +1 -1
  158. package/dist/helpers/CleanupHelper.js +6 -6
  159. package/dist/helpers/CleanupHelper.js.map +1 -1
  160. package/dist/images/ImageOptimizer.js +7 -7
  161. package/dist/images/ImageOptimizer.js.map +1 -1
  162. package/dist/index.d.ts +9 -9
  163. package/dist/index.d.ts.map +1 -1
  164. package/dist/index.js.map +1 -1
  165. package/dist/managers/DrawingManager.js.map +1 -1
  166. package/dist/tracking/DocumentTrackingContext.d.ts.map +1 -1
  167. package/dist/tracking/DocumentTrackingContext.js +23 -7
  168. package/dist/tracking/DocumentTrackingContext.js.map +1 -1
  169. package/dist/tracking/TrackingContext.d.ts.map +1 -1
  170. package/dist/tracking/TrackingContext.js.map +1 -1
  171. package/dist/types/compatibility-types.js.map +1 -1
  172. package/dist/types/formatting.js.map +1 -1
  173. package/dist/types/list-types.d.ts +6 -6
  174. package/dist/types/list-types.js.map +1 -1
  175. package/dist/types/settings-types.js.map +1 -1
  176. package/dist/types/styleConfig.d.ts +2 -2
  177. package/dist/types/styleConfig.js.map +1 -1
  178. package/dist/utils/ChangelogGenerator.d.ts.map +1 -1
  179. package/dist/utils/ChangelogGenerator.js +97 -101
  180. package/dist/utils/ChangelogGenerator.js.map +1 -1
  181. package/dist/utils/CompatibilityUpgrader.d.ts.map +1 -1
  182. package/dist/utils/CompatibilityUpgrader.js +1 -1
  183. package/dist/utils/CompatibilityUpgrader.js.map +1 -1
  184. package/dist/utils/InMemoryRevisionAcceptor.d.ts.map +1 -1
  185. package/dist/utils/InMemoryRevisionAcceptor.js +1 -6
  186. package/dist/utils/InMemoryRevisionAcceptor.js.map +1 -1
  187. package/dist/utils/MoveOperationHelper.d.ts.map +1 -1
  188. package/dist/utils/MoveOperationHelper.js +1 -1
  189. package/dist/utils/MoveOperationHelper.js.map +1 -1
  190. package/dist/utils/RevisionAwareProcessor.d.ts.map +1 -1
  191. package/dist/utils/RevisionAwareProcessor.js +2 -4
  192. package/dist/utils/RevisionAwareProcessor.js.map +1 -1
  193. package/dist/utils/RevisionWalker.d.ts.map +1 -1
  194. package/dist/utils/RevisionWalker.js +4 -12
  195. package/dist/utils/RevisionWalker.js.map +1 -1
  196. package/dist/utils/SelectiveRevisionAcceptor.d.ts.map +1 -1
  197. package/dist/utils/SelectiveRevisionAcceptor.js +2 -6
  198. package/dist/utils/SelectiveRevisionAcceptor.js.map +1 -1
  199. package/dist/utils/ShadingResolver.d.ts.map +1 -1
  200. package/dist/utils/ShadingResolver.js +1 -1
  201. package/dist/utils/ShadingResolver.js.map +1 -1
  202. package/dist/utils/acceptRevisions.d.ts.map +1 -1
  203. package/dist/utils/acceptRevisions.js +23 -12
  204. package/dist/utils/acceptRevisions.js.map +1 -1
  205. package/dist/utils/cnfStyleDecoder.d.ts +1 -1
  206. package/dist/utils/cnfStyleDecoder.d.ts.map +1 -1
  207. package/dist/utils/cnfStyleDecoder.js +40 -40
  208. package/dist/utils/cnfStyleDecoder.js.map +1 -1
  209. package/dist/utils/corruptionDetection.d.ts.map +1 -1
  210. package/dist/utils/corruptionDetection.js.map +1 -1
  211. package/dist/utils/dateFormatting.js.map +1 -1
  212. package/dist/utils/deepClone.js +1 -1
  213. package/dist/utils/deepClone.js.map +1 -1
  214. package/dist/utils/diagnostics.d.ts.map +1 -1
  215. package/dist/utils/diagnostics.js +1 -1
  216. package/dist/utils/diagnostics.js.map +1 -1
  217. package/dist/utils/errorHandling.js.map +1 -1
  218. package/dist/utils/formatting.d.ts.map +1 -1
  219. package/dist/utils/formatting.js +10 -2
  220. package/dist/utils/formatting.js.map +1 -1
  221. package/dist/utils/list-detection.d.ts +2 -2
  222. package/dist/utils/list-detection.d.ts.map +1 -1
  223. package/dist/utils/list-detection.js +21 -23
  224. package/dist/utils/list-detection.js.map +1 -1
  225. package/dist/utils/logger.d.ts.map +1 -1
  226. package/dist/utils/logger.js +12 -7
  227. package/dist/utils/logger.js.map +1 -1
  228. package/dist/utils/parsingHelpers.js.map +1 -1
  229. package/dist/utils/stripTrackedChanges.d.ts.map +1 -1
  230. package/dist/utils/stripTrackedChanges.js +3 -3
  231. package/dist/utils/stripTrackedChanges.js.map +1 -1
  232. package/dist/utils/textDiff.d.ts +1 -1
  233. package/dist/utils/textDiff.js +8 -8
  234. package/dist/utils/textDiff.js.map +1 -1
  235. package/dist/utils/units.js.map +1 -1
  236. package/dist/utils/validation.d.ts.map +1 -1
  237. package/dist/utils/validation.js +24 -7
  238. package/dist/utils/validation.js.map +1 -1
  239. package/dist/utils/xmlSanitization.d.ts.map +1 -1
  240. package/dist/utils/xmlSanitization.js +3 -3
  241. package/dist/utils/xmlSanitization.js.map +1 -1
  242. package/dist/validation/RevisionAutoFixer.d.ts.map +1 -1
  243. package/dist/validation/RevisionAutoFixer.js +5 -5
  244. package/dist/validation/RevisionAutoFixer.js.map +1 -1
  245. package/dist/validation/RevisionValidator.d.ts.map +1 -1
  246. package/dist/validation/RevisionValidator.js +7 -9
  247. package/dist/validation/RevisionValidator.js.map +1 -1
  248. package/dist/validation/ValidationRules.js +3 -3
  249. package/dist/validation/ValidationRules.js.map +1 -1
  250. package/dist/validation/index.js.map +1 -1
  251. package/dist/xml/XMLBuilder.d.ts +1 -1
  252. package/dist/xml/XMLBuilder.d.ts.map +1 -1
  253. package/dist/xml/XMLBuilder.js +98 -100
  254. package/dist/xml/XMLBuilder.js.map +1 -1
  255. package/dist/xml/XMLParser.d.ts.map +1 -1
  256. package/dist/xml/XMLParser.js +61 -66
  257. package/dist/xml/XMLParser.js.map +1 -1
  258. package/dist/zip/ZipHandler.d.ts.map +1 -1
  259. package/dist/zip/ZipHandler.js.map +1 -1
  260. package/dist/zip/ZipReader.d.ts.map +1 -1
  261. package/dist/zip/ZipReader.js +1 -3
  262. package/dist/zip/ZipReader.js.map +1 -1
  263. package/dist/zip/ZipWriter.d.ts +1 -1
  264. package/dist/zip/ZipWriter.d.ts.map +1 -1
  265. package/dist/zip/ZipWriter.js +28 -36
  266. package/dist/zip/ZipWriter.js.map +1 -1
  267. package/dist/zip/types.js +1 -1
  268. package/dist/zip/types.js.map +1 -1
  269. package/package.json +92 -92
  270. package/src/__tests__/helper-methods.test.ts +512 -512
  271. package/src/constants/legacyCompatFlags.ts +138 -138
  272. package/src/constants/limits.ts +50 -50
  273. package/src/core/Document.ts +985 -1145
  274. package/src/core/DocumentContent.ts +461 -467
  275. package/src/core/DocumentGenerator.ts +1133 -1104
  276. package/src/core/DocumentIdManager.ts +158 -158
  277. package/src/core/DocumentParser.ts +2347 -2716
  278. package/src/core/DocumentValidator.ts +363 -372
  279. package/src/core/Relationship.ts +367 -367
  280. package/src/core/RelationshipManager.ts +429 -428
  281. package/src/elements/AlternateContent.ts +42 -42
  282. package/src/elements/Bookmark.ts +212 -210
  283. package/src/elements/BookmarkManager.ts +247 -250
  284. package/src/elements/Comment.ts +356 -359
  285. package/src/elements/CommentManager.ts +499 -502
  286. package/src/elements/CommonTypes.ts +524 -549
  287. package/src/elements/CustomXml.ts +36 -36
  288. package/src/elements/Endnote.ts +221 -217
  289. package/src/elements/EndnoteManager.ts +246 -249
  290. package/src/elements/Field.ts +1292 -1233
  291. package/src/elements/FieldHelpers.ts +329 -333
  292. package/src/elements/FontManager.ts +336 -339
  293. package/src/elements/Footer.ts +269 -269
  294. package/src/elements/Footnote.ts +221 -217
  295. package/src/elements/FootnoteManager.ts +246 -249
  296. package/src/elements/Header.ts +269 -269
  297. package/src/elements/HeaderFooterManager.ts +219 -219
  298. package/src/elements/Hyperlink.ts +1288 -1193
  299. package/src/elements/Image.ts +1982 -1756
  300. package/src/elements/ImageManager.ts +437 -432
  301. package/src/elements/ImageRun.ts +59 -59
  302. package/src/elements/MathElement.ts +65 -65
  303. package/src/elements/Paragraph.ts +4347 -4287
  304. package/src/elements/PreservedElement.ts +53 -53
  305. package/src/elements/PropertyChangeTypes.ts +458 -442
  306. package/src/elements/RangeMarker.ts +382 -400
  307. package/src/elements/Revision.ts +1198 -1217
  308. package/src/elements/RevisionContent.ts +73 -73
  309. package/src/elements/RevisionManager.ts +1070 -1070
  310. package/src/elements/Run.ts +3103 -3073
  311. package/src/elements/Section.ts +1521 -1421
  312. package/src/elements/Shape.ts +884 -873
  313. package/src/elements/StructuredDocumentTag.ts +1176 -1207
  314. package/src/elements/Table.ts +2468 -2524
  315. package/src/elements/TableCell.ts +1617 -1621
  316. package/src/elements/TableGridChange.ts +149 -151
  317. package/src/elements/TableOfContents.ts +701 -691
  318. package/src/elements/TableOfContentsElement.ts +89 -89
  319. package/src/elements/TableRow.ts +960 -929
  320. package/src/elements/TextBox.ts +766 -768
  321. package/src/formatting/AbstractNumbering.ts +580 -579
  322. package/src/formatting/NumberingInstance.ts +295 -299
  323. package/src/formatting/NumberingLevel.ts +981 -1040
  324. package/src/formatting/NumberingManager.ts +833 -827
  325. package/src/formatting/Style.ts +1785 -1879
  326. package/src/formatting/StylesManager.ts +1090 -1130
  327. package/src/helpers/CleanupHelper.ts +524 -524
  328. package/src/images/ImageOptimizer.ts +274 -274
  329. package/src/index.ts +559 -554
  330. package/src/managers/DrawingManager.ts +319 -319
  331. package/src/tracking/DocumentTrackingContext.ts +687 -674
  332. package/src/tracking/TrackingContext.ts +175 -173
  333. package/src/types/compatibility-types.ts +49 -49
  334. package/src/types/formatting.ts +210 -210
  335. package/src/types/list-types.ts +14 -14
  336. package/src/types/settings-types.ts +59 -59
  337. package/src/types/styleConfig.ts +189 -189
  338. package/src/utils/ChangelogGenerator.ts +1583 -1581
  339. package/src/utils/CompatibilityUpgrader.ts +235 -237
  340. package/src/utils/InMemoryRevisionAcceptor.ts +691 -696
  341. package/src/utils/MoveOperationHelper.ts +233 -238
  342. package/src/utils/RevisionAwareProcessor.ts +518 -526
  343. package/src/utils/RevisionWalker.ts +427 -457
  344. package/src/utils/SelectiveRevisionAcceptor.ts +662 -683
  345. package/src/utils/ShadingResolver.ts +105 -107
  346. package/src/utils/acceptRevisions.ts +723 -714
  347. package/src/utils/cnfStyleDecoder.ts +212 -217
  348. package/src/utils/corruptionDetection.ts +346 -345
  349. package/src/utils/dateFormatting.ts +20 -20
  350. package/src/utils/deepClone.ts +77 -78
  351. package/src/utils/diagnostics.ts +125 -129
  352. package/src/utils/errorHandling.ts +80 -80
  353. package/src/utils/formatting.ts +220 -213
  354. package/src/utils/list-detection.ts +32 -42
  355. package/src/utils/logger.ts +412 -404
  356. package/src/utils/parsingHelpers.ts +190 -190
  357. package/src/utils/stripTrackedChanges.ts +356 -353
  358. package/src/utils/textDiff.ts +100 -100
  359. package/src/utils/units.ts +421 -421
  360. package/src/utils/validation.ts +553 -542
  361. package/src/utils/xmlSanitization.ts +179 -182
  362. package/src/validation/RevisionAutoFixer.ts +541 -542
  363. package/src/validation/RevisionValidator.ts +470 -460
  364. package/src/validation/ValidationRules.ts +338 -338
  365. package/src/validation/index.ts +30 -30
  366. package/src/xml/XMLBuilder.ts +857 -871
  367. package/src/xml/XMLParser.ts +877 -919
  368. package/src/zip/ZipHandler.ts +629 -637
  369. package/src/zip/ZipReader.ts +295 -299
  370. package/src/zip/ZipWriter.ts +374 -390
  371. package/src/zip/types.ts +116 -116
@@ -1,502 +1,499 @@
1
- /**
2
- * CommentManager - Manages comments in a document
3
- *
4
- * Tracks all comments, assigns unique IDs, handles replies,
5
- * and generates the comments.xml file.
6
- *
7
- * Per ECMA-376, comment IDs must be unique across ALL annotation types
8
- * in a document. Use setIdProvider() to connect to a centralized ID allocator.
9
- */
10
-
11
- import { Comment } from './Comment';
12
- import { Run } from './Run';
13
- import { XMLBuilder } from '../xml/XMLBuilder';
14
- import { formatDateForXml } from '../utils/dateFormatting';
15
-
16
- /**
17
- * Type for the centralized ID provider callback.
18
- * Returns the next available annotation ID from a shared counter.
19
- */
20
- export type IdProviderCallback = () => number;
21
-
22
- /**
23
- * Type for callback to notify of existing IDs (for synchronization).
24
- * Called when registering existing comments to keep the central counter in sync.
25
- */
26
- export type IdExistsCallback = (existingId: number) => void;
27
-
28
- /**
29
- * Comment entry stored by the manager
30
- */
31
- interface CommentEntry {
32
- comment: Comment;
33
- /** Comments that are replies to this comment */
34
- replies: Comment[];
35
- }
36
-
37
- /**
38
- * Manages document comments
39
- */
40
- export class CommentManager {
41
- private comments = new Map<number, CommentEntry>();
42
- private nextId = 0;
43
- private idProvider: IdProviderCallback | null = null;
44
- private idExistsNotifier: IdExistsCallback | null = null;
45
-
46
- /**
47
- * Sets the centralized ID provider callback.
48
- * When set, IDs will be allocated from the centralized DocumentIdManager
49
- * instead of the local nextId counter.
50
- *
51
- * @param provider - Callback that returns the next available ID
52
- * @param existsNotifier - Optional callback to notify when existing IDs are found
53
- */
54
- setIdProvider(provider: IdProviderCallback, existsNotifier?: IdExistsCallback): void {
55
- this.idProvider = provider;
56
- this.idExistsNotifier = existsNotifier || null;
57
- }
58
-
59
- /**
60
- * Registers a comment with the manager
61
- * Assigns a unique ID
62
- * @param comment - Comment to register
63
- * @returns The registered comment (same instance)
64
- */
65
- register(comment: Comment): Comment {
66
- // Assign unique ID - use centralized provider if available
67
- const id = this.idProvider ? this.idProvider() : this.nextId++;
68
- comment.setId(id);
69
-
70
- // Store comment
71
- const entry: CommentEntry = {
72
- comment,
73
- replies: [],
74
- };
75
- this.comments.set(comment.getId(), entry);
76
-
77
- // If this is a reply, add it to the parent's replies array
78
- if (comment.isReply() && comment.getParentId() !== undefined) {
79
- const parentEntry = this.comments.get(comment.getParentId()!);
80
- if (parentEntry) {
81
- parentEntry.replies.push(comment);
82
- }
83
- }
84
-
85
- return comment;
86
- }
87
-
88
- /**
89
- * Registers an existing comment (from parsing) with its pre-assigned ID.
90
- * Unlike register(), this does NOT assign a new ID - the comment must already have one.
91
- * Used when loading comments from an existing document.
92
- * @param comment - Comment with ID already set
93
- */
94
- registerExisting(comment: Comment): void {
95
- const id = comment.getId();
96
-
97
- // Notify centralized ID manager if connected
98
- if (this.idExistsNotifier) {
99
- this.idExistsNotifier(id);
100
- }
101
-
102
- // Store comment
103
- const entry: CommentEntry = {
104
- comment,
105
- replies: [],
106
- };
107
- this.comments.set(id, entry);
108
-
109
- // Update local nextId if needed
110
- if (id >= this.nextId) {
111
- this.nextId = id + 1;
112
- }
113
- }
114
-
115
- /**
116
- * Links reply comments to their parents after all comments are parsed.
117
- * Must be called after all comments are registered via registerExisting().
118
- * This builds the reply arrays for each parent comment.
119
- */
120
- linkReplies(): void {
121
- // Clear existing replies first for idempotency (safe to call multiple times)
122
- for (const entry of this.comments.values()) {
123
- entry.replies = [];
124
- }
125
- for (const entry of this.comments.values()) {
126
- const comment = entry.comment;
127
- if (comment.isReply() && comment.getParentId() !== undefined) {
128
- const parentEntry = this.comments.get(comment.getParentId()!);
129
- if (parentEntry) {
130
- parentEntry.replies.push(comment);
131
- }
132
- }
133
- }
134
- }
135
-
136
- /**
137
- * Gets a comment by ID
138
- * @param id - Comment ID
139
- * @returns The comment, or undefined if not found
140
- */
141
- getComment(id: number): Comment | undefined {
142
- return this.comments.get(id)?.comment;
143
- }
144
-
145
- /**
146
- * Gets all comments (top-level only, not replies)
147
- * @returns Array of all top-level comments
148
- */
149
- getAllComments(): Comment[] {
150
- return Array.from(this.comments.values())
151
- .filter(entry => !entry.comment.isReply())
152
- .map(entry => entry.comment);
153
- }
154
-
155
- /**
156
- * Gets all comments including replies
157
- * @returns Array of all comments
158
- */
159
- getAllCommentsWithReplies(): Comment[] {
160
- return Array.from(this.comments.values()).map(entry => entry.comment);
161
- }
162
-
163
- /**
164
- * Gets replies to a comment
165
- * @param commentId - ID of the parent comment
166
- * @returns Array of reply comments
167
- */
168
- getReplies(commentId: number): Comment[] {
169
- const entry = this.comments.get(commentId);
170
- return entry ? [...entry.replies] : [];
171
- }
172
-
173
- /**
174
- * Checks if a comment has replies
175
- * @param commentId - ID of the comment
176
- * @returns True if the comment has replies
177
- */
178
- hasReplies(commentId: number): boolean {
179
- const entry = this.comments.get(commentId);
180
- return entry ? entry.replies.length > 0 : false;
181
- }
182
-
183
- /**
184
- * Gets the number of comments (including replies)
185
- * @returns Number of comments
186
- */
187
- getCount(): number {
188
- return this.comments.size;
189
- }
190
-
191
- /**
192
- * Gets the number of top-level comments (excluding replies)
193
- * @returns Number of top-level comments
194
- */
195
- getTopLevelCount(): number {
196
- return this.getAllComments().length;
197
- }
198
-
199
- /**
200
- * Gets all unique authors who have made comments
201
- * @returns Array of unique author names
202
- */
203
- getAuthors(): string[] {
204
- const authorsSet = new Set<string>();
205
- for (const entry of this.comments.values()) {
206
- authorsSet.add(entry.comment.getAuthor());
207
- }
208
- return Array.from(authorsSet);
209
- }
210
-
211
- /**
212
- * Gets comments by author
213
- * @param author - Author name to filter by
214
- * @returns Array of comments by the specified author
215
- */
216
- getCommentsByAuthor(author: string): Comment[] {
217
- return Array.from(this.comments.values())
218
- .map(entry => entry.comment)
219
- .filter(comment => comment.getAuthor() === author);
220
- }
221
-
222
- /**
223
- * Gets comments within a date range
224
- * @param startDate - Start of date range
225
- * @param endDate - End of date range
226
- * @returns Array of comments within the date range
227
- */
228
- getCommentsByDateRange(startDate: Date, endDate: Date): Comment[] {
229
- return Array.from(this.comments.values())
230
- .map(entry => entry.comment)
231
- .filter(comment => {
232
- const commentDate = comment.getDate();
233
- return commentDate >= startDate && commentDate <= endDate;
234
- });
235
- }
236
-
237
- /**
238
- * Removes a comment
239
- * Also removes all replies to that comment
240
- * @param id - Comment ID
241
- * @returns True if the comment was removed
242
- */
243
- removeComment(id: number): boolean {
244
- const entry = this.comments.get(id);
245
- if (!entry) {
246
- return false;
247
- }
248
-
249
- // Remove all replies first
250
- for (const reply of entry.replies) {
251
- this.comments.delete(reply.getId());
252
- }
253
-
254
- // Remove the comment itself
255
- return this.comments.delete(id);
256
- }
257
-
258
- /**
259
- * Clears all comments
260
- */
261
- clear(): void {
262
- this.comments.clear();
263
- this.nextId = 0;
264
- }
265
-
266
- /**
267
- * Sets the next ID to be assigned.
268
- * Used when loading documents to avoid ID collisions with existing comments.
269
- * @param id - The next ID value to use
270
- */
271
- setNextId(id: number): void {
272
- this.nextId = id;
273
- }
274
-
275
- /**
276
- * Creates and registers a new comment
277
- * @param author - Comment author
278
- * @param content - Comment content (text or runs)
279
- * @param initials - Optional author initials
280
- * @returns The created and registered comment
281
- */
282
- createComment(
283
- author: string,
284
- content: string | Run | Run[],
285
- initials?: string
286
- ): Comment {
287
- const comment = Comment.create(author, content, initials);
288
- return this.register(comment);
289
- }
290
-
291
- /**
292
- * Creates and registers a reply to an existing comment
293
- * @param parentCommentId - ID of the parent comment
294
- * @param author - Reply author
295
- * @param content - Reply content (text or runs)
296
- * @param initials - Optional author initials
297
- * @returns The created and registered reply
298
- * @throws Error if parent comment doesn't exist
299
- */
300
- createReply(
301
- parentCommentId: number,
302
- author: string,
303
- content: string | Run | Run[],
304
- initials?: string
305
- ): Comment {
306
- // Verify parent exists
307
- if (!this.comments.has(parentCommentId)) {
308
- throw new Error(
309
- `Cannot create reply: parent comment with ID ${parentCommentId} does not exist`
310
- );
311
- }
312
-
313
- const reply = Comment.createReply(parentCommentId, author, content, initials);
314
- return this.register(reply);
315
- }
316
-
317
- /**
318
- * Checks if there are any comments
319
- * @returns True if there are no comments
320
- */
321
- isEmpty(): boolean {
322
- return this.comments.size === 0;
323
- }
324
-
325
- /**
326
- * Gets a comment thread (comment and all its replies)
327
- * @param commentId - ID of the top-level comment
328
- * @returns Object with the comment and its replies
329
- */
330
- getCommentThread(commentId: number): { comment: Comment; replies: Comment[] } | undefined {
331
- const entry = this.comments.get(commentId);
332
- if (!entry || entry.comment.isReply()) {
333
- return undefined;
334
- }
335
- return {
336
- comment: entry.comment,
337
- replies: [...entry.replies],
338
- };
339
- }
340
-
341
- /**
342
- * Searches comments by text content
343
- * @param searchText - Text to search for (case-insensitive)
344
- * @returns Array of comments containing the search text
345
- */
346
- findCommentsByText(searchText: string): Comment[] {
347
- const lowerSearch = searchText.toLowerCase();
348
- return Array.from(this.comments.values())
349
- .map(entry => entry.comment)
350
- .filter(comment => comment.getText().toLowerCase().includes(lowerSearch));
351
- }
352
-
353
- /**
354
- * Gets all resolved/done comments
355
- * @returns Array of resolved comments
356
- */
357
- getResolvedComments(): Comment[] {
358
- return Array.from(this.comments.values())
359
- .map(entry => entry.comment)
360
- .filter(comment => comment.isResolved());
361
- }
362
-
363
- /**
364
- * Gets all unresolved comments
365
- * @returns Array of unresolved comments
366
- */
367
- getUnresolvedComments(): Comment[] {
368
- return Array.from(this.comments.values())
369
- .map(entry => entry.comment)
370
- .filter(comment => !comment.isResolved());
371
- }
372
-
373
- /**
374
- * Gets the most recent comments
375
- * @param count - Number of recent comments to return
376
- * @returns Array of most recent comments
377
- */
378
- getRecentComments(count: number): Comment[] {
379
- const allComments = this.getAllCommentsWithReplies();
380
- return allComments
381
- .sort((a, b) => b.getDate().getTime() - a.getDate().getTime())
382
- .slice(0, count);
383
- }
384
-
385
- /**
386
- * Gets statistics about comments
387
- * @returns Object with comment statistics
388
- */
389
- getStats(): {
390
- total: number;
391
- topLevel: number;
392
- replies: number;
393
- resolved: number;
394
- unresolved: number;
395
- authors: string[];
396
- nextId: number;
397
- } {
398
- const topLevel = this.getTopLevelCount();
399
- const resolved = this.getResolvedComments().length;
400
- return {
401
- total: this.comments.size,
402
- topLevel,
403
- replies: this.comments.size - topLevel,
404
- resolved,
405
- unresolved: this.comments.size - resolved,
406
- authors: this.getAuthors(),
407
- nextId: this.nextId,
408
- };
409
- }
410
-
411
- /**
412
- * Generates the word/comments.xml file content
413
- * @returns XML string for comments.xml
414
- */
415
- generateCommentsXml(): string {
416
- const comments = this.getAllCommentsWithReplies();
417
-
418
- if (comments.length === 0) {
419
- // Return minimal comments.xml
420
- return `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
421
- <w:comments xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
422
- </w:comments>`;
423
- }
424
-
425
- // Build XML manually for comments
426
- const hasReplies = comments.some(c => c.isReply());
427
- let xml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n';
428
- xml += '<w:comments xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"';
429
- xml += ' xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"';
430
- if (hasReplies) {
431
- xml += ' xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml"';
432
- xml += ' xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="w15"';
433
- }
434
- xml += '>\n';
435
-
436
- // Add each comment
437
- for (const comment of comments) {
438
- xml += this.commentToXmlString(comment);
439
- }
440
-
441
- xml += '</w:comments>';
442
- return xml;
443
- }
444
-
445
- /**
446
- * Converts a comment to XML string
447
- * @param comment - Comment to convert
448
- * @returns XML string for the comment
449
- */
450
- private commentToXmlString(comment: Comment): string {
451
- let xml = ` <w:comment w:id="${comment.getId()}"`;
452
- xml += ` w:author="${XMLBuilder.escapeXmlAttribute(comment.getAuthor())}"`;
453
- xml += ` w:date="${formatDateForXml(comment.getDate())}"`;
454
- xml += ` w:initials="${XMLBuilder.escapeXmlAttribute(comment.getInitials())}"`;
455
-
456
- if (comment.isReply() && comment.getParentId() !== undefined) {
457
- xml += ` w15:parentId="${comment.getParentId()}"`;
458
- }
459
-
460
- // Add done attribute for resolved comments (per ECMA-376)
461
- if (comment.isResolved()) {
462
- xml += ` w:done="1"`;
463
- }
464
-
465
- xml += '>\n';
466
-
467
- // Add paragraph with runs
468
- xml += ' <w:p>\n';
469
- for (const run of comment.getRuns()) {
470
- xml += this.runToXmlString(run, 6);
471
- }
472
- xml += ' </w:p>\n';
473
-
474
- xml += ' </w:comment>\n';
475
- return xml;
476
- }
477
-
478
- /**
479
- * Converts a run to XML string
480
- * @param run - Run to convert
481
- * @param indent - Number of spaces for indentation
482
- * @returns XML string for the run
483
- */
484
- private runToXmlString(run: Run, indent: number): string {
485
- const spaces = ' '.repeat(indent);
486
- const text = XMLBuilder.escapeXmlText(run.getText());
487
-
488
- let xml = `${spaces}<w:r>\n`;
489
- xml += `${spaces} <w:t xml:space="preserve">${text}</w:t>\n`;
490
- xml += `${spaces}</w:r>\n`;
491
-
492
- return xml;
493
- }
494
-
495
- /**
496
- * Creates a new CommentManager
497
- * @returns New CommentManager instance
498
- */
499
- static create(): CommentManager {
500
- return new CommentManager();
501
- }
502
- }
1
+ /**
2
+ * CommentManager - Manages comments in a document
3
+ *
4
+ * Tracks all comments, assigns unique IDs, handles replies,
5
+ * and generates the comments.xml file.
6
+ *
7
+ * Per ECMA-376, comment IDs must be unique across ALL annotation types
8
+ * in a document. Use setIdProvider() to connect to a centralized ID allocator.
9
+ */
10
+
11
+ import { Comment } from './Comment';
12
+ import { Run } from './Run';
13
+ import { XMLBuilder } from '../xml/XMLBuilder';
14
+ import { formatDateForXml } from '../utils/dateFormatting';
15
+
16
+ /**
17
+ * Type for the centralized ID provider callback.
18
+ * Returns the next available annotation ID from a shared counter.
19
+ */
20
+ export type IdProviderCallback = () => number;
21
+
22
+ /**
23
+ * Type for callback to notify of existing IDs (for synchronization).
24
+ * Called when registering existing comments to keep the central counter in sync.
25
+ */
26
+ export type IdExistsCallback = (existingId: number) => void;
27
+
28
+ /**
29
+ * Comment entry stored by the manager
30
+ */
31
+ interface CommentEntry {
32
+ comment: Comment;
33
+ /** Comments that are replies to this comment */
34
+ replies: Comment[];
35
+ }
36
+
37
+ /**
38
+ * Manages document comments
39
+ */
40
+ export class CommentManager {
41
+ private comments = new Map<number, CommentEntry>();
42
+ private nextId = 0;
43
+ private idProvider: IdProviderCallback | null = null;
44
+ private idExistsNotifier: IdExistsCallback | null = null;
45
+
46
+ /**
47
+ * Sets the centralized ID provider callback.
48
+ * When set, IDs will be allocated from the centralized DocumentIdManager
49
+ * instead of the local nextId counter.
50
+ *
51
+ * @param provider - Callback that returns the next available ID
52
+ * @param existsNotifier - Optional callback to notify when existing IDs are found
53
+ */
54
+ setIdProvider(provider: IdProviderCallback, existsNotifier?: IdExistsCallback): void {
55
+ this.idProvider = provider;
56
+ this.idExistsNotifier = existsNotifier || null;
57
+ }
58
+
59
+ /**
60
+ * Registers a comment with the manager
61
+ * Assigns a unique ID
62
+ * @param comment - Comment to register
63
+ * @returns The registered comment (same instance)
64
+ */
65
+ register(comment: Comment): Comment {
66
+ // Assign unique ID - use centralized provider if available
67
+ const id = this.idProvider ? this.idProvider() : this.nextId++;
68
+ comment.setId(id);
69
+
70
+ // Store comment
71
+ const entry: CommentEntry = {
72
+ comment,
73
+ replies: [],
74
+ };
75
+ this.comments.set(comment.getId(), entry);
76
+
77
+ // If this is a reply, add it to the parent's replies array
78
+ if (comment.isReply() && comment.getParentId() !== undefined) {
79
+ const parentEntry = this.comments.get(comment.getParentId()!);
80
+ if (parentEntry) {
81
+ parentEntry.replies.push(comment);
82
+ }
83
+ }
84
+
85
+ return comment;
86
+ }
87
+
88
+ /**
89
+ * Registers an existing comment (from parsing) with its pre-assigned ID.
90
+ * Unlike register(), this does NOT assign a new ID - the comment must already have one.
91
+ * Used when loading comments from an existing document.
92
+ * @param comment - Comment with ID already set
93
+ */
94
+ registerExisting(comment: Comment): void {
95
+ const id = comment.getId();
96
+
97
+ // Notify centralized ID manager if connected
98
+ if (this.idExistsNotifier) {
99
+ this.idExistsNotifier(id);
100
+ }
101
+
102
+ // Store comment
103
+ const entry: CommentEntry = {
104
+ comment,
105
+ replies: [],
106
+ };
107
+ this.comments.set(id, entry);
108
+
109
+ // Update local nextId if needed
110
+ if (id >= this.nextId) {
111
+ this.nextId = id + 1;
112
+ }
113
+ }
114
+
115
+ /**
116
+ * Links reply comments to their parents after all comments are parsed.
117
+ * Must be called after all comments are registered via registerExisting().
118
+ * This builds the reply arrays for each parent comment.
119
+ */
120
+ linkReplies(): void {
121
+ // Clear existing replies first for idempotency (safe to call multiple times)
122
+ for (const entry of this.comments.values()) {
123
+ entry.replies = [];
124
+ }
125
+ for (const entry of this.comments.values()) {
126
+ const comment = entry.comment;
127
+ if (comment.isReply() && comment.getParentId() !== undefined) {
128
+ const parentEntry = this.comments.get(comment.getParentId()!);
129
+ if (parentEntry) {
130
+ parentEntry.replies.push(comment);
131
+ }
132
+ }
133
+ }
134
+ }
135
+
136
+ /**
137
+ * Gets a comment by ID
138
+ * @param id - Comment ID
139
+ * @returns The comment, or undefined if not found
140
+ */
141
+ getComment(id: number): Comment | undefined {
142
+ return this.comments.get(id)?.comment;
143
+ }
144
+
145
+ /**
146
+ * Gets all comments (top-level only, not replies)
147
+ * @returns Array of all top-level comments
148
+ */
149
+ getAllComments(): Comment[] {
150
+ return Array.from(this.comments.values())
151
+ .filter((entry) => !entry.comment.isReply())
152
+ .map((entry) => entry.comment);
153
+ }
154
+
155
+ /**
156
+ * Gets all comments including replies
157
+ * @returns Array of all comments
158
+ */
159
+ getAllCommentsWithReplies(): Comment[] {
160
+ return Array.from(this.comments.values()).map((entry) => entry.comment);
161
+ }
162
+
163
+ /**
164
+ * Gets replies to a comment
165
+ * @param commentId - ID of the parent comment
166
+ * @returns Array of reply comments
167
+ */
168
+ getReplies(commentId: number): Comment[] {
169
+ const entry = this.comments.get(commentId);
170
+ return entry ? [...entry.replies] : [];
171
+ }
172
+
173
+ /**
174
+ * Checks if a comment has replies
175
+ * @param commentId - ID of the comment
176
+ * @returns True if the comment has replies
177
+ */
178
+ hasReplies(commentId: number): boolean {
179
+ const entry = this.comments.get(commentId);
180
+ return entry ? entry.replies.length > 0 : false;
181
+ }
182
+
183
+ /**
184
+ * Gets the number of comments (including replies)
185
+ * @returns Number of comments
186
+ */
187
+ getCount(): number {
188
+ return this.comments.size;
189
+ }
190
+
191
+ /**
192
+ * Gets the number of top-level comments (excluding replies)
193
+ * @returns Number of top-level comments
194
+ */
195
+ getTopLevelCount(): number {
196
+ return this.getAllComments().length;
197
+ }
198
+
199
+ /**
200
+ * Gets all unique authors who have made comments
201
+ * @returns Array of unique author names
202
+ */
203
+ getAuthors(): string[] {
204
+ const authorsSet = new Set<string>();
205
+ for (const entry of this.comments.values()) {
206
+ authorsSet.add(entry.comment.getAuthor());
207
+ }
208
+ return Array.from(authorsSet);
209
+ }
210
+
211
+ /**
212
+ * Gets comments by author
213
+ * @param author - Author name to filter by
214
+ * @returns Array of comments by the specified author
215
+ */
216
+ getCommentsByAuthor(author: string): Comment[] {
217
+ return Array.from(this.comments.values())
218
+ .map((entry) => entry.comment)
219
+ .filter((comment) => comment.getAuthor() === author);
220
+ }
221
+
222
+ /**
223
+ * Gets comments within a date range
224
+ * @param startDate - Start of date range
225
+ * @param endDate - End of date range
226
+ * @returns Array of comments within the date range
227
+ */
228
+ getCommentsByDateRange(startDate: Date, endDate: Date): Comment[] {
229
+ return Array.from(this.comments.values())
230
+ .map((entry) => entry.comment)
231
+ .filter((comment) => {
232
+ const commentDate = comment.getDate();
233
+ return commentDate >= startDate && commentDate <= endDate;
234
+ });
235
+ }
236
+
237
+ /**
238
+ * Removes a comment
239
+ * Also removes all replies to that comment
240
+ * @param id - Comment ID
241
+ * @returns True if the comment was removed
242
+ */
243
+ removeComment(id: number): boolean {
244
+ const entry = this.comments.get(id);
245
+ if (!entry) {
246
+ return false;
247
+ }
248
+
249
+ // Remove all replies first
250
+ for (const reply of entry.replies) {
251
+ this.comments.delete(reply.getId());
252
+ }
253
+
254
+ // Remove the comment itself
255
+ return this.comments.delete(id);
256
+ }
257
+
258
+ /**
259
+ * Clears all comments
260
+ */
261
+ clear(): void {
262
+ this.comments.clear();
263
+ this.nextId = 0;
264
+ }
265
+
266
+ /**
267
+ * Sets the next ID to be assigned.
268
+ * Used when loading documents to avoid ID collisions with existing comments.
269
+ * @param id - The next ID value to use
270
+ */
271
+ setNextId(id: number): void {
272
+ this.nextId = id;
273
+ }
274
+
275
+ /**
276
+ * Creates and registers a new comment
277
+ * @param author - Comment author
278
+ * @param content - Comment content (text or runs)
279
+ * @param initials - Optional author initials
280
+ * @returns The created and registered comment
281
+ */
282
+ createComment(author: string, content: string | Run | Run[], initials?: string): Comment {
283
+ const comment = Comment.create(author, content, initials);
284
+ return this.register(comment);
285
+ }
286
+
287
+ /**
288
+ * Creates and registers a reply to an existing comment
289
+ * @param parentCommentId - ID of the parent comment
290
+ * @param author - Reply author
291
+ * @param content - Reply content (text or runs)
292
+ * @param initials - Optional author initials
293
+ * @returns The created and registered reply
294
+ * @throws Error if parent comment doesn't exist
295
+ */
296
+ createReply(
297
+ parentCommentId: number,
298
+ author: string,
299
+ content: string | Run | Run[],
300
+ initials?: string
301
+ ): Comment {
302
+ // Verify parent exists
303
+ if (!this.comments.has(parentCommentId)) {
304
+ throw new Error(
305
+ `Cannot create reply: parent comment with ID ${parentCommentId} does not exist`
306
+ );
307
+ }
308
+
309
+ const reply = Comment.createReply(parentCommentId, author, content, initials);
310
+ return this.register(reply);
311
+ }
312
+
313
+ /**
314
+ * Checks if there are any comments
315
+ * @returns True if there are no comments
316
+ */
317
+ isEmpty(): boolean {
318
+ return this.comments.size === 0;
319
+ }
320
+
321
+ /**
322
+ * Gets a comment thread (comment and all its replies)
323
+ * @param commentId - ID of the top-level comment
324
+ * @returns Object with the comment and its replies
325
+ */
326
+ getCommentThread(commentId: number): { comment: Comment; replies: Comment[] } | undefined {
327
+ const entry = this.comments.get(commentId);
328
+ if (!entry || entry.comment.isReply()) {
329
+ return undefined;
330
+ }
331
+ return {
332
+ comment: entry.comment,
333
+ replies: [...entry.replies],
334
+ };
335
+ }
336
+
337
+ /**
338
+ * Searches comments by text content
339
+ * @param searchText - Text to search for (case-insensitive)
340
+ * @returns Array of comments containing the search text
341
+ */
342
+ findCommentsByText(searchText: string): Comment[] {
343
+ const lowerSearch = searchText.toLowerCase();
344
+ return Array.from(this.comments.values())
345
+ .map((entry) => entry.comment)
346
+ .filter((comment) => comment.getText().toLowerCase().includes(lowerSearch));
347
+ }
348
+
349
+ /**
350
+ * Gets all resolved/done comments
351
+ * @returns Array of resolved comments
352
+ */
353
+ getResolvedComments(): Comment[] {
354
+ return Array.from(this.comments.values())
355
+ .map((entry) => entry.comment)
356
+ .filter((comment) => comment.isResolved());
357
+ }
358
+
359
+ /**
360
+ * Gets all unresolved comments
361
+ * @returns Array of unresolved comments
362
+ */
363
+ getUnresolvedComments(): Comment[] {
364
+ return Array.from(this.comments.values())
365
+ .map((entry) => entry.comment)
366
+ .filter((comment) => !comment.isResolved());
367
+ }
368
+
369
+ /**
370
+ * Gets the most recent comments
371
+ * @param count - Number of recent comments to return
372
+ * @returns Array of most recent comments
373
+ */
374
+ getRecentComments(count: number): Comment[] {
375
+ const allComments = this.getAllCommentsWithReplies();
376
+ return allComments
377
+ .sort((a, b) => b.getDate().getTime() - a.getDate().getTime())
378
+ .slice(0, count);
379
+ }
380
+
381
+ /**
382
+ * Gets statistics about comments
383
+ * @returns Object with comment statistics
384
+ */
385
+ getStats(): {
386
+ total: number;
387
+ topLevel: number;
388
+ replies: number;
389
+ resolved: number;
390
+ unresolved: number;
391
+ authors: string[];
392
+ nextId: number;
393
+ } {
394
+ const topLevel = this.getTopLevelCount();
395
+ const resolved = this.getResolvedComments().length;
396
+ return {
397
+ total: this.comments.size,
398
+ topLevel,
399
+ replies: this.comments.size - topLevel,
400
+ resolved,
401
+ unresolved: this.comments.size - resolved,
402
+ authors: this.getAuthors(),
403
+ nextId: this.nextId,
404
+ };
405
+ }
406
+
407
+ /**
408
+ * Generates the word/comments.xml file content
409
+ * @returns XML string for comments.xml
410
+ */
411
+ generateCommentsXml(): string {
412
+ const comments = this.getAllCommentsWithReplies();
413
+
414
+ if (comments.length === 0) {
415
+ // Return minimal comments.xml
416
+ return `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
417
+ <w:comments xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
418
+ </w:comments>`;
419
+ }
420
+
421
+ // Build XML manually for comments
422
+ const hasReplies = comments.some((c) => c.isReply());
423
+ let xml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n';
424
+ xml += '<w:comments xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"';
425
+ xml += ' xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"';
426
+ if (hasReplies) {
427
+ xml += ' xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml"';
428
+ xml +=
429
+ ' xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="w15"';
430
+ }
431
+ xml += '>\n';
432
+
433
+ // Add each comment
434
+ for (const comment of comments) {
435
+ xml += this.commentToXmlString(comment);
436
+ }
437
+
438
+ xml += '</w:comments>';
439
+ return xml;
440
+ }
441
+
442
+ /**
443
+ * Converts a comment to XML string
444
+ * @param comment - Comment to convert
445
+ * @returns XML string for the comment
446
+ */
447
+ private commentToXmlString(comment: Comment): string {
448
+ let xml = ` <w:comment w:id="${comment.getId()}"`;
449
+ xml += ` w:author="${XMLBuilder.escapeXmlAttribute(comment.getAuthor())}"`;
450
+ xml += ` w:date="${formatDateForXml(comment.getDate())}"`;
451
+ xml += ` w:initials="${XMLBuilder.escapeXmlAttribute(comment.getInitials())}"`;
452
+
453
+ if (comment.isReply() && comment.getParentId() !== undefined) {
454
+ xml += ` w15:parentId="${comment.getParentId()}"`;
455
+ }
456
+
457
+ // Add done attribute for resolved comments (per ECMA-376)
458
+ if (comment.isResolved()) {
459
+ xml += ` w:done="1"`;
460
+ }
461
+
462
+ xml += '>\n';
463
+
464
+ // Add paragraph with runs
465
+ xml += ' <w:p>\n';
466
+ for (const run of comment.getRuns()) {
467
+ xml += this.runToXmlString(run, 6);
468
+ }
469
+ xml += ' </w:p>\n';
470
+
471
+ xml += ' </w:comment>\n';
472
+ return xml;
473
+ }
474
+
475
+ /**
476
+ * Converts a run to XML string
477
+ * @param run - Run to convert
478
+ * @param indent - Number of spaces for indentation
479
+ * @returns XML string for the run
480
+ */
481
+ private runToXmlString(run: Run, indent: number): string {
482
+ const spaces = ' '.repeat(indent);
483
+ const text = XMLBuilder.escapeXmlText(run.getText());
484
+
485
+ let xml = `${spaces}<w:r>\n`;
486
+ xml += `${spaces} <w:t xml:space="preserve">${text}</w:t>\n`;
487
+ xml += `${spaces}</w:r>\n`;
488
+
489
+ return xml;
490
+ }
491
+
492
+ /**
493
+ * Creates a new CommentManager
494
+ * @returns New CommentManager instance
495
+ */
496
+ static create(): CommentManager {
497
+ return new CommentManager();
498
+ }
499
+ }