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,372 +1,363 @@
1
- /**
2
- * DocumentValidator - Handles validation of document properties and content
3
- * Prevents security issues and data corruption
4
- */
5
-
6
- import { Paragraph } from '../elements/Paragraph';
7
- import { Table } from '../elements/Table';
8
- import { ImageManager } from '../elements/ImageManager';
9
- import { DocumentProperties } from './Document';
10
- import { BodyElement } from './DocumentContent';
11
- import { LIMITS } from '../constants/limits';
12
- import { defaultLogger } from '../utils/logger';
13
- import * as v8 from 'v8';
14
-
15
- /**
16
- * Memory validation options
17
- */
18
- export interface MemoryOptions {
19
- /** Maximum memory usage percentage (0-100) before throwing error. Default: 80 */
20
- maxMemoryUsagePercent?: number;
21
- /** Maximum absolute RSS (Resident Set Size) in MB. Default: 2048 (2GB) */
22
- maxRssMB?: number;
23
- /** Enable absolute RSS limit checking. Default: true */
24
- useAbsoluteLimit?: boolean;
25
- }
26
-
27
- /**
28
- * Size estimation result
29
- */
30
- export interface SizeEstimate {
31
- paragraphs: number;
32
- tables: number;
33
- images: number;
34
- estimatedXmlBytes: number;
35
- imageBytes: number;
36
- totalEstimatedBytes: number;
37
- totalEstimatedMB: number;
38
- warning?: string;
39
- }
40
-
41
- /**
42
- * DocumentValidator handles all validation logic
43
- */
44
- export class DocumentValidator {
45
- private maxMemoryUsagePercent: number;
46
- private maxRssMB: number;
47
- private useAbsoluteLimit: boolean;
48
-
49
- constructor(maxMemoryUsagePercent = 80, options: MemoryOptions = {}) {
50
- // Validate maxMemoryUsagePercent
51
- const memoryPercent = options.maxMemoryUsagePercent ?? maxMemoryUsagePercent;
52
- if (
53
- memoryPercent < 1 ||
54
- memoryPercent > 100 ||
55
- !Number.isFinite(memoryPercent)
56
- ) {
57
- throw new Error('maxMemoryUsagePercent must be between 1 and 100');
58
- }
59
- this.maxMemoryUsagePercent = memoryPercent;
60
- this.maxRssMB = options.maxRssMB ?? 2048; // Default 2GB
61
- this.useAbsoluteLimit = options.useAbsoluteLimit ?? true;
62
- }
63
-
64
- /**
65
- * Validates and sanitizes document properties
66
- * Prevents injection attacks and excessive memory usage
67
- * @param properties - Properties to validate
68
- * @returns Validated and sanitized properties
69
- */
70
- static validateProperties(properties: DocumentProperties): DocumentProperties {
71
- const validated: DocumentProperties = {};
72
-
73
- // Validate and truncate string properties
74
- if (properties.title !== undefined) {
75
- if (typeof properties.title !== 'string') {
76
- throw new Error('DocumentProperties.title must be a string');
77
- }
78
- if (properties.title.length > LIMITS.MAX_STRING_LENGTH) {
79
- throw new Error(
80
- `DocumentProperties.title exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
81
- );
82
- }
83
- validated.title = properties.title;
84
- }
85
-
86
- if (properties.subject !== undefined) {
87
- if (typeof properties.subject !== 'string') {
88
- throw new Error('DocumentProperties.subject must be a string');
89
- }
90
- if (properties.subject.length > LIMITS.MAX_STRING_LENGTH) {
91
- throw new Error(
92
- `DocumentProperties.subject exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
93
- );
94
- }
95
- validated.subject = properties.subject;
96
- }
97
-
98
- if (properties.creator !== undefined) {
99
- if (typeof properties.creator !== 'string') {
100
- throw new Error('DocumentProperties.creator must be a string');
101
- }
102
- if (properties.creator.length > LIMITS.MAX_STRING_LENGTH) {
103
- throw new Error(
104
- `DocumentProperties.creator exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
105
- );
106
- }
107
- validated.creator = properties.creator;
108
- }
109
-
110
- if (properties.keywords !== undefined) {
111
- if (typeof properties.keywords !== 'string') {
112
- throw new Error('DocumentProperties.keywords must be a string');
113
- }
114
- if (properties.keywords.length > LIMITS.MAX_STRING_LENGTH) {
115
- throw new Error(
116
- `DocumentProperties.keywords exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
117
- );
118
- }
119
- validated.keywords = properties.keywords;
120
- }
121
-
122
- if (properties.description !== undefined) {
123
- if (typeof properties.description !== 'string') {
124
- throw new Error('DocumentProperties.description must be a string');
125
- }
126
- if (properties.description.length > LIMITS.MAX_STRING_LENGTH) {
127
- throw new Error(
128
- `DocumentProperties.description exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
129
- );
130
- }
131
- validated.description = properties.description;
132
- }
133
-
134
- if (properties.lastModifiedBy !== undefined) {
135
- if (typeof properties.lastModifiedBy !== 'string') {
136
- throw new Error('DocumentProperties.lastModifiedBy must be a string');
137
- }
138
- if (properties.lastModifiedBy.length > LIMITS.MAX_STRING_LENGTH) {
139
- throw new Error(
140
- `DocumentProperties.lastModifiedBy exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
141
- );
142
- }
143
- validated.lastModifiedBy = properties.lastModifiedBy;
144
- }
145
-
146
- // Validate revision number
147
- if (properties.revision !== undefined) {
148
- if (
149
- typeof properties.revision !== 'number' ||
150
- !Number.isInteger(properties.revision)
151
- ) {
152
- throw new Error('DocumentProperties.revision must be an integer');
153
- }
154
- if (properties.revision < 0 || properties.revision > LIMITS.MAX_REVISION) {
155
- throw new Error(
156
- `DocumentProperties.revision must be between 0 and ${LIMITS.MAX_REVISION}`
157
- );
158
- }
159
- validated.revision = properties.revision;
160
- }
161
-
162
- // Validate dates
163
- if (properties.created !== undefined) {
164
- if (!(properties.created instanceof Date)) {
165
- throw new Error('DocumentProperties.created must be a Date object');
166
- }
167
- if (!Number.isFinite(properties.created.getTime())) {
168
- throw new Error('DocumentProperties.created is an invalid date');
169
- }
170
- validated.created = properties.created;
171
- }
172
-
173
- if (properties.modified !== undefined) {
174
- if (!(properties.modified instanceof Date)) {
175
- throw new Error('DocumentProperties.modified must be a Date object');
176
- }
177
- if (!Number.isFinite(properties.modified.getTime())) {
178
- throw new Error('DocumentProperties.modified is an invalid date');
179
- }
180
- validated.modified = properties.modified;
181
- }
182
-
183
- return validated;
184
- }
185
-
186
- /**
187
- * Validates that the document has meaningful content before saving
188
- * Warns if the document appears to be empty or corrupted
189
- */
190
- validateBeforeSave(bodyElements: BodyElement[]): void {
191
- const paragraphs = bodyElements.filter(
192
- (el): el is Paragraph => el instanceof Paragraph
193
- );
194
-
195
- if (paragraphs.length === 0) {
196
- defaultLogger.warn(
197
- '\nDocXML Save Warning:\n' +
198
- 'Document has no paragraphs. You are saving an empty document.\n'
199
- );
200
- return;
201
- }
202
-
203
- // Count runs with text
204
- let totalRuns = 0;
205
- let emptyRuns = 0;
206
-
207
- for (const para of paragraphs) {
208
- const runs = para.getRuns();
209
- totalRuns += runs.length;
210
-
211
- for (const run of runs) {
212
- if (run.getText().length === 0) {
213
- emptyRuns++;
214
- }
215
- }
216
- }
217
-
218
- if (totalRuns > 0) {
219
- const emptyPercentage = (emptyRuns / totalRuns) * 100;
220
-
221
- if (emptyPercentage > 90 && emptyRuns > 10) {
222
- defaultLogger.warn(
223
- '\nDocXML Save Warning:\n' +
224
- `You are about to save a document where ${emptyRuns} out of ${totalRuns} runs (${emptyPercentage.toFixed(1)}%) are empty.\n` +
225
- 'This may result in a document with no visible text content.\n' +
226
- 'If this is unintentional, please review the document before saving.\n'
227
- );
228
- }
229
- }
230
- }
231
-
232
- /**
233
- * Checks current memory usage and throws if above threshold
234
- * Prevents out-of-memory errors by failing early
235
- * Uses both heap percentage and absolute RSS limits for better accuracy
236
- * @throws {Error} If memory usage exceeds configured limits
237
- */
238
- checkMemoryThreshold(): void {
239
- const { heapUsed, external, rss } = process.memoryUsage();
240
- const heapStats = v8.getHeapStatistics();
241
- const heapLimit = heapStats.heap_size_limit; // Actual max heap (typically 4GB on 64-bit)
242
-
243
- // Calculate heap usage percentage against the actual limit, not currently allocated
244
- const heapPercent = (heapUsed / heapLimit) * 100;
245
- const heapMB = heapUsed / (1024 * 1024);
246
- const heapLimitMB = heapLimit / (1024 * 1024);
247
-
248
- // Calculate RSS (Resident Set Size - actual memory used by process)
249
- const rssMB = rss / (1024 * 1024);
250
- const externalMB = external / (1024 * 1024);
251
-
252
- // Check heap percentage (protects against heap fragmentation)
253
- const heapExceeded = heapPercent > this.maxMemoryUsagePercent;
254
-
255
- // Check absolute RSS limit (protects against excessive total memory)
256
- const rssExceeded = this.useAbsoluteLimit && rssMB > this.maxRssMB;
257
-
258
- // Only throw if BOTH conditions are true (avoids false positives)
259
- if (heapExceeded && rssExceeded) {
260
- throw new Error(
261
- `Memory usage critical:\n` +
262
- ` Heap: ${heapMB.toFixed(0)}MB / ${heapLimitMB.toFixed(0)}MB (${heapPercent.toFixed(1)}%)\n` +
263
- ` RSS: ${rssMB.toFixed(0)}MB (limit: ${this.maxRssMB}MB)\n` +
264
- ` External: ${externalMB.toFixed(0)}MB\n` +
265
- `Cannot process document safely. Consider:\n` +
266
- ` - Reducing document size (remove/compress images)\n` +
267
- ` - Splitting into multiple documents\n` +
268
- ` - Increasing memory limits in DocumentOptions\n` +
269
- ` - Increasing Node.js heap size (--max-old-space-size)`
270
- );
271
- }
272
-
273
- // Warn if only heap exceeded (might be temporary fragmentation)
274
- if (heapExceeded && !rssExceeded && this.useAbsoluteLimit) {
275
- defaultLogger.warn(
276
- `DocXML Memory Warning: Heap usage high (${heapPercent.toFixed(1)}%) ` +
277
- `but RSS (${rssMB.toFixed(0)}MB) is below limit. ` +
278
- `This might be temporary heap fragmentation.`
279
- );
280
- }
281
- }
282
-
283
- /**
284
- * Estimates the size of the document
285
- * Provides breakdown by component and warnings if size is too large
286
- * @returns Size estimation with breakdown and optional warning
287
- */
288
- estimateSize(bodyElements: BodyElement[], imageManager: ImageManager): SizeEstimate {
289
- // Count elements
290
- const paragraphs = bodyElements.filter(
291
- (el): el is Paragraph => el instanceof Paragraph
292
- );
293
- const tables = bodyElements.filter((el): el is Table => el instanceof Table);
294
- const paragraphCount = paragraphs.length;
295
- const tableCount = tables.length;
296
- const imageCount = imageManager.getImageCount();
297
-
298
- // Estimate XML size using documented constants
299
- const estimatedXml = paragraphCount * LIMITS.BYTES_PER_PARAGRAPH +
300
- tableCount * LIMITS.BYTES_PER_TABLE +
301
- LIMITS.BASE_STRUCTURE_BYTES;
302
-
303
- // Get actual image sizes
304
- const imageBytes = imageManager.getTotalSize();
305
-
306
- // Total estimate
307
- const totalBytes = estimatedXml + imageBytes;
308
- const totalMB = totalBytes / (1024 * 1024);
309
-
310
- // Use documented threshold constants
311
- let warning: string | undefined;
312
-
313
- if (totalMB > LIMITS.ERROR_SIZE_MB) {
314
- warning =
315
- `Document size (${totalMB.toFixed(1)}MB) exceeds recommended maximum of ${LIMITS.ERROR_SIZE_MB}MB. ` +
316
- `This may cause memory issues. Consider splitting into multiple documents or optimizing images.`;
317
- } else if (totalMB > LIMITS.WARNING_SIZE_MB) {
318
- warning =
319
- `Document size (${totalMB.toFixed(1)}MB) exceeds ${LIMITS.WARNING_SIZE_MB}MB. ` +
320
- `Large documents may take longer to process and use significant memory.`;
321
- }
322
-
323
- return {
324
- paragraphs: paragraphCount,
325
- tables: tableCount,
326
- images: imageCount,
327
- estimatedXmlBytes: estimatedXml,
328
- imageBytes,
329
- totalEstimatedBytes: totalBytes,
330
- totalEstimatedMB: parseFloat(totalMB.toFixed(2)),
331
- warning,
332
- };
333
- }
334
-
335
- /**
336
- * Gets size statistics for the document
337
- * @returns Size statistics
338
- */
339
- getSizeStats(bodyElements: BodyElement[], imageManager: ImageManager): {
340
- elements: { paragraphs: number; tables: number; images: number };
341
- size: { xml: string; images: string; total: string };
342
- warnings: string[];
343
- } {
344
- const estimate = this.estimateSize(bodyElements, imageManager);
345
- const warnings: string[] = [];
346
-
347
- if (estimate.warning) {
348
- warnings.push(estimate.warning);
349
- }
350
-
351
- // Format sizes for display
352
- const formatBytes = (bytes: number): string => {
353
- if (bytes < 1024) return `${bytes} B`;
354
- if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
355
- return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
356
- };
357
-
358
- return {
359
- elements: {
360
- paragraphs: estimate.paragraphs,
361
- tables: estimate.tables,
362
- images: estimate.images,
363
- },
364
- size: {
365
- xml: formatBytes(estimate.estimatedXmlBytes),
366
- images: formatBytes(estimate.imageBytes),
367
- total: formatBytes(estimate.totalEstimatedBytes),
368
- },
369
- warnings,
370
- };
371
- }
372
- }
1
+ /**
2
+ * DocumentValidator - Handles validation of document properties and content
3
+ * Prevents security issues and data corruption
4
+ */
5
+
6
+ import { Paragraph } from '../elements/Paragraph';
7
+ import { Table } from '../elements/Table';
8
+ import { ImageManager } from '../elements/ImageManager';
9
+ import { DocumentProperties } from './Document';
10
+ import { BodyElement } from './DocumentContent';
11
+ import { LIMITS } from '../constants/limits';
12
+ import { defaultLogger } from '../utils/logger';
13
+ import * as v8 from 'v8';
14
+
15
+ /**
16
+ * Memory validation options
17
+ */
18
+ export interface MemoryOptions {
19
+ /** Maximum memory usage percentage (0-100) before throwing error. Default: 80 */
20
+ maxMemoryUsagePercent?: number;
21
+ /** Maximum absolute RSS (Resident Set Size) in MB. Default: 2048 (2GB) */
22
+ maxRssMB?: number;
23
+ /** Enable absolute RSS limit checking. Default: true */
24
+ useAbsoluteLimit?: boolean;
25
+ }
26
+
27
+ /**
28
+ * Size estimation result
29
+ */
30
+ export interface SizeEstimate {
31
+ paragraphs: number;
32
+ tables: number;
33
+ images: number;
34
+ estimatedXmlBytes: number;
35
+ imageBytes: number;
36
+ totalEstimatedBytes: number;
37
+ totalEstimatedMB: number;
38
+ warning?: string;
39
+ }
40
+
41
+ /**
42
+ * DocumentValidator handles all validation logic
43
+ */
44
+ export class DocumentValidator {
45
+ private maxMemoryUsagePercent: number;
46
+ private maxRssMB: number;
47
+ private useAbsoluteLimit: boolean;
48
+
49
+ constructor(maxMemoryUsagePercent = 80, options: MemoryOptions = {}) {
50
+ // Validate maxMemoryUsagePercent
51
+ const memoryPercent = options.maxMemoryUsagePercent ?? maxMemoryUsagePercent;
52
+ if (memoryPercent < 1 || memoryPercent > 100 || !Number.isFinite(memoryPercent)) {
53
+ throw new Error('maxMemoryUsagePercent must be between 1 and 100');
54
+ }
55
+ this.maxMemoryUsagePercent = memoryPercent;
56
+ this.maxRssMB = options.maxRssMB ?? 2048; // Default 2GB
57
+ this.useAbsoluteLimit = options.useAbsoluteLimit ?? true;
58
+ }
59
+
60
+ /**
61
+ * Validates and sanitizes document properties
62
+ * Prevents injection attacks and excessive memory usage
63
+ * @param properties - Properties to validate
64
+ * @returns Validated and sanitized properties
65
+ */
66
+ static validateProperties(properties: DocumentProperties): DocumentProperties {
67
+ const validated: DocumentProperties = {};
68
+
69
+ // Validate and truncate string properties
70
+ if (properties.title !== undefined) {
71
+ if (typeof properties.title !== 'string') {
72
+ throw new Error('DocumentProperties.title must be a string');
73
+ }
74
+ if (properties.title.length > LIMITS.MAX_STRING_LENGTH) {
75
+ throw new Error(
76
+ `DocumentProperties.title exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
77
+ );
78
+ }
79
+ validated.title = properties.title;
80
+ }
81
+
82
+ if (properties.subject !== undefined) {
83
+ if (typeof properties.subject !== 'string') {
84
+ throw new Error('DocumentProperties.subject must be a string');
85
+ }
86
+ if (properties.subject.length > LIMITS.MAX_STRING_LENGTH) {
87
+ throw new Error(
88
+ `DocumentProperties.subject exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
89
+ );
90
+ }
91
+ validated.subject = properties.subject;
92
+ }
93
+
94
+ if (properties.creator !== undefined) {
95
+ if (typeof properties.creator !== 'string') {
96
+ throw new Error('DocumentProperties.creator must be a string');
97
+ }
98
+ if (properties.creator.length > LIMITS.MAX_STRING_LENGTH) {
99
+ throw new Error(
100
+ `DocumentProperties.creator exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
101
+ );
102
+ }
103
+ validated.creator = properties.creator;
104
+ }
105
+
106
+ if (properties.keywords !== undefined) {
107
+ if (typeof properties.keywords !== 'string') {
108
+ throw new Error('DocumentProperties.keywords must be a string');
109
+ }
110
+ if (properties.keywords.length > LIMITS.MAX_STRING_LENGTH) {
111
+ throw new Error(
112
+ `DocumentProperties.keywords exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
113
+ );
114
+ }
115
+ validated.keywords = properties.keywords;
116
+ }
117
+
118
+ if (properties.description !== undefined) {
119
+ if (typeof properties.description !== 'string') {
120
+ throw new Error('DocumentProperties.description must be a string');
121
+ }
122
+ if (properties.description.length > LIMITS.MAX_STRING_LENGTH) {
123
+ throw new Error(
124
+ `DocumentProperties.description exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
125
+ );
126
+ }
127
+ validated.description = properties.description;
128
+ }
129
+
130
+ if (properties.lastModifiedBy !== undefined) {
131
+ if (typeof properties.lastModifiedBy !== 'string') {
132
+ throw new Error('DocumentProperties.lastModifiedBy must be a string');
133
+ }
134
+ if (properties.lastModifiedBy.length > LIMITS.MAX_STRING_LENGTH) {
135
+ throw new Error(
136
+ `DocumentProperties.lastModifiedBy exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`
137
+ );
138
+ }
139
+ validated.lastModifiedBy = properties.lastModifiedBy;
140
+ }
141
+
142
+ // Validate revision number
143
+ if (properties.revision !== undefined) {
144
+ if (typeof properties.revision !== 'number' || !Number.isInteger(properties.revision)) {
145
+ throw new Error('DocumentProperties.revision must be an integer');
146
+ }
147
+ if (properties.revision < 0 || properties.revision > LIMITS.MAX_REVISION) {
148
+ throw new Error(`DocumentProperties.revision must be between 0 and ${LIMITS.MAX_REVISION}`);
149
+ }
150
+ validated.revision = properties.revision;
151
+ }
152
+
153
+ // Validate dates
154
+ if (properties.created !== undefined) {
155
+ if (!(properties.created instanceof Date)) {
156
+ throw new Error('DocumentProperties.created must be a Date object');
157
+ }
158
+ if (!Number.isFinite(properties.created.getTime())) {
159
+ throw new Error('DocumentProperties.created is an invalid date');
160
+ }
161
+ validated.created = properties.created;
162
+ }
163
+
164
+ if (properties.modified !== undefined) {
165
+ if (!(properties.modified instanceof Date)) {
166
+ throw new Error('DocumentProperties.modified must be a Date object');
167
+ }
168
+ if (!Number.isFinite(properties.modified.getTime())) {
169
+ throw new Error('DocumentProperties.modified is an invalid date');
170
+ }
171
+ validated.modified = properties.modified;
172
+ }
173
+
174
+ return validated;
175
+ }
176
+
177
+ /**
178
+ * Validates that the document has meaningful content before saving
179
+ * Warns if the document appears to be empty or corrupted
180
+ */
181
+ validateBeforeSave(bodyElements: BodyElement[]): void {
182
+ const paragraphs = bodyElements.filter((el): el is Paragraph => el instanceof Paragraph);
183
+
184
+ if (paragraphs.length === 0) {
185
+ defaultLogger.warn(
186
+ '\nDocXML Save Warning:\n' +
187
+ 'Document has no paragraphs. You are saving an empty document.\n'
188
+ );
189
+ return;
190
+ }
191
+
192
+ // Count runs with text
193
+ let totalRuns = 0;
194
+ let emptyRuns = 0;
195
+
196
+ for (const para of paragraphs) {
197
+ const runs = para.getRuns();
198
+ totalRuns += runs.length;
199
+
200
+ for (const run of runs) {
201
+ if (run.getText().length === 0) {
202
+ emptyRuns++;
203
+ }
204
+ }
205
+ }
206
+
207
+ if (totalRuns > 0) {
208
+ const emptyPercentage = (emptyRuns / totalRuns) * 100;
209
+
210
+ if (emptyPercentage > 90 && emptyRuns > 10) {
211
+ defaultLogger.warn(
212
+ '\nDocXML Save Warning:\n' +
213
+ `You are about to save a document where ${emptyRuns} out of ${totalRuns} runs (${emptyPercentage.toFixed(1)}%) are empty.\n` +
214
+ 'This may result in a document with no visible text content.\n' +
215
+ 'If this is unintentional, please review the document before saving.\n'
216
+ );
217
+ }
218
+ }
219
+ }
220
+
221
+ /**
222
+ * Checks current memory usage and throws if above threshold
223
+ * Prevents out-of-memory errors by failing early
224
+ * Uses both heap percentage and absolute RSS limits for better accuracy
225
+ * @throws {Error} If memory usage exceeds configured limits
226
+ */
227
+ checkMemoryThreshold(): void {
228
+ const { heapUsed, external, rss } = process.memoryUsage();
229
+ const heapStats = v8.getHeapStatistics();
230
+ const heapLimit = heapStats.heap_size_limit; // Actual max heap (typically 4GB on 64-bit)
231
+
232
+ // Calculate heap usage percentage against the actual limit, not currently allocated
233
+ const heapPercent = (heapUsed / heapLimit) * 100;
234
+ const heapMB = heapUsed / (1024 * 1024);
235
+ const heapLimitMB = heapLimit / (1024 * 1024);
236
+
237
+ // Calculate RSS (Resident Set Size - actual memory used by process)
238
+ const rssMB = rss / (1024 * 1024);
239
+ const externalMB = external / (1024 * 1024);
240
+
241
+ // Check heap percentage (protects against heap fragmentation)
242
+ const heapExceeded = heapPercent > this.maxMemoryUsagePercent;
243
+
244
+ // Check absolute RSS limit (protects against excessive total memory)
245
+ const rssExceeded = this.useAbsoluteLimit && rssMB > this.maxRssMB;
246
+
247
+ // Only throw if BOTH conditions are true (avoids false positives)
248
+ if (heapExceeded && rssExceeded) {
249
+ throw new Error(
250
+ `Memory usage critical:\n` +
251
+ ` Heap: ${heapMB.toFixed(0)}MB / ${heapLimitMB.toFixed(0)}MB (${heapPercent.toFixed(1)}%)\n` +
252
+ ` RSS: ${rssMB.toFixed(0)}MB (limit: ${this.maxRssMB}MB)\n` +
253
+ ` External: ${externalMB.toFixed(0)}MB\n` +
254
+ `Cannot process document safely. Consider:\n` +
255
+ ` - Reducing document size (remove/compress images)\n` +
256
+ ` - Splitting into multiple documents\n` +
257
+ ` - Increasing memory limits in DocumentOptions\n` +
258
+ ` - Increasing Node.js heap size (--max-old-space-size)`
259
+ );
260
+ }
261
+
262
+ // Warn if only heap exceeded (might be temporary fragmentation)
263
+ if (heapExceeded && !rssExceeded && this.useAbsoluteLimit) {
264
+ defaultLogger.warn(
265
+ `DocXML Memory Warning: Heap usage high (${heapPercent.toFixed(1)}%) ` +
266
+ `but RSS (${rssMB.toFixed(0)}MB) is below limit. ` +
267
+ `This might be temporary heap fragmentation.`
268
+ );
269
+ }
270
+ }
271
+
272
+ /**
273
+ * Estimates the size of the document
274
+ * Provides breakdown by component and warnings if size is too large
275
+ * @returns Size estimation with breakdown and optional warning
276
+ */
277
+ estimateSize(bodyElements: BodyElement[], imageManager: ImageManager): SizeEstimate {
278
+ // Count elements
279
+ const paragraphs = bodyElements.filter((el): el is Paragraph => el instanceof Paragraph);
280
+ const tables = bodyElements.filter((el): el is Table => el instanceof Table);
281
+ const paragraphCount = paragraphs.length;
282
+ const tableCount = tables.length;
283
+ const imageCount = imageManager.getImageCount();
284
+
285
+ // Estimate XML size using documented constants
286
+ const estimatedXml =
287
+ paragraphCount * LIMITS.BYTES_PER_PARAGRAPH +
288
+ tableCount * LIMITS.BYTES_PER_TABLE +
289
+ LIMITS.BASE_STRUCTURE_BYTES;
290
+
291
+ // Get actual image sizes
292
+ const imageBytes = imageManager.getTotalSize();
293
+
294
+ // Total estimate
295
+ const totalBytes = estimatedXml + imageBytes;
296
+ const totalMB = totalBytes / (1024 * 1024);
297
+
298
+ // Use documented threshold constants
299
+ let warning: string | undefined;
300
+
301
+ if (totalMB > LIMITS.ERROR_SIZE_MB) {
302
+ warning =
303
+ `Document size (${totalMB.toFixed(1)}MB) exceeds recommended maximum of ${LIMITS.ERROR_SIZE_MB}MB. ` +
304
+ `This may cause memory issues. Consider splitting into multiple documents or optimizing images.`;
305
+ } else if (totalMB > LIMITS.WARNING_SIZE_MB) {
306
+ warning =
307
+ `Document size (${totalMB.toFixed(1)}MB) exceeds ${LIMITS.WARNING_SIZE_MB}MB. ` +
308
+ `Large documents may take longer to process and use significant memory.`;
309
+ }
310
+
311
+ return {
312
+ paragraphs: paragraphCount,
313
+ tables: tableCount,
314
+ images: imageCount,
315
+ estimatedXmlBytes: estimatedXml,
316
+ imageBytes,
317
+ totalEstimatedBytes: totalBytes,
318
+ totalEstimatedMB: parseFloat(totalMB.toFixed(2)),
319
+ warning,
320
+ };
321
+ }
322
+
323
+ /**
324
+ * Gets size statistics for the document
325
+ * @returns Size statistics
326
+ */
327
+ getSizeStats(
328
+ bodyElements: BodyElement[],
329
+ imageManager: ImageManager
330
+ ): {
331
+ elements: { paragraphs: number; tables: number; images: number };
332
+ size: { xml: string; images: string; total: string };
333
+ warnings: string[];
334
+ } {
335
+ const estimate = this.estimateSize(bodyElements, imageManager);
336
+ const warnings: string[] = [];
337
+
338
+ if (estimate.warning) {
339
+ warnings.push(estimate.warning);
340
+ }
341
+
342
+ // Format sizes for display
343
+ const formatBytes = (bytes: number): string => {
344
+ if (bytes < 1024) return `${bytes} B`;
345
+ if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
346
+ return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
347
+ };
348
+
349
+ return {
350
+ elements: {
351
+ paragraphs: estimate.paragraphs,
352
+ tables: estimate.tables,
353
+ images: estimate.images,
354
+ },
355
+ size: {
356
+ xml: formatBytes(estimate.estimatedXmlBytes),
357
+ images: formatBytes(estimate.imageBytes),
358
+ total: formatBytes(estimate.totalEstimatedBytes),
359
+ },
360
+ warnings,
361
+ };
362
+ }
363
+ }