docxmlater 10.4.0 → 11.0.4
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.
- package/README.md +3 -3
- package/dist/constants/legacyCompatFlags.d.ts +1 -1
- package/dist/constants/legacyCompatFlags.d.ts.map +1 -1
- package/dist/constants/legacyCompatFlags.js.map +1 -1
- package/dist/core/Document.d.ts +75 -67
- package/dist/core/Document.d.ts.map +1 -1
- package/dist/core/Document.js +618 -414
- package/dist/core/Document.js.map +1 -1
- package/dist/core/DocumentContent.d.ts +11 -10
- package/dist/core/DocumentContent.d.ts.map +1 -1
- package/dist/core/DocumentContent.js +19 -19
- package/dist/core/DocumentContent.js.map +1 -1
- package/dist/core/DocumentEvents.d.ts +39 -0
- package/dist/core/DocumentEvents.d.ts.map +1 -0
- package/dist/core/DocumentEvents.js +51 -0
- package/dist/core/DocumentEvents.js.map +1 -0
- package/dist/core/DocumentGenerator.d.ts +11 -11
- package/dist/core/DocumentGenerator.d.ts.map +1 -1
- package/dist/core/DocumentGenerator.js +72 -52
- package/dist/core/DocumentGenerator.js.map +1 -1
- package/dist/core/DocumentParser.d.ts +15 -15
- package/dist/core/DocumentParser.d.ts.map +1 -1
- package/dist/core/DocumentParser.js +2100 -1076
- package/dist/core/DocumentParser.js.map +1 -1
- package/dist/core/DocumentValidator.d.ts +3 -3
- package/dist/core/DocumentValidator.d.ts.map +1 -1
- package/dist/core/DocumentValidator.js +31 -31
- package/dist/core/DocumentValidator.js.map +1 -1
- package/dist/core/ElementRegistry.d.ts +22 -0
- package/dist/core/ElementRegistry.d.ts.map +1 -0
- package/dist/core/ElementRegistry.js +27 -0
- package/dist/core/ElementRegistry.js.map +1 -0
- package/dist/core/Relationship.js +4 -4
- package/dist/core/Relationship.js.map +1 -1
- package/dist/core/RelationshipManager.d.ts +1 -1
- package/dist/core/RelationshipManager.d.ts.map +1 -1
- package/dist/core/RelationshipManager.js +32 -32
- package/dist/core/RelationshipManager.js.map +1 -1
- package/dist/elements/AlternateContent.d.ts +1 -1
- package/dist/elements/AlternateContent.d.ts.map +1 -1
- package/dist/elements/AlternateContent.js.map +1 -1
- package/dist/elements/Bookmark.d.ts +6 -1
- package/dist/elements/Bookmark.d.ts.map +1 -1
- package/dist/elements/Bookmark.js +19 -3
- package/dist/elements/Bookmark.js.map +1 -1
- package/dist/elements/BookmarkManager.d.ts +1 -1
- package/dist/elements/BookmarkManager.d.ts.map +1 -1
- package/dist/elements/BookmarkManager.js +7 -7
- package/dist/elements/BookmarkManager.js.map +1 -1
- package/dist/elements/Comment.d.ts +2 -2
- package/dist/elements/Comment.d.ts.map +1 -1
- package/dist/elements/Comment.js +4 -4
- package/dist/elements/Comment.js.map +1 -1
- package/dist/elements/CommentManager.d.ts +2 -2
- package/dist/elements/CommentManager.d.ts.map +1 -1
- package/dist/elements/CommentManager.js +9 -9
- package/dist/elements/CommentManager.js.map +1 -1
- package/dist/elements/CommonTypes.d.ts +9 -4
- package/dist/elements/CommonTypes.d.ts.map +1 -1
- package/dist/elements/CommonTypes.js +1 -0
- package/dist/elements/CommonTypes.js.map +1 -1
- package/dist/elements/CustomXml.d.ts +1 -1
- package/dist/elements/CustomXml.d.ts.map +1 -1
- package/dist/elements/CustomXml.js.map +1 -1
- package/dist/elements/Endnote.d.ts +2 -2
- package/dist/elements/Endnote.d.ts.map +1 -1
- package/dist/elements/Endnote.js +9 -9
- package/dist/elements/Endnote.js.map +1 -1
- package/dist/elements/EndnoteManager.d.ts +1 -1
- package/dist/elements/EndnoteManager.d.ts.map +1 -1
- package/dist/elements/EndnoteManager.js +11 -11
- package/dist/elements/EndnoteManager.js.map +1 -1
- package/dist/elements/Field.d.ts +9 -5
- package/dist/elements/Field.d.ts.map +1 -1
- package/dist/elements/Field.js +21 -9
- package/dist/elements/Field.js.map +1 -1
- package/dist/elements/FieldHelpers.d.ts +1 -1
- package/dist/elements/FieldHelpers.d.ts.map +1 -1
- package/dist/elements/FieldHelpers.js +10 -10
- package/dist/elements/FieldHelpers.js.map +1 -1
- package/dist/elements/Footer.d.ts +3 -3
- package/dist/elements/Footer.d.ts.map +1 -1
- package/dist/elements/Footer.js +5 -5
- package/dist/elements/Footer.js.map +1 -1
- package/dist/elements/Footnote.d.ts +2 -2
- package/dist/elements/Footnote.d.ts.map +1 -1
- package/dist/elements/Footnote.js +9 -9
- package/dist/elements/Footnote.js.map +1 -1
- package/dist/elements/FootnoteManager.d.ts +1 -1
- package/dist/elements/FootnoteManager.d.ts.map +1 -1
- package/dist/elements/FootnoteManager.js +11 -11
- package/dist/elements/FootnoteManager.js.map +1 -1
- package/dist/elements/Header.d.ts +3 -3
- package/dist/elements/Header.d.ts.map +1 -1
- package/dist/elements/Header.js +5 -5
- package/dist/elements/Header.js.map +1 -1
- package/dist/elements/HeaderFooterManager.d.ts +2 -2
- package/dist/elements/HeaderFooterManager.d.ts.map +1 -1
- package/dist/elements/HeaderFooterManager.js.map +1 -1
- package/dist/elements/Hyperlink.d.ts +5 -5
- package/dist/elements/Hyperlink.d.ts.map +1 -1
- package/dist/elements/Hyperlink.js +29 -29
- package/dist/elements/Hyperlink.js.map +1 -1
- package/dist/elements/Image.d.ts +1 -1
- package/dist/elements/Image.d.ts.map +1 -1
- package/dist/elements/Image.js +67 -67
- package/dist/elements/Image.js.map +1 -1
- package/dist/elements/ImageManager.d.ts +1 -1
- package/dist/elements/ImageManager.d.ts.map +1 -1
- package/dist/elements/ImageManager.js +4 -4
- package/dist/elements/ImageManager.js.map +1 -1
- package/dist/elements/ImageRun.d.ts +3 -3
- package/dist/elements/ImageRun.d.ts.map +1 -1
- package/dist/elements/ImageRun.js +2 -2
- package/dist/elements/ImageRun.js.map +1 -1
- package/dist/elements/MathElement.d.ts +1 -1
- package/dist/elements/MathElement.d.ts.map +1 -1
- package/dist/elements/MathElement.js.map +1 -1
- package/dist/elements/Paragraph.d.ts +34 -19
- package/dist/elements/Paragraph.d.ts.map +1 -1
- package/dist/elements/Paragraph.js +286 -231
- package/dist/elements/Paragraph.js.map +1 -1
- package/dist/elements/PreservedElement.d.ts +1 -1
- package/dist/elements/PreservedElement.d.ts.map +1 -1
- package/dist/elements/PreservedElement.js.map +1 -1
- package/dist/elements/PropertyChangeTypes.d.ts +2 -2
- package/dist/elements/PropertyChangeTypes.d.ts.map +1 -1
- package/dist/elements/PropertyChangeTypes.js.map +1 -1
- package/dist/elements/RangeMarker.d.ts +14 -1
- package/dist/elements/RangeMarker.d.ts.map +1 -1
- package/dist/elements/RangeMarker.js +46 -8
- package/dist/elements/RangeMarker.js.map +1 -1
- package/dist/elements/RegisteredBodyElement.d.ts +15 -0
- package/dist/elements/RegisteredBodyElement.d.ts.map +1 -0
- package/dist/elements/RegisteredBodyElement.js +44 -0
- package/dist/elements/RegisteredBodyElement.js.map +1 -0
- package/dist/elements/Revision.d.ts +8 -8
- package/dist/elements/Revision.d.ts.map +1 -1
- package/dist/elements/Revision.js +12 -12
- package/dist/elements/Revision.js.map +1 -1
- package/dist/elements/RevisionContent.d.ts +3 -3
- package/dist/elements/RevisionContent.d.ts.map +1 -1
- package/dist/elements/RevisionContent.js.map +1 -1
- package/dist/elements/RevisionManager.d.ts +2 -2
- package/dist/elements/RevisionManager.d.ts.map +1 -1
- package/dist/elements/RevisionManager.js +2 -2
- package/dist/elements/RevisionManager.js.map +1 -1
- package/dist/elements/Run.d.ts +16 -10
- package/dist/elements/Run.d.ts.map +1 -1
- package/dist/elements/Run.js +199 -173
- package/dist/elements/Run.js.map +1 -1
- package/dist/elements/Section.d.ts +4 -2
- package/dist/elements/Section.d.ts.map +1 -1
- package/dist/elements/Section.js +152 -145
- package/dist/elements/Section.js.map +1 -1
- package/dist/elements/Shape.d.ts +3 -3
- package/dist/elements/Shape.d.ts.map +1 -1
- package/dist/elements/Shape.js +12 -12
- package/dist/elements/Shape.js.map +1 -1
- package/dist/elements/StructuredDocumentTag.d.ts +3 -3
- package/dist/elements/StructuredDocumentTag.d.ts.map +1 -1
- package/dist/elements/StructuredDocumentTag.js +39 -39
- package/dist/elements/StructuredDocumentTag.js.map +1 -1
- package/dist/elements/Table.d.ts +16 -10
- package/dist/elements/Table.d.ts.map +1 -1
- package/dist/elements/Table.js +118 -89
- package/dist/elements/Table.js.map +1 -1
- package/dist/elements/TableCell.d.ts +11 -11
- package/dist/elements/TableCell.d.ts.map +1 -1
- package/dist/elements/TableCell.js +108 -78
- package/dist/elements/TableCell.js.map +1 -1
- package/dist/elements/TableGridChange.d.ts +1 -1
- package/dist/elements/TableGridChange.d.ts.map +1 -1
- package/dist/elements/TableGridChange.js +3 -3
- package/dist/elements/TableGridChange.js.map +1 -1
- package/dist/elements/TableOfContents.d.ts +1 -1
- package/dist/elements/TableOfContents.d.ts.map +1 -1
- package/dist/elements/TableOfContents.js +2 -2
- package/dist/elements/TableOfContents.js.map +1 -1
- package/dist/elements/TableOfContentsElement.d.ts +2 -2
- package/dist/elements/TableOfContentsElement.d.ts.map +1 -1
- package/dist/elements/TableOfContentsElement.js +5 -5
- package/dist/elements/TableOfContentsElement.js.map +1 -1
- package/dist/elements/TableRow.d.ts +18 -7
- package/dist/elements/TableRow.d.ts.map +1 -1
- package/dist/elements/TableRow.js +127 -74
- package/dist/elements/TableRow.js.map +1 -1
- package/dist/elements/TextBox.d.ts +4 -4
- package/dist/elements/TextBox.d.ts.map +1 -1
- package/dist/elements/TextBox.js +6 -6
- package/dist/elements/TextBox.js.map +1 -1
- package/dist/esm/constants/legacyCompatFlags.js +97 -0
- package/dist/esm/constants/legacyCompatFlags.js.map +1 -0
- package/dist/esm/constants/limits.js +36 -0
- package/dist/esm/constants/limits.js.map +1 -0
- package/dist/esm/core/Document.js +8498 -0
- package/dist/esm/core/Document.js.map +1 -0
- package/dist/esm/core/DocumentContent.js +190 -0
- package/dist/esm/core/DocumentContent.js.map +1 -0
- package/dist/esm/core/DocumentEvents.js +47 -0
- package/dist/esm/core/DocumentEvents.js.map +1 -0
- package/dist/esm/core/DocumentGenerator.js +764 -0
- package/dist/esm/core/DocumentGenerator.js.map +1 -0
- package/dist/esm/core/DocumentIdManager.js +67 -0
- package/dist/esm/core/DocumentIdManager.js.map +1 -0
- package/dist/esm/core/DocumentParser.js +8760 -0
- package/dist/esm/core/DocumentParser.js.map +1 -0
- package/dist/esm/core/DocumentValidator.js +222 -0
- package/dist/esm/core/DocumentValidator.js.map +1 -0
- package/dist/esm/core/ElementRegistry.js +24 -0
- package/dist/esm/core/ElementRegistry.js.map +1 -0
- package/dist/esm/core/Relationship.js +177 -0
- package/dist/esm/core/Relationship.js.map +1 -0
- package/dist/esm/core/RelationshipManager.js +202 -0
- package/dist/esm/core/RelationshipManager.js.map +1 -0
- package/dist/esm/elements/AlternateContent.js +19 -0
- package/dist/esm/elements/AlternateContent.js.map +1 -0
- package/dist/esm/elements/Bookmark.js +115 -0
- package/dist/esm/elements/Bookmark.js.map +1 -0
- package/dist/esm/elements/BookmarkManager.js +99 -0
- package/dist/esm/elements/BookmarkManager.js.map +1 -0
- package/dist/esm/elements/Comment.js +181 -0
- package/dist/esm/elements/Comment.js.map +1 -0
- package/dist/esm/elements/CommentManager.js +233 -0
- package/dist/esm/elements/CommentManager.js.map +1 -0
- package/dist/esm/elements/CommonTypes.js +106 -0
- package/dist/esm/elements/CommonTypes.js.map +1 -0
- package/dist/esm/elements/CustomXml.js +19 -0
- package/dist/esm/elements/CustomXml.js.map +1 -0
- package/dist/esm/elements/Endnote.js +107 -0
- package/dist/esm/elements/Endnote.js.map +1 -0
- package/dist/esm/elements/EndnoteManager.js +119 -0
- package/dist/esm/elements/EndnoteManager.js.map +1 -0
- package/dist/esm/elements/Field.js +856 -0
- package/dist/esm/elements/Field.js.map +1 -0
- package/dist/esm/elements/FieldHelpers.js +134 -0
- package/dist/esm/elements/FieldHelpers.js.map +1 -0
- package/dist/esm/elements/FontManager.js +158 -0
- package/dist/esm/elements/FontManager.js.map +1 -0
- package/dist/esm/elements/Footer.js +141 -0
- package/dist/esm/elements/Footer.js.map +1 -0
- package/dist/esm/elements/Footnote.js +107 -0
- package/dist/esm/elements/Footnote.js.map +1 -0
- package/dist/esm/elements/FootnoteManager.js +119 -0
- package/dist/esm/elements/FootnoteManager.js.map +1 -0
- package/dist/esm/elements/Header.js +141 -0
- package/dist/esm/elements/Header.js.map +1 -0
- package/dist/esm/elements/HeaderFooterManager.js +87 -0
- package/dist/esm/elements/HeaderFooterManager.js.map +1 -0
- package/dist/esm/elements/Hyperlink.js +586 -0
- package/dist/esm/elements/Hyperlink.js.map +1 -0
- package/dist/esm/elements/Image.js +1288 -0
- package/dist/esm/elements/Image.js.map +1 -0
- package/dist/esm/elements/ImageManager.js +223 -0
- package/dist/esm/elements/ImageManager.js.map +1 -0
- package/dist/esm/elements/ImageRun.js +29 -0
- package/dist/esm/elements/ImageRun.js.map +1 -0
- package/dist/esm/elements/MathElement.js +37 -0
- package/dist/esm/elements/MathElement.js.map +1 -0
- package/dist/esm/elements/Paragraph.js +2308 -0
- package/dist/esm/elements/Paragraph.js.map +1 -0
- package/dist/esm/elements/PreservedElement.js +29 -0
- package/dist/esm/elements/PreservedElement.js.map +1 -0
- package/dist/esm/elements/PropertyChangeTypes.js +53 -0
- package/dist/esm/elements/PropertyChangeTypes.js.map +1 -0
- package/dist/esm/elements/RangeMarker.js +219 -0
- package/dist/esm/elements/RangeMarker.js.map +1 -0
- package/dist/esm/elements/RegisteredBodyElement.js +40 -0
- package/dist/esm/elements/RegisteredBodyElement.js.map +1 -0
- package/dist/esm/elements/Revision.js +498 -0
- package/dist/esm/elements/Revision.js.map +1 -0
- package/dist/esm/elements/RevisionContent.js +18 -0
- package/dist/esm/elements/RevisionContent.js.map +1 -0
- package/dist/esm/elements/RevisionManager.js +486 -0
- package/dist/esm/elements/RevisionManager.js.map +1 -0
- package/dist/esm/elements/Run.js +1465 -0
- package/dist/esm/elements/Run.js.map +1 -0
- package/dist/esm/elements/Section.js +978 -0
- package/dist/esm/elements/Section.js.map +1 -0
- package/dist/esm/elements/Shape.js +493 -0
- package/dist/esm/elements/Shape.js.map +1 -0
- package/dist/esm/elements/StructuredDocumentTag.js +471 -0
- package/dist/esm/elements/StructuredDocumentTag.js.map +1 -0
- package/dist/esm/elements/Table.js +1456 -0
- package/dist/esm/elements/Table.js.map +1 -0
- package/dist/esm/elements/TableCell.js +835 -0
- package/dist/esm/elements/TableCell.js.map +1 -0
- package/dist/esm/elements/TableGridChange.js +52 -0
- package/dist/esm/elements/TableGridChange.js.map +1 -0
- package/dist/esm/elements/TableOfContents.js +389 -0
- package/dist/esm/elements/TableOfContents.js.map +1 -0
- package/dist/esm/elements/TableOfContentsElement.js +29 -0
- package/dist/esm/elements/TableOfContentsElement.js.map +1 -0
- package/dist/esm/elements/TableRow.js +555 -0
- package/dist/esm/elements/TableRow.js.map +1 -0
- package/dist/esm/elements/TextBox.js +459 -0
- package/dist/esm/elements/TextBox.js.map +1 -0
- package/dist/esm/formatting/AbstractNumbering.js +325 -0
- package/dist/esm/formatting/AbstractNumbering.js.map +1 -0
- package/dist/esm/formatting/NumberingInstance.js +150 -0
- package/dist/esm/formatting/NumberingInstance.js.map +1 -0
- package/dist/esm/formatting/NumberingLevel.js +608 -0
- package/dist/esm/formatting/NumberingLevel.js.map +1 -0
- package/dist/esm/formatting/NumberingManager.js +423 -0
- package/dist/esm/formatting/NumberingManager.js.map +1 -0
- package/dist/esm/formatting/Style.js +1151 -0
- package/dist/esm/formatting/Style.js.map +1 -0
- package/dist/esm/formatting/StylesManager.js +557 -0
- package/dist/esm/formatting/StylesManager.js.map +1 -0
- package/dist/esm/helpers/CleanupHelper.js +350 -0
- package/dist/esm/helpers/CleanupHelper.js.map +1 -0
- package/dist/esm/images/ImageOptimizer.js +161 -0
- package/dist/esm/images/ImageOptimizer.js.map +1 -0
- package/dist/esm/index.js +75 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/internal.js +16 -0
- package/dist/esm/internal.js.map +1 -0
- package/dist/esm/managers/DrawingManager.js +163 -0
- package/dist/esm/managers/DrawingManager.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/processors/ChangelogGenerator.js +970 -0
- package/dist/esm/processors/ChangelogGenerator.js.map +1 -0
- package/dist/esm/processors/CompatibilityUpgrader.js +130 -0
- package/dist/esm/processors/CompatibilityUpgrader.js.map +1 -0
- package/dist/esm/processors/InMemoryRevisionAcceptor.js +530 -0
- package/dist/esm/processors/InMemoryRevisionAcceptor.js.map +1 -0
- package/dist/esm/processors/MoveOperationHelper.js +57 -0
- package/dist/esm/processors/MoveOperationHelper.js.map +1 -0
- package/dist/esm/processors/RevisionAwareProcessor.js +232 -0
- package/dist/esm/processors/RevisionAwareProcessor.js.map +1 -0
- package/dist/esm/processors/RevisionWalker.js +278 -0
- package/dist/esm/processors/RevisionWalker.js.map +1 -0
- package/dist/{utils → esm/processors}/SelectiveRevisionAcceptor.js +81 -42
- package/dist/esm/processors/SelectiveRevisionAcceptor.js.map +1 -0
- package/dist/esm/processors/ShadingResolver.js +66 -0
- package/dist/esm/processors/ShadingResolver.js.map +1 -0
- package/dist/esm/processors/acceptRevisions.js +416 -0
- package/dist/esm/processors/acceptRevisions.js.map +1 -0
- package/dist/esm/processors/cnfStyleDecoder.js +89 -0
- package/dist/esm/processors/cnfStyleDecoder.js.map +1 -0
- package/dist/esm/processors/stripTrackedChanges.js +201 -0
- package/dist/esm/processors/stripTrackedChanges.js.map +1 -0
- package/dist/esm/tracking/DocumentTrackingContext.js +531 -0
- package/dist/esm/tracking/DocumentTrackingContext.js.map +1 -0
- package/dist/esm/tracking/TrackingContext.js +2 -0
- package/dist/esm/tracking/TrackingContext.js.map +1 -0
- package/dist/esm/types/compatibility-types.js +8 -0
- package/dist/esm/types/compatibility-types.js.map +1 -0
- package/dist/esm/types/document-types.js +2 -0
- package/dist/esm/types/document-types.js.map +1 -0
- package/dist/esm/types/formatting.js +2 -0
- package/dist/esm/types/formatting.js.map +1 -0
- package/dist/esm/types/list-types.js +2 -0
- package/dist/esm/types/list-types.js.map +1 -0
- package/dist/esm/types/settings-types.js +2 -0
- package/dist/esm/types/settings-types.js.map +1 -0
- package/dist/esm/types/styleConfig.js +2 -0
- package/dist/esm/types/styleConfig.js.map +1 -0
- package/dist/esm/utils/KeyedRegistry.js +32 -0
- package/dist/esm/utils/KeyedRegistry.js.map +1 -0
- package/dist/esm/utils/corruptionDetection.js +155 -0
- package/dist/esm/utils/corruptionDetection.js.map +1 -0
- package/dist/esm/utils/dateFormatting.js +4 -0
- package/dist/esm/utils/dateFormatting.js.map +1 -0
- package/dist/esm/utils/deepClone.js +40 -0
- package/dist/esm/utils/deepClone.js.map +1 -0
- package/dist/esm/utils/deepEqual.js +47 -0
- package/dist/esm/utils/deepEqual.js.map +1 -0
- package/dist/esm/utils/diagnostics.js +69 -0
- package/dist/esm/utils/diagnostics.js.map +1 -0
- package/dist/esm/utils/errorHandling.js +36 -0
- package/dist/esm/utils/errorHandling.js.map +1 -0
- package/dist/esm/utils/formatting.js +93 -0
- package/dist/esm/utils/formatting.js.map +1 -0
- package/dist/esm/utils/list-detection.js +148 -0
- package/dist/esm/utils/list-detection.js.map +1 -0
- package/dist/esm/utils/logger.js +205 -0
- package/dist/esm/utils/logger.js.map +1 -0
- package/dist/esm/utils/parsingHelpers.js +56 -0
- package/dist/esm/utils/parsingHelpers.js.map +1 -0
- package/dist/esm/utils/textDiff.js +42 -0
- package/dist/esm/utils/textDiff.js.map +1 -0
- package/dist/esm/utils/units.js +152 -0
- package/dist/esm/utils/units.js.map +1 -0
- package/dist/esm/utils/validation.js +285 -0
- package/dist/esm/utils/validation.js.map +1 -0
- package/dist/esm/utils/xmlSanitization.js +54 -0
- package/dist/esm/utils/xmlSanitization.js.map +1 -0
- package/dist/esm/validation/RevisionAutoFixer.js +340 -0
- package/dist/esm/validation/RevisionAutoFixer.js.map +1 -0
- package/dist/esm/validation/RevisionValidator.js +240 -0
- package/dist/esm/validation/RevisionValidator.js.map +1 -0
- package/dist/esm/validation/ValidationRuleRegistry.js +40 -0
- package/dist/esm/validation/ValidationRuleRegistry.js.map +1 -0
- package/dist/esm/validation/ValidationRules.js +92 -0
- package/dist/esm/validation/ValidationRules.js.map +1 -0
- package/dist/esm/validation/index.js +4 -0
- package/dist/esm/validation/index.js.map +1 -0
- package/dist/esm/xml/XMLBuilder.js +434 -0
- package/dist/esm/xml/XMLBuilder.js.map +1 -0
- package/dist/esm/xml/XMLParser.js +486 -0
- package/dist/esm/xml/XMLParser.js.map +1 -0
- package/dist/esm/zip/ZipHandler.js +298 -0
- package/dist/esm/zip/ZipHandler.js.map +1 -0
- package/dist/esm/zip/ZipReader.js +147 -0
- package/dist/esm/zip/ZipReader.js.map +1 -0
- package/dist/esm/zip/ZipWriter.js +199 -0
- package/dist/esm/zip/ZipWriter.js.map +1 -0
- package/dist/esm/zip/errors.js +43 -0
- package/dist/esm/zip/errors.js.map +1 -0
- package/dist/esm/zip/types.js +31 -0
- package/dist/esm/zip/types.js.map +1 -0
- package/dist/formatting/AbstractNumbering.d.ts +2 -2
- package/dist/formatting/AbstractNumbering.d.ts.map +1 -1
- package/dist/formatting/AbstractNumbering.js +33 -33
- package/dist/formatting/AbstractNumbering.js.map +1 -1
- package/dist/formatting/NumberingInstance.d.ts +2 -2
- package/dist/formatting/NumberingInstance.d.ts.map +1 -1
- package/dist/formatting/NumberingInstance.js +7 -7
- package/dist/formatting/NumberingInstance.js.map +1 -1
- package/dist/formatting/NumberingLevel.d.ts +11 -2
- package/dist/formatting/NumberingLevel.d.ts.map +1 -1
- package/dist/formatting/NumberingLevel.js +111 -25
- package/dist/formatting/NumberingLevel.js.map +1 -1
- package/dist/formatting/NumberingManager.d.ts +4 -4
- package/dist/formatting/NumberingManager.d.ts.map +1 -1
- package/dist/formatting/NumberingManager.js +28 -28
- package/dist/formatting/NumberingManager.js.map +1 -1
- package/dist/formatting/Style.d.ts +14 -7
- package/dist/formatting/Style.d.ts.map +1 -1
- package/dist/formatting/Style.js +309 -112
- package/dist/formatting/Style.js.map +1 -1
- package/dist/formatting/StylesManager.d.ts +2 -2
- package/dist/formatting/StylesManager.d.ts.map +1 -1
- package/dist/formatting/StylesManager.js +52 -52
- package/dist/formatting/StylesManager.js.map +1 -1
- package/dist/helpers/CleanupHelper.d.ts +1 -1
- package/dist/helpers/CleanupHelper.d.ts.map +1 -1
- package/dist/helpers/CleanupHelper.js +15 -15
- package/dist/helpers/CleanupHelper.js.map +1 -1
- package/dist/index.d.ts +81 -90
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +286 -317
- package/dist/index.js.map +1 -1
- package/dist/internal.d.ts +16 -0
- package/dist/internal.d.ts.map +1 -0
- package/dist/internal.js +42 -0
- package/dist/internal.js.map +1 -0
- package/dist/managers/DrawingManager.d.ts +3 -3
- package/dist/managers/DrawingManager.d.ts.map +1 -1
- package/dist/managers/DrawingManager.js +12 -12
- package/dist/managers/DrawingManager.js.map +1 -1
- package/dist/{utils → processors}/ChangelogGenerator.d.ts +2 -2
- package/dist/processors/ChangelogGenerator.d.ts.map +1 -0
- package/dist/{utils → processors}/ChangelogGenerator.js +2 -2
- package/dist/processors/ChangelogGenerator.js.map +1 -0
- package/dist/processors/CompatibilityUpgrader.d.ts.map +1 -0
- package/dist/{utils → processors}/CompatibilityUpgrader.js +10 -10
- package/dist/processors/CompatibilityUpgrader.js.map +1 -0
- package/dist/{utils → processors}/InMemoryRevisionAcceptor.d.ts +3 -3
- package/dist/processors/InMemoryRevisionAcceptor.d.ts.map +1 -0
- package/dist/{utils → processors}/InMemoryRevisionAcceptor.js +84 -27
- package/dist/processors/InMemoryRevisionAcceptor.js.map +1 -0
- package/dist/{utils → processors}/MoveOperationHelper.d.ts +4 -4
- package/dist/processors/MoveOperationHelper.d.ts.map +1 -0
- package/dist/{utils → processors}/MoveOperationHelper.js +10 -10
- package/dist/processors/MoveOperationHelper.js.map +1 -0
- package/dist/{utils → processors}/RevisionAwareProcessor.d.ts +3 -3
- package/dist/processors/RevisionAwareProcessor.d.ts.map +1 -0
- package/dist/{utils → processors}/RevisionAwareProcessor.js +2 -2
- package/dist/processors/RevisionAwareProcessor.js.map +1 -0
- package/dist/{utils → processors}/RevisionWalker.d.ts +2 -1
- package/dist/processors/RevisionWalker.d.ts.map +1 -0
- package/dist/{utils → processors}/RevisionWalker.js +28 -0
- package/dist/processors/RevisionWalker.js.map +1 -0
- package/dist/{utils → processors}/SelectiveRevisionAcceptor.d.ts +4 -3
- package/dist/processors/SelectiveRevisionAcceptor.d.ts.map +1 -0
- package/dist/processors/SelectiveRevisionAcceptor.js +402 -0
- package/dist/processors/SelectiveRevisionAcceptor.js.map +1 -0
- package/dist/processors/ShadingResolver.d.ts +6 -0
- package/dist/processors/ShadingResolver.d.ts.map +1 -0
- package/dist/{utils → processors}/ShadingResolver.js +2 -2
- package/dist/processors/ShadingResolver.js.map +1 -0
- package/dist/{utils → processors}/acceptRevisions.d.ts +1 -1
- package/dist/processors/acceptRevisions.d.ts.map +1 -0
- package/dist/{utils → processors}/acceptRevisions.js +24 -4
- package/dist/processors/acceptRevisions.js.map +1 -0
- package/dist/{utils → processors}/cnfStyleDecoder.d.ts +1 -1
- package/dist/processors/cnfStyleDecoder.d.ts.map +1 -0
- package/dist/processors/cnfStyleDecoder.js.map +1 -0
- package/dist/processors/stripTrackedChanges.d.ts +3 -0
- package/dist/processors/stripTrackedChanges.d.ts.map +1 -0
- package/dist/{utils → processors}/stripTrackedChanges.js +16 -6
- package/dist/processors/stripTrackedChanges.js.map +1 -0
- package/dist/tracking/DocumentTrackingContext.d.ts +4 -4
- package/dist/tracking/DocumentTrackingContext.d.ts.map +1 -1
- package/dist/tracking/DocumentTrackingContext.js +38 -43
- package/dist/tracking/DocumentTrackingContext.js.map +1 -1
- package/dist/tracking/TrackingContext.d.ts +8 -8
- package/dist/tracking/TrackingContext.d.ts.map +1 -1
- package/dist/tracking/TrackingContext.js.map +1 -1
- package/dist/types/document-types.d.ts +28 -0
- package/dist/types/document-types.d.ts.map +1 -0
- package/dist/types/document-types.js +3 -0
- package/dist/types/document-types.js.map +1 -0
- package/dist/types/formatting.d.ts +4 -4
- package/dist/types/formatting.d.ts.map +1 -1
- package/dist/types/formatting.js.map +1 -1
- package/dist/types/settings-types.d.ts +6 -0
- package/dist/types/settings-types.d.ts.map +1 -1
- package/dist/types/settings-types.js.map +1 -1
- package/dist/utils/KeyedRegistry.d.ts +13 -0
- package/dist/utils/KeyedRegistry.d.ts.map +1 -0
- package/dist/utils/KeyedRegistry.js +36 -0
- package/dist/utils/KeyedRegistry.js.map +1 -0
- package/dist/utils/corruptionDetection.d.ts +1 -1
- package/dist/utils/corruptionDetection.d.ts.map +1 -1
- package/dist/utils/corruptionDetection.js +4 -4
- package/dist/utils/corruptionDetection.js.map +1 -1
- package/dist/utils/deepEqual.d.ts +2 -0
- package/dist/utils/deepEqual.d.ts.map +1 -0
- package/dist/utils/deepEqual.js +50 -0
- package/dist/utils/deepEqual.js.map +1 -0
- package/dist/utils/list-detection.d.ts +2 -2
- package/dist/utils/list-detection.d.ts.map +1 -1
- package/dist/utils/list-detection.js.map +1 -1
- package/dist/utils/parsingHelpers.d.ts +1 -1
- package/dist/utils/parsingHelpers.d.ts.map +1 -1
- package/dist/utils/parsingHelpers.js +2 -2
- package/dist/utils/parsingHelpers.js.map +1 -1
- package/dist/utils/validation.js +7 -7
- package/dist/utils/validation.js.map +1 -1
- package/dist/utils/xmlSanitization.js +2 -2
- package/dist/utils/xmlSanitization.js.map +1 -1
- package/dist/validation/RevisionAutoFixer.d.ts +4 -4
- package/dist/validation/RevisionAutoFixer.d.ts.map +1 -1
- package/dist/validation/RevisionAutoFixer.js +11 -11
- package/dist/validation/RevisionAutoFixer.js.map +1 -1
- package/dist/validation/RevisionValidator.d.ts +5 -4
- package/dist/validation/RevisionValidator.d.ts.map +1 -1
- package/dist/validation/RevisionValidator.js +29 -30
- package/dist/validation/RevisionValidator.js.map +1 -1
- package/dist/validation/ValidationRuleRegistry.d.ts +27 -0
- package/dist/validation/ValidationRuleRegistry.d.ts.map +1 -0
- package/dist/validation/ValidationRuleRegistry.js +43 -0
- package/dist/validation/ValidationRuleRegistry.js.map +1 -0
- package/dist/validation/index.d.ts +3 -3
- package/dist/validation/index.d.ts.map +1 -1
- package/dist/validation/index.js +10 -10
- package/dist/validation/index.js.map +1 -1
- package/dist/xml/XMLBuilder.d.ts +6 -1
- package/dist/xml/XMLBuilder.d.ts.map +1 -1
- package/dist/xml/XMLBuilder.js +11 -6
- package/dist/xml/XMLBuilder.js.map +1 -1
- package/dist/xml/XMLParser.js +6 -6
- package/dist/xml/XMLParser.js.map +1 -1
- package/dist/zip/ZipHandler.d.ts +1 -1
- package/dist/zip/ZipHandler.d.ts.map +1 -1
- package/dist/zip/ZipHandler.js +8 -8
- package/dist/zip/ZipHandler.js.map +1 -1
- package/dist/zip/ZipReader.d.ts +1 -1
- package/dist/zip/ZipReader.d.ts.map +1 -1
- package/dist/zip/ZipReader.js +14 -14
- package/dist/zip/ZipReader.js.map +1 -1
- package/dist/zip/ZipWriter.d.ts +1 -1
- package/dist/zip/ZipWriter.d.ts.map +1 -1
- package/dist/zip/ZipWriter.js +10 -10
- package/dist/zip/ZipWriter.js.map +1 -1
- package/package.json +20 -4
- package/src/constants/legacyCompatFlags.ts +1 -1
- package/src/core/Document.ts +478 -167
- package/src/core/DocumentContent.ts +14 -11
- package/src/core/DocumentEvents.ts +90 -0
- package/src/core/DocumentGenerator.ts +49 -22
- package/src/core/DocumentParser.ts +2235 -620
- package/src/core/DocumentValidator.ts +7 -7
- package/src/core/ElementRegistry.ts +69 -0
- package/src/core/Relationship.ts +1 -1
- package/src/core/RelationshipManager.ts +4 -4
- package/src/elements/AlternateContent.ts +1 -1
- package/src/elements/Bookmark.ts +52 -4
- package/src/elements/BookmarkManager.ts +2 -2
- package/src/elements/Comment.ts +3 -3
- package/src/elements/CommentManager.ts +4 -4
- package/src/elements/CommonTypes.ts +45 -7
- package/src/elements/CustomXml.ts +1 -1
- package/src/elements/Endnote.ts +2 -2
- package/src/elements/EndnoteManager.ts +3 -3
- package/src/elements/Field.ts +44 -10
- package/src/elements/FieldHelpers.ts +2 -2
- package/src/elements/Footer.ts +4 -4
- package/src/elements/Footnote.ts +2 -2
- package/src/elements/FootnoteManager.ts +3 -3
- package/src/elements/Header.ts +4 -4
- package/src/elements/HeaderFooterManager.ts +2 -2
- package/src/elements/Hyperlink.ts +16 -12
- package/src/elements/Image.ts +3 -3
- package/src/elements/ImageManager.ts +2 -2
- package/src/elements/ImageRun.ts +3 -3
- package/src/elements/MathElement.ts +1 -1
- package/src/elements/Paragraph.ts +221 -88
- package/src/elements/PreservedElement.ts +1 -1
- package/src/elements/PropertyChangeTypes.ts +2 -2
- package/src/elements/RangeMarker.ts +153 -12
- package/src/elements/RegisteredBodyElement.ts +52 -0
- package/src/elements/Revision.ts +14 -14
- package/src/elements/RevisionContent.ts +3 -3
- package/src/elements/RevisionManager.ts +3 -3
- package/src/elements/Run.ts +221 -94
- package/src/elements/Section.ts +136 -69
- package/src/elements/Shape.ts +4 -4
- package/src/elements/StructuredDocumentTag.ts +3 -3
- package/src/elements/Table.ts +91 -27
- package/src/elements/TableCell.ts +62 -34
- package/src/elements/TableGridChange.ts +1 -1
- package/src/elements/TableOfContents.ts +1 -1
- package/src/elements/TableOfContentsElement.ts +2 -2
- package/src/elements/TableRow.ts +192 -48
- package/src/elements/TextBox.ts +5 -5
- package/src/formatting/AbstractNumbering.ts +3 -3
- package/src/formatting/NumberingInstance.ts +2 -2
- package/src/formatting/NumberingLevel.ts +201 -10
- package/src/formatting/NumberingManager.ts +5 -5
- package/src/formatting/Style.ts +382 -86
- package/src/formatting/StylesManager.ts +4 -4
- package/src/helpers/CleanupHelper.ts +6 -6
- package/src/index.ts +118 -127
- package/src/internal.ts +79 -0
- package/src/managers/DrawingManager.ts +3 -3
- package/src/{utils → processors}/ChangelogGenerator.ts +3 -3
- package/src/{utils → processors}/CompatibilityUpgrader.ts +2 -2
- package/src/{utils → processors}/InMemoryRevisionAcceptor.ts +100 -12
- package/src/{utils → processors}/MoveOperationHelper.ts +5 -5
- package/src/{utils → processors}/RevisionAwareProcessor.ts +3 -3
- package/src/{utils → processors}/RevisionWalker.ts +42 -1
- package/src/{utils → processors}/SelectiveRevisionAcceptor.ts +98 -39
- package/src/{utils → processors}/ShadingResolver.ts +5 -5
- package/src/{utils → processors}/acceptRevisions.ts +77 -9
- package/src/{utils → processors}/cnfStyleDecoder.ts +1 -1
- package/src/{utils → processors}/stripTrackedChanges.ts +35 -10
- package/src/tracking/DocumentTrackingContext.ts +12 -14
- package/src/tracking/TrackingContext.ts +8 -8
- package/src/types/document-types.ts +53 -0
- package/src/types/formatting.ts +4 -4
- package/src/types/settings-types.ts +32 -0
- package/src/utils/KeyedRegistry.ts +41 -0
- package/src/utils/corruptionDetection.ts +2 -2
- package/src/utils/deepEqual.ts +58 -0
- package/src/utils/list-detection.ts +2 -2
- package/src/utils/parsingHelpers.ts +11 -3
- package/src/utils/validation.ts +3 -3
- package/src/utils/xmlSanitization.ts +1 -1
- package/src/validation/RevisionAutoFixer.ts +5 -5
- package/src/validation/RevisionValidator.ts +39 -28
- package/src/validation/ValidationRuleRegistry.ts +86 -0
- package/src/validation/index.ts +3 -3
- package/src/xml/XMLBuilder.ts +13 -3
- package/src/xml/XMLParser.ts +2 -2
- package/src/zip/ZipHandler.ts +4 -4
- package/src/zip/ZipReader.ts +3 -3
- package/src/zip/ZipWriter.ts +3 -3
- package/dist/utils/ChangelogGenerator.d.ts.map +0 -1
- package/dist/utils/ChangelogGenerator.js.map +0 -1
- package/dist/utils/CompatibilityUpgrader.d.ts.map +0 -1
- package/dist/utils/CompatibilityUpgrader.js.map +0 -1
- package/dist/utils/InMemoryRevisionAcceptor.d.ts.map +0 -1
- package/dist/utils/InMemoryRevisionAcceptor.js.map +0 -1
- package/dist/utils/MoveOperationHelper.d.ts.map +0 -1
- package/dist/utils/MoveOperationHelper.js.map +0 -1
- package/dist/utils/RevisionAwareProcessor.d.ts.map +0 -1
- package/dist/utils/RevisionAwareProcessor.js.map +0 -1
- package/dist/utils/RevisionWalker.d.ts.map +0 -1
- package/dist/utils/RevisionWalker.js.map +0 -1
- package/dist/utils/SelectiveRevisionAcceptor.d.ts.map +0 -1
- package/dist/utils/SelectiveRevisionAcceptor.js.map +0 -1
- package/dist/utils/ShadingResolver.d.ts +0 -6
- package/dist/utils/ShadingResolver.d.ts.map +0 -1
- package/dist/utils/ShadingResolver.js.map +0 -1
- package/dist/utils/acceptRevisions.d.ts.map +0 -1
- package/dist/utils/acceptRevisions.js.map +0 -1
- package/dist/utils/cnfStyleDecoder.d.ts.map +0 -1
- package/dist/utils/cnfStyleDecoder.js.map +0 -1
- package/dist/utils/stripTrackedChanges.d.ts +0 -3
- package/dist/utils/stripTrackedChanges.d.ts.map +0 -1
- package/dist/utils/stripTrackedChanges.js.map +0 -1
- package/src/__tests__/helper-methods.test.ts +0 -512
- package/src/constants/CLAUDE.md +0 -28
- package/src/core/CLAUDE.md +0 -113
- package/src/elements/CLAUDE.md +0 -142
- package/src/formatting/CLAUDE.md +0 -78
- package/src/managers/CLAUDE.md +0 -47
- package/src/tracking/CLAUDE.md +0 -30
- package/src/types/CLAUDE.md +0 -39
- package/src/utils/CLAUDE.md +0 -168
- package/src/validation/CLAUDE.md +0 -40
- package/src/xml/CLAUDE.md +0 -65
- package/src/zip/CLAUDE.md +0 -55
- /package/dist/{utils → processors}/CompatibilityUpgrader.d.ts +0 -0
- /package/dist/{utils → processors}/cnfStyleDecoder.js +0 -0
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
import { Paragraph } from '../elements/Paragraph.js';
|
|
2
|
+
import { Table } from '../elements/Table.js';
|
|
3
|
+
import { LIMITS } from '../constants/limits.js';
|
|
4
|
+
import { defaultLogger } from '../utils/logger.js';
|
|
5
|
+
import * as v8 from 'v8';
|
|
6
|
+
export class DocumentValidator {
|
|
7
|
+
maxMemoryUsagePercent;
|
|
8
|
+
maxRssMB;
|
|
9
|
+
useAbsoluteLimit;
|
|
10
|
+
constructor(maxMemoryUsagePercent = 80, options = {}) {
|
|
11
|
+
const memoryPercent = options.maxMemoryUsagePercent ?? maxMemoryUsagePercent;
|
|
12
|
+
if (memoryPercent < 1 || memoryPercent > 100 || !Number.isFinite(memoryPercent)) {
|
|
13
|
+
throw new Error('maxMemoryUsagePercent must be between 1 and 100');
|
|
14
|
+
}
|
|
15
|
+
this.maxMemoryUsagePercent = memoryPercent;
|
|
16
|
+
this.maxRssMB = options.maxRssMB ?? 2048;
|
|
17
|
+
this.useAbsoluteLimit = options.useAbsoluteLimit ?? true;
|
|
18
|
+
}
|
|
19
|
+
static validateProperties(properties) {
|
|
20
|
+
const validated = {};
|
|
21
|
+
if (properties.title !== undefined) {
|
|
22
|
+
if (typeof properties.title !== 'string') {
|
|
23
|
+
throw new Error('DocumentProperties.title must be a string');
|
|
24
|
+
}
|
|
25
|
+
if (properties.title.length > LIMITS.MAX_STRING_LENGTH) {
|
|
26
|
+
throw new Error(`DocumentProperties.title exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`);
|
|
27
|
+
}
|
|
28
|
+
validated.title = properties.title;
|
|
29
|
+
}
|
|
30
|
+
if (properties.subject !== undefined) {
|
|
31
|
+
if (typeof properties.subject !== 'string') {
|
|
32
|
+
throw new Error('DocumentProperties.subject must be a string');
|
|
33
|
+
}
|
|
34
|
+
if (properties.subject.length > LIMITS.MAX_STRING_LENGTH) {
|
|
35
|
+
throw new Error(`DocumentProperties.subject exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`);
|
|
36
|
+
}
|
|
37
|
+
validated.subject = properties.subject;
|
|
38
|
+
}
|
|
39
|
+
if (properties.creator !== undefined) {
|
|
40
|
+
if (typeof properties.creator !== 'string') {
|
|
41
|
+
throw new Error('DocumentProperties.creator must be a string');
|
|
42
|
+
}
|
|
43
|
+
if (properties.creator.length > LIMITS.MAX_STRING_LENGTH) {
|
|
44
|
+
throw new Error(`DocumentProperties.creator exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`);
|
|
45
|
+
}
|
|
46
|
+
validated.creator = properties.creator;
|
|
47
|
+
}
|
|
48
|
+
if (properties.keywords !== undefined) {
|
|
49
|
+
if (typeof properties.keywords !== 'string') {
|
|
50
|
+
throw new Error('DocumentProperties.keywords must be a string');
|
|
51
|
+
}
|
|
52
|
+
if (properties.keywords.length > LIMITS.MAX_STRING_LENGTH) {
|
|
53
|
+
throw new Error(`DocumentProperties.keywords exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`);
|
|
54
|
+
}
|
|
55
|
+
validated.keywords = properties.keywords;
|
|
56
|
+
}
|
|
57
|
+
if (properties.description !== undefined) {
|
|
58
|
+
if (typeof properties.description !== 'string') {
|
|
59
|
+
throw new Error('DocumentProperties.description must be a string');
|
|
60
|
+
}
|
|
61
|
+
if (properties.description.length > LIMITS.MAX_STRING_LENGTH) {
|
|
62
|
+
throw new Error(`DocumentProperties.description exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`);
|
|
63
|
+
}
|
|
64
|
+
validated.description = properties.description;
|
|
65
|
+
}
|
|
66
|
+
if (properties.lastModifiedBy !== undefined) {
|
|
67
|
+
if (typeof properties.lastModifiedBy !== 'string') {
|
|
68
|
+
throw new Error('DocumentProperties.lastModifiedBy must be a string');
|
|
69
|
+
}
|
|
70
|
+
if (properties.lastModifiedBy.length > LIMITS.MAX_STRING_LENGTH) {
|
|
71
|
+
throw new Error(`DocumentProperties.lastModifiedBy exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`);
|
|
72
|
+
}
|
|
73
|
+
validated.lastModifiedBy = properties.lastModifiedBy;
|
|
74
|
+
}
|
|
75
|
+
if (properties.revision !== undefined) {
|
|
76
|
+
if (typeof properties.revision !== 'number' || !Number.isInteger(properties.revision)) {
|
|
77
|
+
throw new Error('DocumentProperties.revision must be an integer');
|
|
78
|
+
}
|
|
79
|
+
if (properties.revision < 0 || properties.revision > LIMITS.MAX_REVISION) {
|
|
80
|
+
throw new Error(`DocumentProperties.revision must be between 0 and ${LIMITS.MAX_REVISION}`);
|
|
81
|
+
}
|
|
82
|
+
validated.revision = properties.revision;
|
|
83
|
+
}
|
|
84
|
+
if (properties.created !== undefined) {
|
|
85
|
+
if (!(properties.created instanceof Date)) {
|
|
86
|
+
throw new Error('DocumentProperties.created must be a Date object');
|
|
87
|
+
}
|
|
88
|
+
if (!Number.isFinite(properties.created.getTime())) {
|
|
89
|
+
throw new Error('DocumentProperties.created is an invalid date');
|
|
90
|
+
}
|
|
91
|
+
validated.created = properties.created;
|
|
92
|
+
}
|
|
93
|
+
if (properties.modified !== undefined) {
|
|
94
|
+
if (!(properties.modified instanceof Date)) {
|
|
95
|
+
throw new Error('DocumentProperties.modified must be a Date object');
|
|
96
|
+
}
|
|
97
|
+
if (!Number.isFinite(properties.modified.getTime())) {
|
|
98
|
+
throw new Error('DocumentProperties.modified is an invalid date');
|
|
99
|
+
}
|
|
100
|
+
validated.modified = properties.modified;
|
|
101
|
+
}
|
|
102
|
+
return validated;
|
|
103
|
+
}
|
|
104
|
+
validateBeforeSave(bodyElements) {
|
|
105
|
+
const paragraphs = bodyElements.filter((el) => el instanceof Paragraph);
|
|
106
|
+
if (paragraphs.length === 0) {
|
|
107
|
+
defaultLogger.warn('\nDocXML Save Warning:\n' +
|
|
108
|
+
'Document has no paragraphs. You are saving an empty document.\n');
|
|
109
|
+
return;
|
|
110
|
+
}
|
|
111
|
+
let totalRuns = 0;
|
|
112
|
+
let emptyRuns = 0;
|
|
113
|
+
for (const para of paragraphs) {
|
|
114
|
+
const runs = para.getRuns();
|
|
115
|
+
totalRuns += runs.length;
|
|
116
|
+
for (const run of runs) {
|
|
117
|
+
if (run.getText().length === 0) {
|
|
118
|
+
emptyRuns++;
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
if (totalRuns > 0) {
|
|
123
|
+
const emptyPercentage = (emptyRuns / totalRuns) * 100;
|
|
124
|
+
if (emptyPercentage > 90 && emptyRuns > 10) {
|
|
125
|
+
defaultLogger.warn('\nDocXML Save Warning:\n' +
|
|
126
|
+
`You are about to save a document where ${emptyRuns} out of ${totalRuns} runs (${emptyPercentage.toFixed(1)}%) are empty.\n` +
|
|
127
|
+
'This may result in a document with no visible text content.\n' +
|
|
128
|
+
'If this is unintentional, please review the document before saving.\n');
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
checkMemoryThreshold() {
|
|
133
|
+
const { heapUsed, external, rss } = process.memoryUsage();
|
|
134
|
+
const heapStats = v8.getHeapStatistics();
|
|
135
|
+
const heapLimit = heapStats.heap_size_limit;
|
|
136
|
+
const heapPercent = (heapUsed / heapLimit) * 100;
|
|
137
|
+
const heapMB = heapUsed / (1024 * 1024);
|
|
138
|
+
const heapLimitMB = heapLimit / (1024 * 1024);
|
|
139
|
+
const rssMB = rss / (1024 * 1024);
|
|
140
|
+
const externalMB = external / (1024 * 1024);
|
|
141
|
+
const heapExceeded = heapPercent > this.maxMemoryUsagePercent;
|
|
142
|
+
const rssExceeded = this.useAbsoluteLimit && rssMB > this.maxRssMB;
|
|
143
|
+
if (heapExceeded && rssExceeded) {
|
|
144
|
+
throw new Error(`Memory usage critical:\n` +
|
|
145
|
+
` Heap: ${heapMB.toFixed(0)}MB / ${heapLimitMB.toFixed(0)}MB (${heapPercent.toFixed(1)}%)\n` +
|
|
146
|
+
` RSS: ${rssMB.toFixed(0)}MB (limit: ${this.maxRssMB}MB)\n` +
|
|
147
|
+
` External: ${externalMB.toFixed(0)}MB\n` +
|
|
148
|
+
`Cannot process document safely. Consider:\n` +
|
|
149
|
+
` - Reducing document size (remove/compress images)\n` +
|
|
150
|
+
` - Splitting into multiple documents\n` +
|
|
151
|
+
` - Increasing memory limits in DocumentOptions\n` +
|
|
152
|
+
` - Increasing Node.js heap size (--max-old-space-size)`);
|
|
153
|
+
}
|
|
154
|
+
if (heapExceeded && !rssExceeded && this.useAbsoluteLimit) {
|
|
155
|
+
defaultLogger.warn(`DocXML Memory Warning: Heap usage high (${heapPercent.toFixed(1)}%) ` +
|
|
156
|
+
`but RSS (${rssMB.toFixed(0)}MB) is below limit. ` +
|
|
157
|
+
`This might be temporary heap fragmentation.`);
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
estimateSize(bodyElements, imageManager) {
|
|
161
|
+
const paragraphs = bodyElements.filter((el) => el instanceof Paragraph);
|
|
162
|
+
const tables = bodyElements.filter((el) => el instanceof Table);
|
|
163
|
+
const paragraphCount = paragraphs.length;
|
|
164
|
+
const tableCount = tables.length;
|
|
165
|
+
const imageCount = imageManager.getImageCount();
|
|
166
|
+
const estimatedXml = paragraphCount * LIMITS.BYTES_PER_PARAGRAPH +
|
|
167
|
+
tableCount * LIMITS.BYTES_PER_TABLE +
|
|
168
|
+
LIMITS.BASE_STRUCTURE_BYTES;
|
|
169
|
+
const imageBytes = imageManager.getTotalSize();
|
|
170
|
+
const totalBytes = estimatedXml + imageBytes;
|
|
171
|
+
const totalMB = totalBytes / (1024 * 1024);
|
|
172
|
+
let warning;
|
|
173
|
+
if (totalMB > LIMITS.ERROR_SIZE_MB) {
|
|
174
|
+
warning =
|
|
175
|
+
`Document size (${totalMB.toFixed(1)}MB) exceeds recommended maximum of ${LIMITS.ERROR_SIZE_MB}MB. ` +
|
|
176
|
+
`This may cause memory issues. Consider splitting into multiple documents or optimizing images.`;
|
|
177
|
+
}
|
|
178
|
+
else if (totalMB > LIMITS.WARNING_SIZE_MB) {
|
|
179
|
+
warning =
|
|
180
|
+
`Document size (${totalMB.toFixed(1)}MB) exceeds ${LIMITS.WARNING_SIZE_MB}MB. ` +
|
|
181
|
+
`Large documents may take longer to process and use significant memory.`;
|
|
182
|
+
}
|
|
183
|
+
return {
|
|
184
|
+
paragraphs: paragraphCount,
|
|
185
|
+
tables: tableCount,
|
|
186
|
+
images: imageCount,
|
|
187
|
+
estimatedXmlBytes: estimatedXml,
|
|
188
|
+
imageBytes,
|
|
189
|
+
totalEstimatedBytes: totalBytes,
|
|
190
|
+
totalEstimatedMB: parseFloat(totalMB.toFixed(2)),
|
|
191
|
+
warning,
|
|
192
|
+
};
|
|
193
|
+
}
|
|
194
|
+
getSizeStats(bodyElements, imageManager) {
|
|
195
|
+
const estimate = this.estimateSize(bodyElements, imageManager);
|
|
196
|
+
const warnings = [];
|
|
197
|
+
if (estimate.warning) {
|
|
198
|
+
warnings.push(estimate.warning);
|
|
199
|
+
}
|
|
200
|
+
const formatBytes = (bytes) => {
|
|
201
|
+
if (bytes < 1024)
|
|
202
|
+
return `${bytes} B`;
|
|
203
|
+
if (bytes < 1024 * 1024)
|
|
204
|
+
return `${(bytes / 1024).toFixed(1)} KB`;
|
|
205
|
+
return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
|
|
206
|
+
};
|
|
207
|
+
return {
|
|
208
|
+
elements: {
|
|
209
|
+
paragraphs: estimate.paragraphs,
|
|
210
|
+
tables: estimate.tables,
|
|
211
|
+
images: estimate.images,
|
|
212
|
+
},
|
|
213
|
+
size: {
|
|
214
|
+
xml: formatBytes(estimate.estimatedXmlBytes),
|
|
215
|
+
images: formatBytes(estimate.imageBytes),
|
|
216
|
+
total: formatBytes(estimate.totalEstimatedBytes),
|
|
217
|
+
},
|
|
218
|
+
warnings,
|
|
219
|
+
};
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
//# sourceMappingURL=DocumentValidator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DocumentValidator.js","sourceRoot":"","sources":["../../../src/core/DocumentValidator.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAI7C,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AA+BzB,MAAM,OAAO,iBAAiB;IACpB,qBAAqB,CAAS;IAC9B,QAAQ,CAAS;IACjB,gBAAgB,CAAU;IAElC,YAAY,qBAAqB,GAAG,EAAE,EAAE,UAAyB,EAAE;QAEjE,MAAM,aAAa,GAAG,OAAO,CAAC,qBAAqB,IAAI,qBAAqB,CAAC;QAC7E,IAAI,aAAa,GAAG,CAAC,IAAI,aAAa,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAChF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,CAAC,qBAAqB,GAAG,aAAa,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;QACzC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,IAAI,CAAC;IAC3D,CAAC;IAQD,MAAM,CAAC,kBAAkB,CAAC,UAA8B;QACtD,MAAM,SAAS,GAAuB,EAAE,CAAC;QAGzC,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBACvD,MAAM,IAAI,KAAK,CACb,sDAAsD,MAAM,CAAC,iBAAiB,aAAa,CAC5F,CAAC;YACJ,CAAC;YACD,SAAS,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QACrC,CAAC;QAED,IAAI,UAAU,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACrC,IAAI,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;YACjE,CAAC;YACD,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBACzD,MAAM,IAAI,KAAK,CACb,wDAAwD,MAAM,CAAC,iBAAiB,aAAa,CAC9F,CAAC;YACJ,CAAC;YACD,SAAS,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QACzC,CAAC;QAED,IAAI,UAAU,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACrC,IAAI,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;YACjE,CAAC;YACD,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBACzD,MAAM,IAAI,KAAK,CACb,wDAAwD,MAAM,CAAC,iBAAiB,aAAa,CAC9F,CAAC;YACJ,CAAC;YACD,SAAS,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QACzC,CAAC;QAED,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAClE,CAAC;YACD,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAC1D,MAAM,IAAI,KAAK,CACb,yDAAyD,MAAM,CAAC,iBAAiB,aAAa,CAC/F,CAAC;YACJ,CAAC;YACD,SAAS,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QAC3C,CAAC;QAED,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,OAAO,UAAU,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,CAAC;YACD,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAC7D,MAAM,IAAI,KAAK,CACb,4DAA4D,MAAM,CAAC,iBAAiB,aAAa,CAClG,CAAC;YACJ,CAAC;YACD,SAAS,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QACjD,CAAC;QAED,IAAI,UAAU,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAC5C,IAAI,OAAO,UAAU,CAAC,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAClD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACxE,CAAC;YACD,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAChE,MAAM,IAAI,KAAK,CACb,+DAA+D,MAAM,CAAC,iBAAiB,aAAa,CACrG,CAAC;YACJ,CAAC;YACD,SAAS,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;QACvD,CAAC;QAGD,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtF,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;YACpE,CAAC;YACD,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;gBACzE,MAAM,IAAI,KAAK,CAAC,qDAAqD,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YAC9F,CAAC;YACD,SAAS,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QAC3C,CAAC;QAGD,IAAI,UAAU,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC,CAAC,UAAU,CAAC,OAAO,YAAY,IAAI,CAAC,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;gBACnD,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACnE,CAAC;YACD,SAAS,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QACzC,CAAC;QAED,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,CAAC,UAAU,CAAC,QAAQ,YAAY,IAAI,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;YACpE,CAAC;YACD,SAAS,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QAC3C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAMD,kBAAkB,CAAC,YAA2B;QAC5C,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,EAAmB,EAAE,CAAC,EAAE,YAAY,SAAS,CAAC,CAAC;QAEzF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,aAAa,CAAC,IAAI,CAChB,0BAA0B;gBACxB,iEAAiE,CACpE,CAAC;YACF,OAAO;QACT,CAAC;QAGD,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,SAAS,GAAG,CAAC,CAAC;QAElB,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5B,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC;YAEzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC/B,SAAS,EAAE,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,eAAe,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,GAAG,CAAC;YAEtD,IAAI,eAAe,GAAG,EAAE,IAAI,SAAS,GAAG,EAAE,EAAE,CAAC;gBAC3C,aAAa,CAAC,IAAI,CAChB,0BAA0B;oBACxB,0CAA0C,SAAS,WAAW,SAAS,UAAU,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB;oBAC5H,+DAA+D;oBAC/D,uEAAuE,CAC1E,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAQD,oBAAoB;QAClB,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QAC1D,MAAM,SAAS,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,SAAS,CAAC,eAAe,CAAC;QAG5C,MAAM,WAAW,GAAG,CAAC,QAAQ,GAAG,SAAS,CAAC,GAAG,GAAG,CAAC;QACjD,MAAM,MAAM,GAAG,QAAQ,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,SAAS,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;QAG9C,MAAM,KAAK,GAAG,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;QAClC,MAAM,UAAU,GAAG,QAAQ,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;QAG5C,MAAM,YAAY,GAAG,WAAW,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAG9D,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,IAAI,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC;QAGnE,IAAI,YAAY,IAAI,WAAW,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,0BAA0B;gBACxB,WAAW,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;gBAC7F,UAAU,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,QAAQ,OAAO;gBAC5D,eAAe,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;gBAC1C,6CAA6C;gBAC7C,uDAAuD;gBACvD,yCAAyC;gBACzC,mDAAmD;gBACnD,yDAAyD,CAC5D,CAAC;QACJ,CAAC;QAGD,IAAI,YAAY,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1D,aAAa,CAAC,IAAI,CAChB,2CAA2C,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;gBACpE,YAAY,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB;gBAClD,6CAA6C,CAChD,CAAC;QACJ,CAAC;IACH,CAAC;IAOD,YAAY,CAAC,YAA2B,EAAE,YAA0B;QAElE,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,EAAmB,EAAE,CAAC,EAAE,YAAY,SAAS,CAAC,CAAC;QACzF,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,EAAe,EAAE,CAAC,EAAE,YAAY,KAAK,CAAC,CAAC;QAC7E,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;QACzC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;QACjC,MAAM,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAGhD,MAAM,YAAY,GAChB,cAAc,GAAG,MAAM,CAAC,mBAAmB;YAC3C,UAAU,GAAG,MAAM,CAAC,eAAe;YACnC,MAAM,CAAC,oBAAoB,CAAC;QAG9B,MAAM,UAAU,GAAG,YAAY,CAAC,YAAY,EAAE,CAAC;QAG/C,MAAM,UAAU,GAAG,YAAY,GAAG,UAAU,CAAC;QAC7C,MAAM,OAAO,GAAG,UAAU,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;QAG3C,IAAI,OAA2B,CAAC;QAEhC,IAAI,OAAO,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;YACnC,OAAO;gBACL,kBAAkB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,sCAAsC,MAAM,CAAC,aAAa,MAAM;oBACpG,gGAAgG,CAAC;QACrG,CAAC;aAAM,IAAI,OAAO,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;YAC5C,OAAO;gBACL,kBAAkB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,MAAM,CAAC,eAAe,MAAM;oBAC/E,wEAAwE,CAAC;QAC7E,CAAC;QAED,OAAO;YACL,UAAU,EAAE,cAAc;YAC1B,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,UAAU;YAClB,iBAAiB,EAAE,YAAY;YAC/B,UAAU;YACV,mBAAmB,EAAE,UAAU;YAC/B,gBAAgB,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAChD,OAAO;SACR,CAAC;IACJ,CAAC;IAMD,YAAY,CACV,YAA2B,EAC3B,YAA0B;QAM1B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;QAGD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAU,EAAE;YAC5C,IAAI,KAAK,GAAG,IAAI;gBAAE,OAAO,GAAG,KAAK,IAAI,CAAC;YACtC,IAAI,KAAK,GAAG,IAAI,GAAG,IAAI;gBAAE,OAAO,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YAClE,OAAO,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QACpD,CAAC,CAAC;QAEF,OAAO;YACL,QAAQ,EAAE;gBACR,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,MAAM,EAAE,QAAQ,CAAC,MAAM;aACxB;YACD,IAAI,EAAE;gBACJ,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBAC5C,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC;gBACxC,KAAK,EAAE,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC;aACjD;YACD,QAAQ;SACT,CAAC;IACJ,CAAC;CACF","sourcesContent":["/**\n * DocumentValidator - Handles validation of document properties and content\n * Prevents security issues and data corruption\n */\n\nimport { Paragraph } from '../elements/Paragraph.js';\nimport { Table } from '../elements/Table.js';\nimport { ImageManager } from '../elements/ImageManager.js';\nimport type { DocumentProperties } from '../types/document-types.js';\nimport { BodyElement } from './DocumentContent.js';\nimport { LIMITS } from '../constants/limits.js';\nimport { defaultLogger } from '../utils/logger.js';\nimport * as v8 from 'v8';\n\n/**\n * Memory validation options\n */\nexport interface MemoryOptions {\n /** Maximum memory usage percentage (0-100) before throwing error. Default: 80 */\n maxMemoryUsagePercent?: number;\n /** Maximum absolute RSS (Resident Set Size) in MB. Default: 2048 (2GB) */\n maxRssMB?: number;\n /** Enable absolute RSS limit checking. Default: true */\n useAbsoluteLimit?: boolean;\n}\n\n/**\n * Size estimation result\n */\nexport interface SizeEstimate {\n paragraphs: number;\n tables: number;\n images: number;\n estimatedXmlBytes: number;\n imageBytes: number;\n totalEstimatedBytes: number;\n totalEstimatedMB: number;\n warning?: string;\n}\n\n/**\n * DocumentValidator handles all validation logic\n */\nexport class DocumentValidator {\n private maxMemoryUsagePercent: number;\n private maxRssMB: number;\n private useAbsoluteLimit: boolean;\n\n constructor(maxMemoryUsagePercent = 80, options: MemoryOptions = {}) {\n // Validate maxMemoryUsagePercent\n const memoryPercent = options.maxMemoryUsagePercent ?? maxMemoryUsagePercent;\n if (memoryPercent < 1 || memoryPercent > 100 || !Number.isFinite(memoryPercent)) {\n throw new Error('maxMemoryUsagePercent must be between 1 and 100');\n }\n this.maxMemoryUsagePercent = memoryPercent;\n this.maxRssMB = options.maxRssMB ?? 2048; // Default 2GB\n this.useAbsoluteLimit = options.useAbsoluteLimit ?? true;\n }\n\n /**\n * Validates and sanitizes document properties\n * Prevents injection attacks and excessive memory usage\n * @param properties - Properties to validate\n * @returns Validated and sanitized properties\n */\n static validateProperties(properties: DocumentProperties): DocumentProperties {\n const validated: DocumentProperties = {};\n\n // Validate and truncate string properties\n if (properties.title !== undefined) {\n if (typeof properties.title !== 'string') {\n throw new Error('DocumentProperties.title must be a string');\n }\n if (properties.title.length > LIMITS.MAX_STRING_LENGTH) {\n throw new Error(\n `DocumentProperties.title exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`\n );\n }\n validated.title = properties.title;\n }\n\n if (properties.subject !== undefined) {\n if (typeof properties.subject !== 'string') {\n throw new Error('DocumentProperties.subject must be a string');\n }\n if (properties.subject.length > LIMITS.MAX_STRING_LENGTH) {\n throw new Error(\n `DocumentProperties.subject exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`\n );\n }\n validated.subject = properties.subject;\n }\n\n if (properties.creator !== undefined) {\n if (typeof properties.creator !== 'string') {\n throw new Error('DocumentProperties.creator must be a string');\n }\n if (properties.creator.length > LIMITS.MAX_STRING_LENGTH) {\n throw new Error(\n `DocumentProperties.creator exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`\n );\n }\n validated.creator = properties.creator;\n }\n\n if (properties.keywords !== undefined) {\n if (typeof properties.keywords !== 'string') {\n throw new Error('DocumentProperties.keywords must be a string');\n }\n if (properties.keywords.length > LIMITS.MAX_STRING_LENGTH) {\n throw new Error(\n `DocumentProperties.keywords exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`\n );\n }\n validated.keywords = properties.keywords;\n }\n\n if (properties.description !== undefined) {\n if (typeof properties.description !== 'string') {\n throw new Error('DocumentProperties.description must be a string');\n }\n if (properties.description.length > LIMITS.MAX_STRING_LENGTH) {\n throw new Error(\n `DocumentProperties.description exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`\n );\n }\n validated.description = properties.description;\n }\n\n if (properties.lastModifiedBy !== undefined) {\n if (typeof properties.lastModifiedBy !== 'string') {\n throw new Error('DocumentProperties.lastModifiedBy must be a string');\n }\n if (properties.lastModifiedBy.length > LIMITS.MAX_STRING_LENGTH) {\n throw new Error(\n `DocumentProperties.lastModifiedBy exceeds maximum length of ${LIMITS.MAX_STRING_LENGTH} characters`\n );\n }\n validated.lastModifiedBy = properties.lastModifiedBy;\n }\n\n // Validate revision number\n if (properties.revision !== undefined) {\n if (typeof properties.revision !== 'number' || !Number.isInteger(properties.revision)) {\n throw new Error('DocumentProperties.revision must be an integer');\n }\n if (properties.revision < 0 || properties.revision > LIMITS.MAX_REVISION) {\n throw new Error(`DocumentProperties.revision must be between 0 and ${LIMITS.MAX_REVISION}`);\n }\n validated.revision = properties.revision;\n }\n\n // Validate dates\n if (properties.created !== undefined) {\n if (!(properties.created instanceof Date)) {\n throw new Error('DocumentProperties.created must be a Date object');\n }\n if (!Number.isFinite(properties.created.getTime())) {\n throw new Error('DocumentProperties.created is an invalid date');\n }\n validated.created = properties.created;\n }\n\n if (properties.modified !== undefined) {\n if (!(properties.modified instanceof Date)) {\n throw new Error('DocumentProperties.modified must be a Date object');\n }\n if (!Number.isFinite(properties.modified.getTime())) {\n throw new Error('DocumentProperties.modified is an invalid date');\n }\n validated.modified = properties.modified;\n }\n\n return validated;\n }\n\n /**\n * Validates that the document has meaningful content before saving\n * Warns if the document appears to be empty or corrupted\n */\n validateBeforeSave(bodyElements: BodyElement[]): void {\n const paragraphs = bodyElements.filter((el): el is Paragraph => el instanceof Paragraph);\n\n if (paragraphs.length === 0) {\n defaultLogger.warn(\n '\\nDocXML Save Warning:\\n' +\n 'Document has no paragraphs. You are saving an empty document.\\n'\n );\n return;\n }\n\n // Count runs with text\n let totalRuns = 0;\n let emptyRuns = 0;\n\n for (const para of paragraphs) {\n const runs = para.getRuns();\n totalRuns += runs.length;\n\n for (const run of runs) {\n if (run.getText().length === 0) {\n emptyRuns++;\n }\n }\n }\n\n if (totalRuns > 0) {\n const emptyPercentage = (emptyRuns / totalRuns) * 100;\n\n if (emptyPercentage > 90 && emptyRuns > 10) {\n defaultLogger.warn(\n '\\nDocXML Save Warning:\\n' +\n `You are about to save a document where ${emptyRuns} out of ${totalRuns} runs (${emptyPercentage.toFixed(1)}%) are empty.\\n` +\n 'This may result in a document with no visible text content.\\n' +\n 'If this is unintentional, please review the document before saving.\\n'\n );\n }\n }\n }\n\n /**\n * Checks current memory usage and throws if above threshold\n * Prevents out-of-memory errors by failing early\n * Uses both heap percentage and absolute RSS limits for better accuracy\n * @throws {Error} If memory usage exceeds configured limits\n */\n checkMemoryThreshold(): void {\n const { heapUsed, external, rss } = process.memoryUsage();\n const heapStats = v8.getHeapStatistics();\n const heapLimit = heapStats.heap_size_limit; // Actual max heap (typically 4GB on 64-bit)\n\n // Calculate heap usage percentage against the actual limit, not currently allocated\n const heapPercent = (heapUsed / heapLimit) * 100;\n const heapMB = heapUsed / (1024 * 1024);\n const heapLimitMB = heapLimit / (1024 * 1024);\n\n // Calculate RSS (Resident Set Size - actual memory used by process)\n const rssMB = rss / (1024 * 1024);\n const externalMB = external / (1024 * 1024);\n\n // Check heap percentage (protects against heap fragmentation)\n const heapExceeded = heapPercent > this.maxMemoryUsagePercent;\n\n // Check absolute RSS limit (protects against excessive total memory)\n const rssExceeded = this.useAbsoluteLimit && rssMB > this.maxRssMB;\n\n // Only throw if BOTH conditions are true (avoids false positives)\n if (heapExceeded && rssExceeded) {\n throw new Error(\n `Memory usage critical:\\n` +\n ` Heap: ${heapMB.toFixed(0)}MB / ${heapLimitMB.toFixed(0)}MB (${heapPercent.toFixed(1)}%)\\n` +\n ` RSS: ${rssMB.toFixed(0)}MB (limit: ${this.maxRssMB}MB)\\n` +\n ` External: ${externalMB.toFixed(0)}MB\\n` +\n `Cannot process document safely. Consider:\\n` +\n ` - Reducing document size (remove/compress images)\\n` +\n ` - Splitting into multiple documents\\n` +\n ` - Increasing memory limits in DocumentOptions\\n` +\n ` - Increasing Node.js heap size (--max-old-space-size)`\n );\n }\n\n // Warn if only heap exceeded (might be temporary fragmentation)\n if (heapExceeded && !rssExceeded && this.useAbsoluteLimit) {\n defaultLogger.warn(\n `DocXML Memory Warning: Heap usage high (${heapPercent.toFixed(1)}%) ` +\n `but RSS (${rssMB.toFixed(0)}MB) is below limit. ` +\n `This might be temporary heap fragmentation.`\n );\n }\n }\n\n /**\n * Estimates the size of the document\n * Provides breakdown by component and warnings if size is too large\n * @returns Size estimation with breakdown and optional warning\n */\n estimateSize(bodyElements: BodyElement[], imageManager: ImageManager): SizeEstimate {\n // Count elements\n const paragraphs = bodyElements.filter((el): el is Paragraph => el instanceof Paragraph);\n const tables = bodyElements.filter((el): el is Table => el instanceof Table);\n const paragraphCount = paragraphs.length;\n const tableCount = tables.length;\n const imageCount = imageManager.getImageCount();\n\n // Estimate XML size using documented constants\n const estimatedXml =\n paragraphCount * LIMITS.BYTES_PER_PARAGRAPH +\n tableCount * LIMITS.BYTES_PER_TABLE +\n LIMITS.BASE_STRUCTURE_BYTES;\n\n // Get actual image sizes\n const imageBytes = imageManager.getTotalSize();\n\n // Total estimate\n const totalBytes = estimatedXml + imageBytes;\n const totalMB = totalBytes / (1024 * 1024);\n\n // Use documented threshold constants\n let warning: string | undefined;\n\n if (totalMB > LIMITS.ERROR_SIZE_MB) {\n warning =\n `Document size (${totalMB.toFixed(1)}MB) exceeds recommended maximum of ${LIMITS.ERROR_SIZE_MB}MB. ` +\n `This may cause memory issues. Consider splitting into multiple documents or optimizing images.`;\n } else if (totalMB > LIMITS.WARNING_SIZE_MB) {\n warning =\n `Document size (${totalMB.toFixed(1)}MB) exceeds ${LIMITS.WARNING_SIZE_MB}MB. ` +\n `Large documents may take longer to process and use significant memory.`;\n }\n\n return {\n paragraphs: paragraphCount,\n tables: tableCount,\n images: imageCount,\n estimatedXmlBytes: estimatedXml,\n imageBytes,\n totalEstimatedBytes: totalBytes,\n totalEstimatedMB: parseFloat(totalMB.toFixed(2)),\n warning,\n };\n }\n\n /**\n * Gets size statistics for the document\n * @returns Size statistics\n */\n getSizeStats(\n bodyElements: BodyElement[],\n imageManager: ImageManager\n ): {\n elements: { paragraphs: number; tables: number; images: number };\n size: { xml: string; images: string; total: string };\n warnings: string[];\n } {\n const estimate = this.estimateSize(bodyElements, imageManager);\n const warnings: string[] = [];\n\n if (estimate.warning) {\n warnings.push(estimate.warning);\n }\n\n // Format sizes for display\n const formatBytes = (bytes: number): string => {\n if (bytes < 1024) return `${bytes} B`;\n if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;\n return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;\n };\n\n return {\n elements: {\n paragraphs: estimate.paragraphs,\n tables: estimate.tables,\n images: estimate.images,\n },\n size: {\n xml: formatBytes(estimate.estimatedXmlBytes),\n images: formatBytes(estimate.imageBytes),\n total: formatBytes(estimate.totalEstimatedBytes),\n },\n warnings,\n };\n }\n}\n"]}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { KeyedRegistry } from '../utils/KeyedRegistry.js';
|
|
2
|
+
class ElementRegistryImpl {
|
|
3
|
+
inner = new KeyedRegistry('ElementRegistry');
|
|
4
|
+
register(tag, handler) {
|
|
5
|
+
this.inner.register(tag, handler);
|
|
6
|
+
}
|
|
7
|
+
unregister(tag) {
|
|
8
|
+
return this.inner.unregister(tag);
|
|
9
|
+
}
|
|
10
|
+
has(tag) {
|
|
11
|
+
return this.inner.has(tag);
|
|
12
|
+
}
|
|
13
|
+
get(tag) {
|
|
14
|
+
return this.inner.get(tag);
|
|
15
|
+
}
|
|
16
|
+
registeredTags() {
|
|
17
|
+
return this.inner.keys();
|
|
18
|
+
}
|
|
19
|
+
clear() {
|
|
20
|
+
this.inner.clear();
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
export const ElementRegistry = new ElementRegistryImpl();
|
|
24
|
+
//# sourceMappingURL=ElementRegistry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ElementRegistry.js","sourceRoot":"","sources":["../../../src/core/ElementRegistry.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAkB1D,MAAM,mBAAmB;IACN,KAAK,GAAG,IAAI,aAAa,CAA0B,iBAAiB,CAAC,CAAC;IAEvF,QAAQ,CAAI,GAAW,EAAE,OAA0B;QACjD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAkC,CAAC,CAAC;IAC/D,CAAC;IAED,UAAU,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,GAAG,CAAC,GAAW;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,GAAG,CAAc,GAAW;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAkC,CAAC;IAC9D,CAAC;IAGD,cAAc;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAGD,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAGD,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,mBAAmB,EAAE,CAAC","sourcesContent":["/**\n * Plugin extension point for custom OOXML element handlers. When the\n * parser encounters an unknown qualified-name child of the body and a\n * handler is registered for that tag, the handler's `parse()` is invoked\n * and the result becomes a `PreservedElement` carrying the original raw\n * XML (so save round-trips byte-for-byte). Handlers that return objects\n * with a `toXml()` method allow consumers to roundtrip through their\n * own model — see DocumentParser.processBodyElement for the contract.\n *\n * Registration is process-global; clear via `clear()` between tests.\n *\n * @example\n * ```typescript\n * ElementRegistry.register('myco:specialBlock', {\n * parse: (xml) => new MySpecialBlock(xml),\n * serialize: (element) => (element as MySpecialBlock).toXML(),\n * });\n * ```\n */\nimport { KeyedRegistry } from '../utils/KeyedRegistry.js';\n\nexport interface ElementHandler<E = unknown> {\n /** Parse the raw XML fragment for this element into a model object. */\n parse(rawXml: string, context?: ElementParseContext): E;\n /** Serialize the model object back to raw XML. */\n serialize(element: E, context?: ElementSerializeContext): string;\n}\n\nexport interface ElementParseContext {\n /** Path of the OOXML part being parsed (e.g., 'word/document.xml'). */\n partPath?: string;\n}\n\nexport interface ElementSerializeContext {\n partPath?: string;\n}\n\nclass ElementRegistryImpl {\n private readonly inner = new KeyedRegistry<ElementHandler<unknown>>('ElementRegistry');\n\n register<E>(tag: string, handler: ElementHandler<E>): void {\n this.inner.register(tag, handler as ElementHandler<unknown>);\n }\n\n unregister(tag: string): boolean {\n return this.inner.unregister(tag);\n }\n\n has(tag: string): boolean {\n return this.inner.has(tag);\n }\n\n get<E = unknown>(tag: string): ElementHandler<E> | undefined {\n return this.inner.get(tag) as ElementHandler<E> | undefined;\n }\n\n /** Returns the list of currently-registered tags (snapshot). */\n registeredTags(): string[] {\n return this.inner.keys();\n }\n\n /** Remove all handlers — primarily for test isolation. */\n clear(): void {\n this.inner.clear();\n }\n}\n\n/** Process-global element registry instance. */\nexport const ElementRegistry = new ElementRegistryImpl();\n"]}
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
import { XMLBuilder } from '../xml/XMLBuilder.js';
|
|
2
|
+
export var RelationshipType;
|
|
3
|
+
(function (RelationshipType) {
|
|
4
|
+
RelationshipType["STYLES"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles";
|
|
5
|
+
RelationshipType["NUMBERING"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering";
|
|
6
|
+
RelationshipType["IMAGE"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image";
|
|
7
|
+
RelationshipType["HEADER"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header";
|
|
8
|
+
RelationshipType["FOOTER"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer";
|
|
9
|
+
RelationshipType["FONT_TABLE"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable";
|
|
10
|
+
RelationshipType["SETTINGS"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings";
|
|
11
|
+
RelationshipType["THEME"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme";
|
|
12
|
+
RelationshipType["HYPERLINK"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink";
|
|
13
|
+
RelationshipType["COMMENTS"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments";
|
|
14
|
+
RelationshipType["FOOTNOTES"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes";
|
|
15
|
+
RelationshipType["ENDNOTES"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/endnotes";
|
|
16
|
+
RelationshipType["WEB_SETTINGS"] = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings";
|
|
17
|
+
RelationshipType["PEOPLE"] = "http://schemas.microsoft.com/office/2011/relationships/people";
|
|
18
|
+
})(RelationshipType || (RelationshipType = {}));
|
|
19
|
+
export class Relationship {
|
|
20
|
+
id;
|
|
21
|
+
type;
|
|
22
|
+
target;
|
|
23
|
+
targetMode;
|
|
24
|
+
constructor(properties) {
|
|
25
|
+
this.id = properties.id;
|
|
26
|
+
this.type = properties.type;
|
|
27
|
+
this.target = properties.target;
|
|
28
|
+
this.targetMode = properties.targetMode || 'Internal';
|
|
29
|
+
this.validate();
|
|
30
|
+
}
|
|
31
|
+
validate() {
|
|
32
|
+
if (!this.id?.startsWith('rId')) {
|
|
33
|
+
throw new Error(`Relationship ID must start with 'rId', got '${this.id}'`);
|
|
34
|
+
}
|
|
35
|
+
if (!this.type) {
|
|
36
|
+
throw new Error('Relationship type is required');
|
|
37
|
+
}
|
|
38
|
+
if (!this.target) {
|
|
39
|
+
throw new Error('Relationship target is required');
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
getId() {
|
|
43
|
+
return this.id;
|
|
44
|
+
}
|
|
45
|
+
getType() {
|
|
46
|
+
return this.type;
|
|
47
|
+
}
|
|
48
|
+
getTarget() {
|
|
49
|
+
return this.target;
|
|
50
|
+
}
|
|
51
|
+
setTarget(target) {
|
|
52
|
+
if (!target) {
|
|
53
|
+
throw new Error('Relationship target cannot be empty');
|
|
54
|
+
}
|
|
55
|
+
this.target = target;
|
|
56
|
+
}
|
|
57
|
+
getTargetMode() {
|
|
58
|
+
return this.targetMode;
|
|
59
|
+
}
|
|
60
|
+
isExternal() {
|
|
61
|
+
return this.targetMode === 'External';
|
|
62
|
+
}
|
|
63
|
+
toXML() {
|
|
64
|
+
const escapedId = XMLBuilder.escapeXmlAttribute(this.id);
|
|
65
|
+
const escapedType = XMLBuilder.escapeXmlAttribute(this.type);
|
|
66
|
+
const escapedTarget = XMLBuilder.escapeXmlAttribute(this.target);
|
|
67
|
+
let xml = ` <Relationship Id="${escapedId}" Type="${escapedType}" Target="${escapedTarget}"`;
|
|
68
|
+
if (this.targetMode === 'External') {
|
|
69
|
+
xml += ` TargetMode="External"`;
|
|
70
|
+
}
|
|
71
|
+
xml += '/>';
|
|
72
|
+
return xml;
|
|
73
|
+
}
|
|
74
|
+
static create(properties) {
|
|
75
|
+
return new Relationship(properties);
|
|
76
|
+
}
|
|
77
|
+
static createStyles(id = 'rId1') {
|
|
78
|
+
return new Relationship({
|
|
79
|
+
id,
|
|
80
|
+
type: RelationshipType.STYLES,
|
|
81
|
+
target: 'styles.xml',
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
static createNumbering(id = 'rId2') {
|
|
85
|
+
return new Relationship({
|
|
86
|
+
id,
|
|
87
|
+
type: RelationshipType.NUMBERING,
|
|
88
|
+
target: 'numbering.xml',
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
static createFontTable(id = 'rId3') {
|
|
92
|
+
return new Relationship({
|
|
93
|
+
id,
|
|
94
|
+
type: RelationshipType.FONT_TABLE,
|
|
95
|
+
target: 'fontTable.xml',
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
static createSettings(id = 'rId4') {
|
|
99
|
+
return new Relationship({
|
|
100
|
+
id,
|
|
101
|
+
type: RelationshipType.SETTINGS,
|
|
102
|
+
target: 'settings.xml',
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
static createWebSettings(id = 'rId5') {
|
|
106
|
+
return new Relationship({
|
|
107
|
+
id,
|
|
108
|
+
type: RelationshipType.WEB_SETTINGS,
|
|
109
|
+
target: 'webSettings.xml',
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
static createTheme(id = 'rId6') {
|
|
113
|
+
return new Relationship({
|
|
114
|
+
id,
|
|
115
|
+
type: RelationshipType.THEME,
|
|
116
|
+
target: 'theme/theme1.xml',
|
|
117
|
+
});
|
|
118
|
+
}
|
|
119
|
+
static createImage(id, target) {
|
|
120
|
+
return new Relationship({
|
|
121
|
+
id,
|
|
122
|
+
type: RelationshipType.IMAGE,
|
|
123
|
+
target,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
static createHeader(id, target) {
|
|
127
|
+
return new Relationship({
|
|
128
|
+
id,
|
|
129
|
+
type: RelationshipType.HEADER,
|
|
130
|
+
target,
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
static createFooter(id, target) {
|
|
134
|
+
return new Relationship({
|
|
135
|
+
id,
|
|
136
|
+
type: RelationshipType.FOOTER,
|
|
137
|
+
target,
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
static createHyperlink(id, url) {
|
|
141
|
+
return new Relationship({
|
|
142
|
+
id,
|
|
143
|
+
type: RelationshipType.HYPERLINK,
|
|
144
|
+
target: url,
|
|
145
|
+
targetMode: 'External',
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
static createComments(id) {
|
|
149
|
+
return new Relationship({
|
|
150
|
+
id,
|
|
151
|
+
type: RelationshipType.COMMENTS,
|
|
152
|
+
target: 'comments.xml',
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
static createFootnotes(id) {
|
|
156
|
+
return new Relationship({
|
|
157
|
+
id,
|
|
158
|
+
type: RelationshipType.FOOTNOTES,
|
|
159
|
+
target: 'footnotes.xml',
|
|
160
|
+
});
|
|
161
|
+
}
|
|
162
|
+
static createEndnotes(id) {
|
|
163
|
+
return new Relationship({
|
|
164
|
+
id,
|
|
165
|
+
type: RelationshipType.ENDNOTES,
|
|
166
|
+
target: 'endnotes.xml',
|
|
167
|
+
});
|
|
168
|
+
}
|
|
169
|
+
static createPeople(id) {
|
|
170
|
+
return new Relationship({
|
|
171
|
+
id,
|
|
172
|
+
type: RelationshipType.PEOPLE,
|
|
173
|
+
target: 'people.xml',
|
|
174
|
+
});
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
//# sourceMappingURL=Relationship.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../../src/core/Relationship.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAKlD,MAAM,CAAN,IAAY,gBA0CX;AA1CD,WAAY,gBAAgB;IAE1B,yGAAqF,CAAA;IAGrF,+GAA2F,CAAA;IAG3F,uGAAmF,CAAA;IAGnF,yGAAqF,CAAA;IAGrF,yGAAqF,CAAA;IAGrF,gHAA4F,CAAA;IAG5F,6GAAyF,CAAA;IAGzF,uGAAmF,CAAA;IAGnF,+GAA2F,CAAA;IAG3F,6GAAyF,CAAA;IAGzF,+GAA2F,CAAA;IAG3F,6GAAyF,CAAA;IAGzF,oHAAgG,CAAA;IAGhG,4FAAwE,CAAA;AAC1E,CAAC,EA1CW,gBAAgB,KAAhB,gBAAgB,QA0C3B;AAsBD,MAAM,OAAO,YAAY;IACf,EAAE,CAAS;IACX,IAAI,CAAS;IACb,MAAM,CAAS;IACf,UAAU,CAA0B;IAM5C,YAAY,UAAkC;QAC5C,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;QAChC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,UAAU,CAAC;QAEtD,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAKO,QAAQ;QACd,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,+CAA+C,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QAC7E,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAKD,KAAK;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAKD,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAKD,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAYD,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAKD,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAKD,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,KAAK,UAAU,CAAC;IACxC,CAAC;IAQD,KAAK;QAEH,MAAM,SAAS,GAAG,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEjE,IAAI,GAAG,GAAG,uBAAuB,SAAS,WAAW,WAAW,aAAa,aAAa,GAAG,CAAC;QAE9F,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;YACnC,GAAG,IAAI,wBAAwB,CAAC;QAClC,CAAC;QAED,GAAG,IAAI,IAAI,CAAC;QACZ,OAAO,GAAG,CAAC;IACb,CAAC;IAMD,MAAM,CAAC,MAAM,CAAC,UAAkC;QAC9C,OAAO,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAMD,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,MAAM;QAC7B,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,MAAM;YAC7B,MAAM,EAAE,YAAY;SACrB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,eAAe,CAAC,EAAE,GAAG,MAAM;QAChC,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,SAAS;YAChC,MAAM,EAAE,eAAe;SACxB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,eAAe,CAAC,EAAE,GAAG,MAAM;QAChC,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,UAAU;YACjC,MAAM,EAAE,eAAe;SACxB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,cAAc,CAAC,EAAE,GAAG,MAAM;QAC/B,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,QAAQ;YAC/B,MAAM,EAAE,cAAc;SACvB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,iBAAiB,CAAC,EAAE,GAAG,MAAM;QAClC,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,YAAY;YACnC,MAAM,EAAE,iBAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM;QAC5B,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,KAAK;YAC5B,MAAM,EAAE,kBAAkB;SAC3B,CAAC,CAAC;IACL,CAAC;IAOD,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,MAAc;QAC3C,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,KAAK;YAC5B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAOD,MAAM,CAAC,YAAY,CAAC,EAAU,EAAE,MAAc;QAC5C,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,MAAM;YAC7B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAOD,MAAM,CAAC,YAAY,CAAC,EAAU,EAAE,MAAc;QAC5C,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,MAAM;YAC7B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAOD,MAAM,CAAC,eAAe,CAAC,EAAU,EAAE,GAAW;QAC5C,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,SAAS;YAChC,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,UAAU;SACvB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,cAAc,CAAC,EAAU;QAC9B,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,QAAQ;YAC/B,MAAM,EAAE,cAAc;SACvB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,eAAe,CAAC,EAAU;QAC/B,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,SAAS;YAChC,MAAM,EAAE,eAAe;SACxB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,cAAc,CAAC,EAAU;QAC9B,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,QAAQ;YAC/B,MAAM,EAAE,cAAc;SACvB,CAAC,CAAC;IACL,CAAC;IAMD,MAAM,CAAC,YAAY,CAAC,EAAU;QAC5B,OAAO,IAAI,YAAY,CAAC;YACtB,EAAE;YACF,IAAI,EAAE,gBAAgB,CAAC,MAAM;YAC7B,MAAM,EAAE,YAAY;SACrB,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/**\n * Relationship - Represents an OpenXML relationship\n *\n * Relationships link document parts together (images, headers, footers, styles, etc.)\n * They are stored in _rels/*.xml.rels files throughout the document structure.\n */\n\nimport { XMLBuilder } from '../xml/XMLBuilder.js';\n\n/**\n * Relationship types used in Word documents\n */\nexport enum RelationshipType {\n /** Link to styles.xml */\n STYLES = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles',\n\n /** Link to numbering.xml */\n NUMBERING = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering',\n\n /** Link to an image */\n IMAGE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image',\n\n /** Link to a header */\n HEADER = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/header',\n\n /** Link to a footer */\n FOOTER = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer',\n\n /** Link to fontTable.xml */\n FONT_TABLE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable',\n\n /** Link to settings.xml */\n SETTINGS = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings',\n\n /** Link to theme */\n THEME = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme',\n\n /** Link to hyperlink */\n HYPERLINK = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink',\n\n /** Link to comments.xml */\n COMMENTS = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments',\n\n /** Link to footnotes.xml */\n FOOTNOTES = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes',\n\n /** Link to endnotes.xml */\n ENDNOTES = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/endnotes',\n\n /** Link to web settings */\n WEB_SETTINGS = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings',\n\n /** Link to people.xml (track changes authors) */\n PEOPLE = 'http://schemas.microsoft.com/office/2011/relationships/people',\n}\n\n/**\n * Properties for creating a relationship\n */\nexport interface RelationshipProperties {\n /** Relationship ID (e.g., 'rId1', 'rId2') */\n id: string;\n\n /** Relationship type (URL defining the relationship type) */\n type: string | RelationshipType;\n\n /** Target path (relative to the source part) */\n target: string;\n\n /** Target mode (Internal or External) */\n targetMode?: 'Internal' | 'External';\n}\n\n/**\n * Represents a single relationship in an OpenXML package\n */\nexport class Relationship {\n private id: string;\n private type: string;\n private target: string;\n private targetMode: 'Internal' | 'External';\n\n /**\n * Creates a new relationship\n * @param properties Relationship properties\n */\n constructor(properties: RelationshipProperties) {\n this.id = properties.id;\n this.type = properties.type;\n this.target = properties.target;\n this.targetMode = properties.targetMode || 'Internal';\n\n this.validate();\n }\n\n /**\n * Validates the relationship properties\n */\n private validate(): void {\n if (!this.id?.startsWith('rId')) {\n throw new Error(`Relationship ID must start with 'rId', got '${this.id}'`);\n }\n\n if (!this.type) {\n throw new Error('Relationship type is required');\n }\n\n if (!this.target) {\n throw new Error('Relationship target is required');\n }\n }\n\n /**\n * Gets the relationship ID\n */\n getId(): string {\n return this.id;\n }\n\n /**\n * Gets the relationship type\n */\n getType(): string {\n return this.type;\n }\n\n /**\n * Gets the target path\n */\n getTarget(): string {\n return this.target;\n }\n\n /**\n * Sets the target path\n *\n * This method allows updating the target of an existing relationship,\n * which is crucial for properly updating hyperlink URLs without creating\n * orphaned relationships. Per ECMA-376 §9.2, relationships can be modified\n * as long as the ID remains the same.\n *\n * @param target The new target path or URL\n */\n setTarget(target: string): void {\n if (!target) {\n throw new Error('Relationship target cannot be empty');\n }\n this.target = target;\n }\n\n /**\n * Gets the target mode\n */\n getTargetMode(): 'Internal' | 'External' {\n return this.targetMode;\n }\n\n /**\n * Checks if this relationship is external\n */\n isExternal(): boolean {\n return this.targetMode === 'External';\n }\n\n /**\n * Generates XML for this relationship\n *\n * **Security:** All attributes are properly XML-escaped to prevent injection attacks.\n * Per ECMA-376 Part 2 §9, relationship attributes must be escaped.\n */\n toXML(): string {\n // Escape all attributes to prevent XML injection\n const escapedId = XMLBuilder.escapeXmlAttribute(this.id);\n const escapedType = XMLBuilder.escapeXmlAttribute(this.type);\n const escapedTarget = XMLBuilder.escapeXmlAttribute(this.target);\n\n let xml = ` <Relationship Id=\"${escapedId}\" Type=\"${escapedType}\" Target=\"${escapedTarget}\"`;\n\n if (this.targetMode === 'External') {\n xml += ` TargetMode=\"External\"`;\n }\n\n xml += '/>';\n return xml;\n }\n\n /**\n * Factory method to create a relationship\n * @param properties Relationship properties\n */\n static create(properties: RelationshipProperties): Relationship {\n return new Relationship(properties);\n }\n\n /**\n * Creates a styles relationship\n * @param id Relationship ID\n */\n static createStyles(id = 'rId1'): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.STYLES,\n target: 'styles.xml',\n });\n }\n\n /**\n * Creates a numbering relationship\n * @param id Relationship ID\n */\n static createNumbering(id = 'rId2'): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.NUMBERING,\n target: 'numbering.xml',\n });\n }\n\n /**\n * Creates a fontTable relationship\n * @param id Relationship ID (defaults to 'rId3')\n */\n static createFontTable(id = 'rId3'): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.FONT_TABLE,\n target: 'fontTable.xml',\n });\n }\n\n /**\n * Creates a settings relationship\n * @param id Relationship ID (defaults to 'rId4')\n */\n static createSettings(id = 'rId4'): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.SETTINGS,\n target: 'settings.xml',\n });\n }\n\n /**\n * Creates a webSettings relationship\n * @param id Relationship ID (defaults to 'rId5')\n */\n static createWebSettings(id = 'rId5'): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.WEB_SETTINGS,\n target: 'webSettings.xml',\n });\n }\n\n /**\n * Creates a theme relationship\n * @param id Relationship ID (defaults to 'rId6')\n */\n static createTheme(id = 'rId6'): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.THEME,\n target: 'theme/theme1.xml',\n });\n }\n\n /**\n * Creates an image relationship\n * @param id Relationship ID\n * @param target Image path (e.g., 'media/image1.png')\n */\n static createImage(id: string, target: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.IMAGE,\n target,\n });\n }\n\n /**\n * Creates a header relationship\n * @param id Relationship ID\n * @param target Header file path (e.g., 'header1.xml')\n */\n static createHeader(id: string, target: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.HEADER,\n target,\n });\n }\n\n /**\n * Creates a footer relationship\n * @param id Relationship ID\n * @param target Footer file path (e.g., 'footer1.xml')\n */\n static createFooter(id: string, target: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.FOOTER,\n target,\n });\n }\n\n /**\n * Creates a hyperlink relationship (external)\n * @param id Relationship ID\n * @param url Hyperlink URL\n */\n static createHyperlink(id: string, url: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.HYPERLINK,\n target: url,\n targetMode: 'External',\n });\n }\n\n /**\n * Creates a comments relationship\n * @param id Relationship ID (required - use RelationshipManager.generateId())\n */\n static createComments(id: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.COMMENTS,\n target: 'comments.xml',\n });\n }\n\n /**\n * Creates a footnotes relationship\n * @param id Relationship ID (required - use RelationshipManager.generateId())\n */\n static createFootnotes(id: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.FOOTNOTES,\n target: 'footnotes.xml',\n });\n }\n\n /**\n * Creates an endnotes relationship\n * @param id Relationship ID (required - use RelationshipManager.generateId())\n */\n static createEndnotes(id: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.ENDNOTES,\n target: 'endnotes.xml',\n });\n }\n\n /**\n * Creates a people relationship (track changes authors)\n * @param id Relationship ID (required - use RelationshipManager.generateId())\n */\n static createPeople(id: string): Relationship {\n return new Relationship({\n id,\n type: RelationshipType.PEOPLE,\n target: 'people.xml',\n });\n }\n}\n"]}
|