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,202 @@
|
|
|
1
|
+
import { Relationship, RelationshipType } from './Relationship.js';
|
|
2
|
+
import { XMLParser } from '../xml/XMLParser.js';
|
|
3
|
+
import { sanitizeHyperlinkUrl } from '../utils/validation.js';
|
|
4
|
+
import { InvalidDocxError, CorruptedArchiveError } from '../zip/errors.js';
|
|
5
|
+
export class RelationshipManager {
|
|
6
|
+
relationships;
|
|
7
|
+
nextId;
|
|
8
|
+
constructor() {
|
|
9
|
+
this.relationships = new Map();
|
|
10
|
+
this.nextId = 1;
|
|
11
|
+
}
|
|
12
|
+
addRelationship(relationship) {
|
|
13
|
+
this.relationships.set(relationship.getId(), relationship);
|
|
14
|
+
const idMatch = /^rId(\d+)$/.exec(relationship.getId());
|
|
15
|
+
if (idMatch?.[1]) {
|
|
16
|
+
const idNum = parseInt(idMatch[1], 10);
|
|
17
|
+
if (idNum >= this.nextId) {
|
|
18
|
+
this.nextId = idNum + 1;
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
return relationship;
|
|
22
|
+
}
|
|
23
|
+
getRelationship(id) {
|
|
24
|
+
return this.relationships.get(id);
|
|
25
|
+
}
|
|
26
|
+
getAllRelationships() {
|
|
27
|
+
return Array.from(this.relationships.values());
|
|
28
|
+
}
|
|
29
|
+
getRelationshipsByType(type) {
|
|
30
|
+
return this.getAllRelationships().filter((rel) => rel.getType() === type);
|
|
31
|
+
}
|
|
32
|
+
hasRelationship(id) {
|
|
33
|
+
return this.relationships.has(id);
|
|
34
|
+
}
|
|
35
|
+
removeRelationship(id) {
|
|
36
|
+
return this.relationships.delete(id);
|
|
37
|
+
}
|
|
38
|
+
getCount() {
|
|
39
|
+
return this.relationships.size;
|
|
40
|
+
}
|
|
41
|
+
clear() {
|
|
42
|
+
this.relationships.clear();
|
|
43
|
+
this.nextId = 1;
|
|
44
|
+
return this;
|
|
45
|
+
}
|
|
46
|
+
generateId() {
|
|
47
|
+
return `rId${this.nextId++}`;
|
|
48
|
+
}
|
|
49
|
+
addStyles() {
|
|
50
|
+
const id = this.generateId();
|
|
51
|
+
return this.addRelationship(Relationship.createStyles(id));
|
|
52
|
+
}
|
|
53
|
+
addNumbering() {
|
|
54
|
+
const id = this.generateId();
|
|
55
|
+
return this.addRelationship(Relationship.createNumbering(id));
|
|
56
|
+
}
|
|
57
|
+
addFontTable() {
|
|
58
|
+
const id = this.generateId();
|
|
59
|
+
return this.addRelationship(Relationship.createFontTable(id));
|
|
60
|
+
}
|
|
61
|
+
addSettings() {
|
|
62
|
+
const id = this.generateId();
|
|
63
|
+
return this.addRelationship(Relationship.createSettings(id));
|
|
64
|
+
}
|
|
65
|
+
addWebSettings() {
|
|
66
|
+
const id = this.generateId();
|
|
67
|
+
return this.addRelationship(Relationship.createWebSettings(id));
|
|
68
|
+
}
|
|
69
|
+
addTheme() {
|
|
70
|
+
const id = this.generateId();
|
|
71
|
+
return this.addRelationship(Relationship.createTheme(id));
|
|
72
|
+
}
|
|
73
|
+
addImage(target) {
|
|
74
|
+
const id = this.generateId();
|
|
75
|
+
return this.addRelationship(Relationship.createImage(id, target));
|
|
76
|
+
}
|
|
77
|
+
addHeader(target) {
|
|
78
|
+
const id = this.generateId();
|
|
79
|
+
return this.addRelationship(Relationship.createHeader(id, target));
|
|
80
|
+
}
|
|
81
|
+
addFooter(target) {
|
|
82
|
+
const id = this.generateId();
|
|
83
|
+
return this.addRelationship(Relationship.createFooter(id, target));
|
|
84
|
+
}
|
|
85
|
+
addHyperlink(url) {
|
|
86
|
+
const id = this.generateId();
|
|
87
|
+
return this.addRelationship(Relationship.createHyperlink(id, url));
|
|
88
|
+
}
|
|
89
|
+
updateHyperlinkTarget(relationshipId, newUrl) {
|
|
90
|
+
const relationship = this.getRelationship(relationshipId);
|
|
91
|
+
if (!relationship) {
|
|
92
|
+
return false;
|
|
93
|
+
}
|
|
94
|
+
if (relationship.getType() !== RelationshipType.HYPERLINK) {
|
|
95
|
+
throw new InvalidDocxError(`Relationship ${relationshipId} is not a hyperlink relationship. ` +
|
|
96
|
+
`Type is ${relationship.getType()}, expected ${RelationshipType.HYPERLINK}`);
|
|
97
|
+
}
|
|
98
|
+
relationship.setTarget(newUrl);
|
|
99
|
+
return true;
|
|
100
|
+
}
|
|
101
|
+
findHyperlinkByTarget(targetUrl) {
|
|
102
|
+
return this.getAllRelationships().find((rel) => rel.getType() === RelationshipType.HYPERLINK && rel.getTarget() === targetUrl);
|
|
103
|
+
}
|
|
104
|
+
getOrCreateHyperlink(url) {
|
|
105
|
+
const existing = this.findHyperlinkByTarget(url);
|
|
106
|
+
if (existing) {
|
|
107
|
+
return existing;
|
|
108
|
+
}
|
|
109
|
+
return this.addHyperlink(url);
|
|
110
|
+
}
|
|
111
|
+
removeOrphanedHyperlinks(referencedIds) {
|
|
112
|
+
let removed = 0;
|
|
113
|
+
const toRemove = [];
|
|
114
|
+
for (const rel of this.getAllRelationships()) {
|
|
115
|
+
if (rel.getType() === RelationshipType.HYPERLINK && !referencedIds.has(rel.getId())) {
|
|
116
|
+
toRemove.push(rel.getId());
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
for (const id of toRemove) {
|
|
120
|
+
if (this.removeRelationship(id)) {
|
|
121
|
+
removed++;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
return removed;
|
|
125
|
+
}
|
|
126
|
+
addComments() {
|
|
127
|
+
const id = this.generateId();
|
|
128
|
+
return this.addRelationship(Relationship.createComments(id));
|
|
129
|
+
}
|
|
130
|
+
addFootnotes() {
|
|
131
|
+
const id = this.generateId();
|
|
132
|
+
return this.addRelationship(Relationship.createFootnotes(id));
|
|
133
|
+
}
|
|
134
|
+
addEndnotes() {
|
|
135
|
+
const id = this.generateId();
|
|
136
|
+
return this.addRelationship(Relationship.createEndnotes(id));
|
|
137
|
+
}
|
|
138
|
+
addPeople() {
|
|
139
|
+
const id = this.generateId();
|
|
140
|
+
return this.addRelationship(Relationship.createPeople(id));
|
|
141
|
+
}
|
|
142
|
+
generateXml() {
|
|
143
|
+
const relationships = this.getAllRelationships();
|
|
144
|
+
let xml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n';
|
|
145
|
+
xml += '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">\n';
|
|
146
|
+
for (const rel of relationships) {
|
|
147
|
+
xml += rel.toXML() + '\n';
|
|
148
|
+
}
|
|
149
|
+
xml += '</Relationships>';
|
|
150
|
+
return xml;
|
|
151
|
+
}
|
|
152
|
+
static createForDocument() {
|
|
153
|
+
const manager = new RelationshipManager();
|
|
154
|
+
manager.addStyles();
|
|
155
|
+
manager.addNumbering();
|
|
156
|
+
manager.addFontTable();
|
|
157
|
+
manager.addSettings();
|
|
158
|
+
manager.addWebSettings();
|
|
159
|
+
manager.addTheme();
|
|
160
|
+
return manager;
|
|
161
|
+
}
|
|
162
|
+
static create() {
|
|
163
|
+
return new RelationshipManager();
|
|
164
|
+
}
|
|
165
|
+
static fromXml(xml) {
|
|
166
|
+
const manager = new RelationshipManager();
|
|
167
|
+
if (xml.length > 10000000) {
|
|
168
|
+
throw new CorruptedArchiveError('Relationships XML file too large (>10MB). Possible malicious input or corrupted file.');
|
|
169
|
+
}
|
|
170
|
+
const relationshipElements = XMLParser.extractElements(xml, 'Relationship');
|
|
171
|
+
if (relationshipElements.length > 1000) {
|
|
172
|
+
throw new CorruptedArchiveError('Too many relationships in XML file (>1000). Possible malicious input.');
|
|
173
|
+
}
|
|
174
|
+
for (const relationshipElement of relationshipElements) {
|
|
175
|
+
const id = XMLParser.extractAttribute(relationshipElement, 'Id');
|
|
176
|
+
const type = XMLParser.extractAttribute(relationshipElement, 'Type');
|
|
177
|
+
const target = XMLParser.extractAttribute(relationshipElement, 'Target');
|
|
178
|
+
const targetMode = XMLParser.extractAttribute(relationshipElement, 'TargetMode');
|
|
179
|
+
if (id && type && target) {
|
|
180
|
+
const validatedTargetMode = targetMode === 'Internal' || targetMode === 'External' || targetMode === undefined
|
|
181
|
+
? targetMode
|
|
182
|
+
: undefined;
|
|
183
|
+
let sanitizedTarget = target;
|
|
184
|
+
if (type.endsWith('/hyperlink')) {
|
|
185
|
+
const result = sanitizeHyperlinkUrl(target);
|
|
186
|
+
if (result) {
|
|
187
|
+
sanitizedTarget = result.url;
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
const relationship = Relationship.create({
|
|
191
|
+
id,
|
|
192
|
+
type,
|
|
193
|
+
target: sanitizedTarget,
|
|
194
|
+
targetMode: validatedTargetMode || 'Internal',
|
|
195
|
+
});
|
|
196
|
+
manager.addRelationship(relationship);
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
return manager;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
//# sourceMappingURL=RelationshipManager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RelationshipManager.js","sourceRoot":"","sources":["../../../src/core/RelationshipManager.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAK3E,MAAM,OAAO,mBAAmB;IACtB,aAAa,CAA4B;IACzC,MAAM,CAAS;IAKvB;QACE,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAOD,eAAe,CAAC,YAA0B;QACxC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,YAAY,CAAC,CAAC;QAG3D,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC;QACxD,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACvC,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACzB,IAAI,CAAC,MAAM,GAAG,KAAK,GAAG,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAMD,eAAe,CAAC,EAAU;QACxB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAKD,mBAAmB;QACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAMD,sBAAsB,CAAC,IAA+B;QACpD,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,CAAC;IAC5E,CAAC;IAMD,eAAe,CAAC,EAAU;QACxB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAOD,kBAAkB,CAAC,EAAU;QAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAKD,QAAQ;QACN,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;IACjC,CAAC;IAKD,KAAK;QACH,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAMD,UAAU;QACR,OAAO,MAAM,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IAC/B,CAAC;IAMD,SAAS;QACP,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IAMD,YAAY;QACV,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAMD,YAAY;QACV,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAMD,WAAW;QACT,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC;IAMD,cAAc;QACZ,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC;IAMD,QAAQ;QACN,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;IAOD,QAAQ,CAAC,MAAc;QACrB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IACpE,CAAC;IAOD,SAAS,CAAC,MAAc;QACtB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;IAOD,SAAS,CAAC,MAAc;QACtB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;IAOD,YAAY,CAAC,GAAW;QACtB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IACrE,CAAC;IAaD,qBAAqB,CAAC,cAAsB,EAAE,MAAc;QAC1D,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAC1D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACf,CAAC;QAGD,IAAI,YAAY,CAAC,OAAO,EAAE,KAAK,gBAAgB,CAAC,SAAS,EAAE,CAAC;YAC1D,MAAM,IAAI,gBAAgB,CACxB,gBAAgB,cAAc,oCAAoC;gBAChE,WAAW,YAAY,CAAC,OAAO,EAAE,cAAc,gBAAgB,CAAC,SAAS,EAAE,CAC9E,CAAC;QACJ,CAAC;QAGD,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAQD,qBAAqB,CAAC,SAAiB;QACrC,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,IAAI,CACpC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,gBAAgB,CAAC,SAAS,IAAI,GAAG,CAAC,SAAS,EAAE,KAAK,SAAS,CACvF,CAAC;IACJ,CAAC;IAYD,oBAAoB,CAAC,GAAW;QAE9B,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC;QAGD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAYD,wBAAwB,CAAC,aAA0B;QACjD,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,MAAM,QAAQ,GAAa,EAAE,CAAC;QAG9B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC7C,IAAI,GAAG,CAAC,OAAO,EAAE,KAAK,gBAAgB,CAAC,SAAS,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;gBACpF,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAGD,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;gBAChC,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,WAAW;QACT,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC;IAMD,YAAY;QACV,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAMD,WAAW;QACT,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC;IAMD,SAAS;QACP,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IAMD,WAAW;QACT,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEjD,IAAI,GAAG,GAAG,2DAA2D,CAAC;QACtE,GAAG,IAAI,wFAAwF,CAAC;QAEhG,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;YAChC,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC;QAC5B,CAAC;QAED,GAAG,IAAI,kBAAkB,CAAC;QAE1B,OAAO,GAAG,CAAC;IACb,CAAC;IAMD,MAAM,CAAC,iBAAiB;QACtB,MAAM,OAAO,GAAG,IAAI,mBAAmB,EAAE,CAAC;QAC1C,OAAO,CAAC,SAAS,EAAE,CAAC;QACpB,OAAO,CAAC,YAAY,EAAE,CAAC;QACvB,OAAO,CAAC,YAAY,EAAE,CAAC;QACvB,OAAO,CAAC,WAAW,EAAE,CAAC;QACtB,OAAO,CAAC,cAAc,EAAE,CAAC;QACzB,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,mBAAmB,EAAE,CAAC;IACnC,CAAC;IAOD,MAAM,CAAC,OAAO,CAAC,GAAW;QACxB,MAAM,OAAO,GAAG,IAAI,mBAAmB,EAAE,CAAC;QAG1C,IAAI,GAAG,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;YAC1B,MAAM,IAAI,qBAAqB,CAC7B,uFAAuF,CACxF,CAAC;QACJ,CAAC;QAGD,MAAM,oBAAoB,GAAG,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAG5E,IAAI,oBAAoB,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,qBAAqB,CAC7B,uEAAuE,CACxE,CAAC;QACJ,CAAC;QAGD,KAAK,MAAM,mBAAmB,IAAI,oBAAoB,EAAE,CAAC;YAEvD,MAAM,EAAE,GAAG,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;YACjE,MAAM,IAAI,GAAG,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;YACrE,MAAM,MAAM,GAAG,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;YACzE,MAAM,UAAU,GAAG,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;YAGjF,IAAI,EAAE,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;gBAEzB,MAAM,mBAAmB,GACvB,UAAU,KAAK,UAAU,IAAI,UAAU,KAAK,UAAU,IAAI,UAAU,KAAK,SAAS;oBAChF,CAAC,CAAC,UAAU;oBACZ,CAAC,CAAC,SAAS,CAAC;gBAGhB,IAAI,eAAe,GAAG,MAAM,CAAC;gBAC7B,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;oBAChC,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;oBAC5C,IAAI,MAAM,EAAE,CAAC;wBACX,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBAGD,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC;oBACvC,EAAE;oBACF,IAAI;oBACJ,MAAM,EAAE,eAAe;oBACvB,UAAU,EAAE,mBAAmB,IAAI,UAAU;iBAC9C,CAAC,CAAC;gBAEH,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF","sourcesContent":["/**\n * RelationshipManager - Manages collections of relationships\n *\n * Handles relationship creation, tracking, and XML generation for various\n * document parts (document.xml, header.xml, footer.xml, etc.)\n */\n\nimport { Relationship, RelationshipType } from './Relationship.js';\nimport { XMLParser } from '../xml/XMLParser.js';\nimport { sanitizeHyperlinkUrl } from '../utils/validation.js';\nimport { InvalidDocxError, CorruptedArchiveError } from '../zip/errors.js';\n\n/**\n * Manages relationships for a document or document part\n */\nexport class RelationshipManager {\n private relationships: Map<string, Relationship>;\n private nextId: number;\n\n /**\n * Creates a new relationship manager\n */\n constructor() {\n this.relationships = new Map();\n this.nextId = 1;\n }\n\n /**\n * Adds a relationship\n * @param relationship The relationship to add\n * @returns The relationship that was added\n */\n addRelationship(relationship: Relationship): Relationship {\n this.relationships.set(relationship.getId(), relationship);\n\n // Update next ID if necessary\n const idMatch = /^rId(\\d+)$/.exec(relationship.getId());\n if (idMatch?.[1]) {\n const idNum = parseInt(idMatch[1], 10);\n if (idNum >= this.nextId) {\n this.nextId = idNum + 1;\n }\n }\n\n return relationship;\n }\n\n /**\n * Gets a relationship by ID\n * @param id The relationship ID\n */\n getRelationship(id: string): Relationship | undefined {\n return this.relationships.get(id);\n }\n\n /**\n * Gets all relationships\n */\n getAllRelationships(): Relationship[] {\n return Array.from(this.relationships.values());\n }\n\n /**\n * Gets relationships of a specific type\n * @param type The relationship type\n */\n getRelationshipsByType(type: string | RelationshipType): Relationship[] {\n return this.getAllRelationships().filter((rel) => rel.getType() === type);\n }\n\n /**\n * Checks if a relationship exists\n * @param id The relationship ID\n */\n hasRelationship(id: string): boolean {\n return this.relationships.has(id);\n }\n\n /**\n * Removes a relationship\n * @param id The relationship ID\n * @returns True if removed, false if not found\n */\n removeRelationship(id: string): boolean {\n return this.relationships.delete(id);\n }\n\n /**\n * Gets the number of relationships\n */\n getCount(): number {\n return this.relationships.size;\n }\n\n /**\n * Clears all relationships\n */\n clear(): this {\n this.relationships.clear();\n this.nextId = 1;\n return this;\n }\n\n /**\n * Generates a new unique relationship ID\n * @returns New relationship ID (e.g., 'rId1', 'rId2')\n */\n generateId(): string {\n return `rId${this.nextId++}`;\n }\n\n /**\n * Adds a styles relationship\n * @returns The created relationship\n */\n addStyles(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createStyles(id));\n }\n\n /**\n * Adds a numbering relationship\n * @returns The created relationship\n */\n addNumbering(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createNumbering(id));\n }\n\n /**\n * Adds a fontTable relationship\n * @returns The created relationship\n */\n addFontTable(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createFontTable(id));\n }\n\n /**\n * Adds a settings relationship\n * @returns The created relationship\n */\n addSettings(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createSettings(id));\n }\n\n /**\n * Adds a webSettings relationship\n * @returns The created relationship\n */\n addWebSettings(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createWebSettings(id));\n }\n\n /**\n * Adds a theme relationship\n * @returns The created relationship\n */\n addTheme(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createTheme(id));\n }\n\n /**\n * Adds an image relationship\n * @param target Image path relative to the part (e.g., 'media/image1.png')\n * @returns The created relationship\n */\n addImage(target: string): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createImage(id, target));\n }\n\n /**\n * Adds a header relationship\n * @param target Header file path (e.g., 'header1.xml')\n * @returns The created relationship\n */\n addHeader(target: string): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createHeader(id, target));\n }\n\n /**\n * Adds a footer relationship\n * @param target Footer file path (e.g., 'footer1.xml')\n * @returns The created relationship\n */\n addFooter(target: string): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createFooter(id, target));\n }\n\n /**\n * Adds a hyperlink relationship\n * @param url The hyperlink URL\n * @returns The created relationship\n */\n addHyperlink(url: string): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createHyperlink(id, url));\n }\n\n /**\n * Updates the target URL of an existing hyperlink relationship\n *\n * This method modifies an existing relationship's target in-place, maintaining\n * the same relationship ID. This is crucial for proper OpenXML compliance\n * per ECMA-376 §17.16.22, as it prevents orphaned relationships.\n *\n * @param relationshipId The ID of the relationship to update\n * @param newUrl The new URL to set\n * @returns True if updated, false if relationship not found\n */\n updateHyperlinkTarget(relationshipId: string, newUrl: string): boolean {\n const relationship = this.getRelationship(relationshipId);\n if (!relationship) {\n return false;\n }\n\n // Verify this is a hyperlink relationship\n if (relationship.getType() !== RelationshipType.HYPERLINK) {\n throw new InvalidDocxError(\n `Relationship ${relationshipId} is not a hyperlink relationship. ` +\n `Type is ${relationship.getType()}, expected ${RelationshipType.HYPERLINK}`\n );\n }\n\n // Update the target URL\n relationship.setTarget(newUrl);\n return true;\n }\n\n /**\n * Finds a hyperlink relationship by its target URL\n *\n * @param targetUrl The URL to search for\n * @returns The matching relationship, or undefined if not found\n */\n findHyperlinkByTarget(targetUrl: string): Relationship | undefined {\n return this.getAllRelationships().find(\n (rel) => rel.getType() === RelationshipType.HYPERLINK && rel.getTarget() === targetUrl\n );\n }\n\n /**\n * Gets or creates a hyperlink relationship for the given URL\n *\n * This method ensures we don't create duplicate relationships for the same URL.\n * If a relationship already exists for the URL, it returns the existing one.\n * Otherwise, it creates a new relationship.\n *\n * @param url The hyperlink URL\n * @returns The existing or newly created relationship\n */\n getOrCreateHyperlink(url: string): Relationship {\n // Check if relationship already exists for this URL\n const existing = this.findHyperlinkByTarget(url);\n if (existing) {\n return existing;\n }\n\n // Create new relationship\n return this.addHyperlink(url);\n }\n\n /**\n * Removes orphaned hyperlink relationships\n *\n * This method removes hyperlink relationships that are no longer referenced\n * by any hyperlink in the document. Call this after updating URLs to clean\n * up any orphaned relationships.\n *\n * @param referencedIds Set of relationship IDs that are still in use\n * @returns Number of relationships removed\n */\n removeOrphanedHyperlinks(referencedIds: Set<string>): number {\n let removed = 0;\n const toRemove: string[] = [];\n\n // Find orphaned relationships\n for (const rel of this.getAllRelationships()) {\n if (rel.getType() === RelationshipType.HYPERLINK && !referencedIds.has(rel.getId())) {\n toRemove.push(rel.getId());\n }\n }\n\n // Remove orphaned relationships\n for (const id of toRemove) {\n if (this.removeRelationship(id)) {\n removed++;\n }\n }\n\n return removed;\n }\n\n /**\n * Adds a comments relationship\n * @returns The created relationship\n */\n addComments(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createComments(id));\n }\n\n /**\n * Adds a footnotes relationship\n * @returns The created relationship\n */\n addFootnotes(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createFootnotes(id));\n }\n\n /**\n * Adds an endnotes relationship\n * @returns The created relationship\n */\n addEndnotes(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createEndnotes(id));\n }\n\n /**\n * Adds a people relationship (track changes authors)\n * @returns The created relationship\n */\n addPeople(): Relationship {\n const id = this.generateId();\n return this.addRelationship(Relationship.createPeople(id));\n }\n\n /**\n * Generates the relationships XML file content\n * @returns Complete XML string for .rels file\n */\n generateXml(): string {\n const relationships = this.getAllRelationships();\n\n let xml = '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\\n';\n xml += '<Relationships xmlns=\"http://schemas.openxmlformats.org/package/2006/relationships\">\\n';\n\n for (const rel of relationships) {\n xml += rel.toXML() + '\\n';\n }\n\n xml += '</Relationships>';\n\n return xml;\n }\n\n /**\n * Creates a new relationship manager with common document relationships\n * @returns RelationshipManager with styles, numbering, fontTable, settings, and theme relationships\n */\n static createForDocument(): RelationshipManager {\n const manager = new RelationshipManager();\n manager.addStyles();\n manager.addNumbering();\n manager.addFontTable();\n manager.addSettings();\n manager.addWebSettings();\n manager.addTheme();\n return manager;\n }\n\n /**\n * Creates an empty relationship manager\n * @returns Empty RelationshipManager\n */\n static create(): RelationshipManager {\n return new RelationshipManager();\n }\n\n /**\n * Parses relationships from XML string and creates a populated manager\n * @param xml The relationships XML content (.rels file)\n * @returns RelationshipManager with parsed relationships\n */\n static fromXml(xml: string): RelationshipManager {\n const manager = new RelationshipManager();\n\n // Prevent ReDoS: validate input size (typical .rels files are < 10KB, max 10MB)\n if (xml.length > 10000000) {\n throw new CorruptedArchiveError(\n 'Relationships XML file too large (>10MB). Possible malicious input or corrupted file.'\n );\n }\n\n // Use XMLParser to extract all Relationship elements\n const relationshipElements = XMLParser.extractElements(xml, 'Relationship');\n\n // Prevent infinite loops: check relationship count\n if (relationshipElements.length > 1000) {\n throw new CorruptedArchiveError(\n 'Too many relationships in XML file (>1000). Possible malicious input.'\n );\n }\n\n // Process each relationship element\n for (const relationshipElement of relationshipElements) {\n // Extract attributes using XMLParser\n const id = XMLParser.extractAttribute(relationshipElement, 'Id');\n const type = XMLParser.extractAttribute(relationshipElement, 'Type');\n const target = XMLParser.extractAttribute(relationshipElement, 'Target');\n const targetMode = XMLParser.extractAttribute(relationshipElement, 'TargetMode');\n\n // Only create relationship if all required attributes present\n if (id && type && target) {\n // Validate targetMode before type assertion\n const validatedTargetMode =\n targetMode === 'Internal' || targetMode === 'External' || targetMode === undefined\n ? targetMode\n : undefined;\n\n // Sanitize hyperlink URLs (strip browser extension prefixes)\n let sanitizedTarget = target;\n if (type.endsWith('/hyperlink')) {\n const result = sanitizeHyperlinkUrl(target);\n if (result) {\n sanitizedTarget = result.url;\n }\n }\n\n // Create and add relationship\n const relationship = Relationship.create({\n id,\n type,\n target: sanitizedTarget,\n targetMode: validatedTargetMode || 'Internal',\n });\n\n manager.addRelationship(relationship);\n }\n }\n\n return manager;\n }\n}\n"]}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export class AlternateContent {
|
|
2
|
+
rawXml;
|
|
3
|
+
constructor(rawXml) {
|
|
4
|
+
this.rawXml = rawXml;
|
|
5
|
+
}
|
|
6
|
+
toXML() {
|
|
7
|
+
return {
|
|
8
|
+
name: '__rawXml',
|
|
9
|
+
rawXml: this.rawXml,
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
getRawXml() {
|
|
13
|
+
return this.rawXml;
|
|
14
|
+
}
|
|
15
|
+
getType() {
|
|
16
|
+
return 'alternateContent';
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=AlternateContent.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AlternateContent.js","sourceRoot":"","sources":["../../../src/elements/AlternateContent.ts"],"names":[],"mappings":"AAWA,MAAM,OAAO,gBAAgB;IACnB,MAAM,CAAS;IAEvB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAKD,KAAK;QACH,OAAO;YACL,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,IAAI,CAAC,MAAM;SACN,CAAC;IAClB,CAAC;IAKD,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAKD,OAAO;QACL,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF","sourcesContent":["/**\n * AlternateContent - Represents mc:AlternateContent block element\n *\n * Per ECMA-376 Part 3 §11.4, mc:AlternateContent provides markup compatibility.\n * Word uses this for newer features (Word 2010+ shapes as Choice, VML as Fallback).\n *\n * Stored as raw XML for round-trip fidelity since the internal structure varies widely.\n */\n\nimport { XMLElement } from '../xml/XMLBuilder.js';\n\nexport class AlternateContent {\n private rawXml: string;\n\n constructor(rawXml: string) {\n this.rawXml = rawXml;\n }\n\n /**\n * Returns the raw XML for round-trip serialization\n */\n toXML(): XMLElement {\n return {\n name: '__rawXml',\n rawXml: this.rawXml,\n } as XMLElement;\n }\n\n /**\n * Gets the raw XML string\n */\n getRawXml(): string {\n return this.rawXml;\n }\n\n /**\n * Returns the element type identifier\n */\n getType(): string {\n return 'alternateContent';\n }\n}\n"]}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
export class Bookmark {
|
|
2
|
+
id;
|
|
3
|
+
name;
|
|
4
|
+
colFirst;
|
|
5
|
+
colLast;
|
|
6
|
+
displacedByCustomXml;
|
|
7
|
+
constructor(properties) {
|
|
8
|
+
this.id = properties.id ?? 0;
|
|
9
|
+
this.name = properties.skipNormalization
|
|
10
|
+
? properties.name
|
|
11
|
+
: this.normalizeName(properties.name);
|
|
12
|
+
this.colFirst = properties.colFirst;
|
|
13
|
+
this.colLast = properties.colLast;
|
|
14
|
+
this.displacedByCustomXml = properties.displacedByCustomXml;
|
|
15
|
+
}
|
|
16
|
+
normalizeName(name) {
|
|
17
|
+
let normalized = name.replace(/[^a-zA-Z0-9_]/g, '_');
|
|
18
|
+
if (normalized.length > 0 && /^\d/.test(normalized)) {
|
|
19
|
+
normalized = '_' + normalized;
|
|
20
|
+
}
|
|
21
|
+
if (normalized.length > 40) {
|
|
22
|
+
normalized = normalized.substring(0, 40);
|
|
23
|
+
}
|
|
24
|
+
if (normalized.length === 0) {
|
|
25
|
+
normalized = '_bookmark';
|
|
26
|
+
}
|
|
27
|
+
return normalized;
|
|
28
|
+
}
|
|
29
|
+
getId() {
|
|
30
|
+
return this.id;
|
|
31
|
+
}
|
|
32
|
+
setId(id) {
|
|
33
|
+
this.id = id;
|
|
34
|
+
}
|
|
35
|
+
getName() {
|
|
36
|
+
return this.name;
|
|
37
|
+
}
|
|
38
|
+
setName(name) {
|
|
39
|
+
this.name = this.normalizeName(name);
|
|
40
|
+
return this;
|
|
41
|
+
}
|
|
42
|
+
setRawName(name) {
|
|
43
|
+
this.name = name;
|
|
44
|
+
return this;
|
|
45
|
+
}
|
|
46
|
+
getColFirst() {
|
|
47
|
+
return this.colFirst;
|
|
48
|
+
}
|
|
49
|
+
getColLast() {
|
|
50
|
+
return this.colLast;
|
|
51
|
+
}
|
|
52
|
+
setColumnRange(colFirst, colLast) {
|
|
53
|
+
this.colFirst = colFirst;
|
|
54
|
+
this.colLast = colLast;
|
|
55
|
+
return this;
|
|
56
|
+
}
|
|
57
|
+
getDisplacedByCustomXml() {
|
|
58
|
+
return this.displacedByCustomXml;
|
|
59
|
+
}
|
|
60
|
+
setDisplacedByCustomXml(value) {
|
|
61
|
+
this.displacedByCustomXml = value;
|
|
62
|
+
return this;
|
|
63
|
+
}
|
|
64
|
+
toStartXML() {
|
|
65
|
+
const attrs = {
|
|
66
|
+
'w:id': this.id.toString(),
|
|
67
|
+
'w:name': this.name,
|
|
68
|
+
};
|
|
69
|
+
if (this.colFirst !== undefined)
|
|
70
|
+
attrs['w:colFirst'] = this.colFirst.toString();
|
|
71
|
+
if (this.colLast !== undefined)
|
|
72
|
+
attrs['w:colLast'] = this.colLast.toString();
|
|
73
|
+
if (this.displacedByCustomXml) {
|
|
74
|
+
attrs['w:displacedByCustomXml'] = this.displacedByCustomXml;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
name: 'w:bookmarkStart',
|
|
78
|
+
attributes: attrs,
|
|
79
|
+
selfClosing: true,
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
toEndXML() {
|
|
83
|
+
const attrs = {
|
|
84
|
+
'w:id': this.id.toString(),
|
|
85
|
+
};
|
|
86
|
+
if (this.displacedByCustomXml) {
|
|
87
|
+
attrs['w:displacedByCustomXml'] = this.displacedByCustomXml;
|
|
88
|
+
}
|
|
89
|
+
return {
|
|
90
|
+
name: 'w:bookmarkEnd',
|
|
91
|
+
attributes: attrs,
|
|
92
|
+
selfClosing: true,
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
toXML() {
|
|
96
|
+
return [this.toStartXML(), this.toEndXML()];
|
|
97
|
+
}
|
|
98
|
+
static create(name) {
|
|
99
|
+
return new Bookmark({ name });
|
|
100
|
+
}
|
|
101
|
+
static createForHeading(headingText) {
|
|
102
|
+
const name = headingText
|
|
103
|
+
.trim()
|
|
104
|
+
.replace(/[^a-zA-Z0-9]+/g, '_')
|
|
105
|
+
.substring(0, 40);
|
|
106
|
+
return new Bookmark({ name: name || '_heading' });
|
|
107
|
+
}
|
|
108
|
+
static createAuto(prefix = 'bookmark') {
|
|
109
|
+
const timestamp = Date.now().toString(36);
|
|
110
|
+
const random = Math.random().toString(36).substring(2, 7);
|
|
111
|
+
const name = `${prefix}_${timestamp}_${random}`;
|
|
112
|
+
return new Bookmark({ name });
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
//# sourceMappingURL=Bookmark.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Bookmark.js","sourceRoot":"","sources":["../../../src/elements/Bookmark.ts"],"names":[],"mappings":"AA4CA,MAAM,OAAO,QAAQ;IACX,EAAE,CAAS;IACX,IAAI,CAAS;IACb,QAAQ,CAAU;IAClB,OAAO,CAAU;IACjB,oBAAoB,CAAwB;IAMpD,YAAY,UAA8B;QACxC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;QAG7B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,iBAAiB;YACtC,CAAC,CAAC,UAAU,CAAC,IAAI;YACjB,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,oBAAoB,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAC9D,CAAC;IAWO,aAAa,CAAC,IAAY;QAEhC,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QAGrD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,UAAU,GAAG,GAAG,GAAG,UAAU,CAAC;QAChC,CAAC;QAGD,IAAI,UAAU,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAC3B,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;QAGD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,UAAU,GAAG,WAAW,CAAC;QAC3B,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAKD,KAAK;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAMD,KAAK,CAAC,EAAU;QACd,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IAKD,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAaD,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAyBD,UAAU,CAAC,IAAY;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAKD,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAKD,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAKD,cAAc,CAAC,QAAgB,EAAE,OAAe;QAC9C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,uBAAuB;QACrB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAMD,uBAAuB,CAAC,KAAuC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAMD,UAAU;QACR,MAAM,KAAK,GAAoC;YAC7C,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;YAC1B,QAAQ,EAAE,IAAI,CAAC,IAAI;SACpB,CAAC;QAEF,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAChF,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;YAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAG7E,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,KAAK,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QAC9D,CAAC;QACD,OAAO;YACL,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE,KAAK;YACjB,WAAW,EAAE,IAAI;SAClB,CAAC;IACJ,CAAC;IAMD,QAAQ;QACN,MAAM,KAAK,GAAoC;YAC7C,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;SAC3B,CAAC;QAIF,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,KAAK,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QAC9D,CAAC;QACD,OAAO;YACL,IAAI,EAAE,eAAe;YACrB,UAAU,EAAE,KAAK;YACjB,WAAW,EAAE,IAAI;SAClB,CAAC;IACJ,CAAC;IAMD,KAAK;QACH,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9C,CAAC;IAOD,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO,IAAI,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAChC,CAAC;IAQD,MAAM,CAAC,gBAAgB,CAAC,WAAmB;QAGzC,MAAM,IAAI,GAAG,WAAW;aACrB,IAAI,EAAE;aACN,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC;aAC9B,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpB,OAAO,IAAI,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,UAAU,EAAE,CAAC,CAAC;IACpD,CAAC;IAOD,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,UAAU;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG,GAAG,MAAM,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;QAChD,OAAO,IAAI,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAChC,CAAC;CACF","sourcesContent":["/**\n * Bookmark - Represents a bookmark in a Word document\n *\n * Bookmarks mark specific locations in a document for internal navigation.\n * They consist of a start marker and an end marker with matching IDs.\n */\n\nimport { XMLElement } from '../xml/XMLBuilder.js';\n\n/**\n * `w:displacedByCustomXml` attribute value per ECMA-376 CT_MarkupRange —\n * ST_DisplacedByCustomXml enum: \"next\" | \"prev\". Indicates which side of\n * a custom-XML boundary the marker semantically belongs to when the\n * marker had to be displaced because a custom-XML node boundary fell at\n * the same position.\n */\nexport type DisplacedByCustomXml = 'next' | 'prev';\n\n/**\n * Bookmark properties\n */\nexport interface BookmarkProperties {\n /** Unique bookmark ID (generated automatically if not provided) */\n id?: number;\n /** Bookmark name (must be unique within document) */\n name: string;\n /** Skip name normalization (used when loading from existing documents) */\n skipNormalization?: boolean;\n /** First column in table bookmark range (ECMA-376 §17.16.5) */\n colFirst?: number;\n /** Last column in table bookmark range (ECMA-376 §17.16.5) */\n colLast?: number;\n /**\n * `w:displacedByCustomXml` per ECMA-376 CT_MarkupRange / CT_Bookmark.\n * Valid on both `<w:bookmarkStart>` (CT_Bookmark) and `<w:bookmarkEnd>`\n * (CT_MarkupRange). Preserves the custom-XML boundary disambiguator\n * that Word emits when a bookmark was displaced by a custom-XML node.\n */\n displacedByCustomXml?: DisplacedByCustomXml;\n}\n\n/**\n * Represents a bookmark location in a document\n */\nexport class Bookmark {\n private id: number;\n private name: string;\n private colFirst?: number;\n private colLast?: number;\n private displacedByCustomXml?: DisplacedByCustomXml;\n\n /**\n * Creates a new Bookmark\n * @param properties - Bookmark properties\n */\n constructor(properties: BookmarkProperties) {\n this.id = properties.id ?? 0; // ID will be assigned by BookmarkManager\n // Preserve exact bookmark names when loading from documents (Word allows =, ., etc.)\n // Only normalize when creating new bookmarks programmatically\n this.name = properties.skipNormalization\n ? properties.name\n : this.normalizeName(properties.name);\n this.colFirst = properties.colFirst;\n this.colLast = properties.colLast;\n this.displacedByCustomXml = properties.displacedByCustomXml;\n }\n\n /**\n * Normalizes a bookmark name to be valid\n * - Must start with a letter or underscore\n * - Can only contain letters, numbers, and underscores\n * - Maximum 40 characters\n * - Case-insensitive (Word converts to lowercase)\n * @param name - Raw bookmark name\n * @returns Normalized bookmark name\n */\n private normalizeName(name: string): string {\n // Remove invalid characters\n let normalized = name.replace(/[^a-zA-Z0-9_]/g, '_');\n\n // Ensure it starts with a letter or underscore\n if (normalized.length > 0 && /^\\d/.test(normalized)) {\n normalized = '_' + normalized;\n }\n\n // Limit to 40 characters\n if (normalized.length > 40) {\n normalized = normalized.substring(0, 40);\n }\n\n // Default if empty\n if (normalized.length === 0) {\n normalized = '_bookmark';\n }\n\n return normalized;\n }\n\n /**\n * Gets the bookmark ID\n */\n getId(): number {\n return this.id;\n }\n\n /**\n * Sets the bookmark ID (used by BookmarkManager)\n * @internal\n */\n setId(id: number): void {\n this.id = id;\n }\n\n /**\n * Gets the bookmark name\n */\n getName(): string {\n return this.name;\n }\n\n /**\n * Sets the bookmark name (normalizes the name)\n *\n * The name will be normalized:\n * - Invalid characters replaced with underscores\n * - Leading digits prefixed with underscore\n * - Limited to 40 characters\n *\n * @param name - New bookmark name\n * @returns This bookmark for chaining\n */\n setName(name: string): this {\n this.name = this.normalizeName(name);\n return this;\n }\n\n /**\n * Sets the bookmark name without normalization\n *\n * Use this method when:\n * - Preserving exact names from imported documents\n * - Setting names with special characters that Word allows (=, ., etc.)\n * - Round-trip fidelity is required\n *\n * **Warning:** Setting invalid bookmark names may cause issues in Word.\n * Only use this if you know the name is valid or needs to match an existing document.\n *\n * @param name - Raw bookmark name (not normalized)\n * @returns This bookmark for chaining\n *\n * @example\n * ```typescript\n * // Preserve exact name from Word document\n * bookmark.setRawName('SECTION=II.MNKE7E8NA385_');\n *\n * // For new bookmarks, prefer setName() which normalizes\n * bookmark.setName('My Heading'); // Becomes 'My_Heading'\n * ```\n */\n setRawName(name: string): this {\n this.name = name;\n return this;\n }\n\n /**\n * Gets the first column in a table bookmark range\n */\n getColFirst(): number | undefined {\n return this.colFirst;\n }\n\n /**\n * Gets the last column in a table bookmark range\n */\n getColLast(): number | undefined {\n return this.colLast;\n }\n\n /**\n * Sets the column range for a table bookmark (ECMA-376 §17.16.5)\n */\n setColumnRange(colFirst: number, colLast: number): this {\n this.colFirst = colFirst;\n this.colLast = colLast;\n return this;\n }\n\n /**\n * Gets the `w:displacedByCustomXml` attribute value.\n * Preserved on both bookmarkStart and bookmarkEnd per ECMA-376\n * CT_MarkupRange (§17.13.5) / CT_Bookmark (§17.16.5).\n */\n getDisplacedByCustomXml(): DisplacedByCustomXml | undefined {\n return this.displacedByCustomXml;\n }\n\n /**\n * Sets the `w:displacedByCustomXml` attribute value.\n * @param value \"next\" | \"prev\" | undefined\n */\n setDisplacedByCustomXml(value: DisplacedByCustomXml | undefined): this {\n this.displacedByCustomXml = value;\n return this;\n }\n\n /**\n * Generates XML for the bookmark start marker\n * @returns XMLElement for bookmarkStart\n */\n toStartXML(): XMLElement {\n const attrs: Record<string, string | number> = {\n 'w:id': this.id.toString(),\n 'w:name': this.name,\n };\n // Table bookmark column range per ECMA-376 §17.16.5\n if (this.colFirst !== undefined) attrs['w:colFirst'] = this.colFirst.toString();\n if (this.colLast !== undefined) attrs['w:colLast'] = this.colLast.toString();\n // Custom-XML displacement marker per CT_MarkupRange (§17.13.5) —\n // the same attribute also carried by the RangeMarker sibling class.\n if (this.displacedByCustomXml) {\n attrs['w:displacedByCustomXml'] = this.displacedByCustomXml;\n }\n return {\n name: 'w:bookmarkStart',\n attributes: attrs,\n selfClosing: true,\n };\n }\n\n /**\n * Generates XML for the bookmark end marker\n * @returns XMLElement for bookmarkEnd\n */\n toEndXML(): XMLElement {\n const attrs: Record<string, string | number> = {\n 'w:id': this.id.toString(),\n };\n // bookmarkEnd is CT_MarkupRange per ECMA-376 §17.13.6.1 — w:displacedByCustomXml\n // is valid here too (the BookmarkRange column attributes are NOT, so those\n // stay scoped to toStartXML above).\n if (this.displacedByCustomXml) {\n attrs['w:displacedByCustomXml'] = this.displacedByCustomXml;\n }\n return {\n name: 'w:bookmarkEnd',\n attributes: attrs,\n selfClosing: true,\n };\n }\n\n /**\n * Generates both start and end XML elements as an array\n * @returns Array of XMLElements [start, end]\n */\n toXML(): [XMLElement, XMLElement] {\n return [this.toStartXML(), this.toEndXML()];\n }\n\n /**\n * Creates a new Bookmark\n * @param name - Bookmark name\n * @returns New Bookmark instance\n */\n static create(name: string): Bookmark {\n return new Bookmark({ name });\n }\n\n /**\n * Creates a bookmark for a heading\n * Useful for table of contents internal links\n * @param headingText - The text of the heading\n * @returns New Bookmark instance with normalized name\n */\n static createForHeading(headingText: string): Bookmark {\n // Create a bookmark name from heading text\n // Example: \"Chapter 1: Introduction\" -> \"_Chapter_1_Introduction\"\n const name = headingText\n .trim()\n .replace(/[^a-zA-Z0-9]+/g, '_')\n .substring(0, 40);\n return new Bookmark({ name: name || '_heading' });\n }\n\n /**\n * Creates a bookmark with an auto-generated unique name\n * @param prefix - Optional prefix for the name (default: 'bookmark')\n * @returns New Bookmark instance\n */\n static createAuto(prefix = 'bookmark'): Bookmark {\n const timestamp = Date.now().toString(36);\n const random = Math.random().toString(36).substring(2, 7);\n const name = `${prefix}_${timestamp}_${random}`;\n return new Bookmark({ name });\n }\n}\n"]}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { Bookmark } from './Bookmark.js';
|
|
2
|
+
import { InvalidDocxError } from '../zip/errors.js';
|
|
3
|
+
export class BookmarkManager {
|
|
4
|
+
bookmarks = new Map();
|
|
5
|
+
nextId = 0;
|
|
6
|
+
idProvider = null;
|
|
7
|
+
idExistsNotifier = null;
|
|
8
|
+
setIdProvider(provider, existsNotifier) {
|
|
9
|
+
this.idProvider = provider;
|
|
10
|
+
this.idExistsNotifier = existsNotifier || null;
|
|
11
|
+
}
|
|
12
|
+
register(bookmark) {
|
|
13
|
+
const name = bookmark.getName();
|
|
14
|
+
if (this.bookmarks.has(name)) {
|
|
15
|
+
throw new InvalidDocxError(`Bookmark with name "${name}" already exists. Bookmark names must be unique within a document.`);
|
|
16
|
+
}
|
|
17
|
+
const id = this.idProvider ? this.idProvider() : this.nextId++;
|
|
18
|
+
bookmark.setId(id);
|
|
19
|
+
this.bookmarks.set(name, bookmark);
|
|
20
|
+
return bookmark;
|
|
21
|
+
}
|
|
22
|
+
registerExisting(bookmark) {
|
|
23
|
+
const name = bookmark.getName();
|
|
24
|
+
const existingId = bookmark.getId();
|
|
25
|
+
if (this.bookmarks.has(name)) {
|
|
26
|
+
throw new InvalidDocxError(`Bookmark with name "${name}" already exists. Bookmark names must be unique within a document.`);
|
|
27
|
+
}
|
|
28
|
+
if (this.idExistsNotifier) {
|
|
29
|
+
this.idExistsNotifier(existingId);
|
|
30
|
+
}
|
|
31
|
+
if (existingId >= this.nextId) {
|
|
32
|
+
this.nextId = existingId + 1;
|
|
33
|
+
}
|
|
34
|
+
this.bookmarks.set(name, bookmark);
|
|
35
|
+
return bookmark;
|
|
36
|
+
}
|
|
37
|
+
getBookmark(name) {
|
|
38
|
+
return this.bookmarks.get(name);
|
|
39
|
+
}
|
|
40
|
+
hasBookmark(name) {
|
|
41
|
+
return this.bookmarks.has(name);
|
|
42
|
+
}
|
|
43
|
+
getAllBookmarks() {
|
|
44
|
+
return Array.from(this.bookmarks.values());
|
|
45
|
+
}
|
|
46
|
+
getCount() {
|
|
47
|
+
return this.bookmarks.size;
|
|
48
|
+
}
|
|
49
|
+
removeBookmark(name) {
|
|
50
|
+
return this.bookmarks.delete(name);
|
|
51
|
+
}
|
|
52
|
+
clear() {
|
|
53
|
+
this.bookmarks.clear();
|
|
54
|
+
this.nextId = 0;
|
|
55
|
+
}
|
|
56
|
+
setNextId(id) {
|
|
57
|
+
this.nextId = id;
|
|
58
|
+
}
|
|
59
|
+
getUniqueName(baseName) {
|
|
60
|
+
const maxLength = 40;
|
|
61
|
+
if (!this.hasBookmark(baseName)) {
|
|
62
|
+
return baseName;
|
|
63
|
+
}
|
|
64
|
+
let counter = 1;
|
|
65
|
+
while (counter <= 1000) {
|
|
66
|
+
const suffix = `_${counter}`;
|
|
67
|
+
const maxBase = maxLength - suffix.length;
|
|
68
|
+
const truncatedBase = baseName.length > maxBase ? baseName.substring(0, maxBase) : baseName;
|
|
69
|
+
const uniqueName = `${truncatedBase}${suffix}`;
|
|
70
|
+
if (!this.hasBookmark(uniqueName)) {
|
|
71
|
+
return uniqueName;
|
|
72
|
+
}
|
|
73
|
+
counter++;
|
|
74
|
+
}
|
|
75
|
+
throw new InvalidDocxError(`Could not generate unique bookmark name from base "${baseName}"`);
|
|
76
|
+
}
|
|
77
|
+
createBookmark(name) {
|
|
78
|
+
const uniqueName = this.getUniqueName(name);
|
|
79
|
+
const bookmark = Bookmark.create(uniqueName);
|
|
80
|
+
return this.register(bookmark);
|
|
81
|
+
}
|
|
82
|
+
createHeadingBookmark(headingText) {
|
|
83
|
+
const bookmark = Bookmark.createForHeading(headingText);
|
|
84
|
+
const uniqueName = this.getUniqueName(bookmark.getName());
|
|
85
|
+
bookmark.setName(uniqueName);
|
|
86
|
+
return this.register(bookmark);
|
|
87
|
+
}
|
|
88
|
+
getStats() {
|
|
89
|
+
return {
|
|
90
|
+
total: this.bookmarks.size,
|
|
91
|
+
nextId: this.nextId,
|
|
92
|
+
names: Array.from(this.bookmarks.keys()),
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
static create() {
|
|
96
|
+
return new BookmarkManager();
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=BookmarkManager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BookmarkManager.js","sourceRoot":"","sources":["../../../src/elements/BookmarkManager.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAiBpD,MAAM,OAAO,eAAe;IAClB,SAAS,GAAG,IAAI,GAAG,EAAoB,CAAC;IACxC,MAAM,GAAG,CAAC,CAAC;IACX,UAAU,GAA8B,IAAI,CAAC;IAC7C,gBAAgB,GAA4B,IAAI,CAAC;IAUzD,aAAa,CAAC,QAA4B,EAAE,cAAiC;QAC3E,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;QAC3B,IAAI,CAAC,gBAAgB,GAAG,cAAc,IAAI,IAAI,CAAC;IACjD,CAAC;IASD,QAAQ,CAAC,QAAkB;QACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QAGhC,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,gBAAgB,CACxB,uBAAuB,IAAI,oEAAoE,CAChG,CAAC;QACJ,CAAC;QAGD,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAGnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEnC,OAAO,QAAQ,CAAC;IAClB,CAAC;IASD,gBAAgB,CAAC,QAAkB;QACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChC,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;QAGpC,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,gBAAgB,CACxB,uBAAuB,IAAI,oEAAoE,CAChG,CAAC;QACJ,CAAC;QAGD,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;QAGD,IAAI,UAAU,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,GAAG,UAAU,GAAG,CAAC,CAAC;QAC/B,CAAC;QAGD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEnC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAOD,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAOD,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAMD,eAAe;QACb,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,CAAC;IAMD,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B,CAAC;IAOD,cAAc,CAAC,IAAY;QACzB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAKD,KAAK;QACH,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAOD,SAAS,CAAC,EAAU;QAClB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAQD,aAAa,CAAC,QAAgB;QAC5B,MAAM,SAAS,GAAG,EAAE,CAAC;QAErB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAGD,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,OAAO,OAAO,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAG7B,MAAM,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;YAC1C,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YAE5F,MAAM,UAAU,GAAG,GAAG,aAAa,GAAG,MAAM,EAAE,CAAC;YAE/C,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClC,OAAO,UAAU,CAAC;YACpB,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,IAAI,gBAAgB,CAAC,sDAAsD,QAAQ,GAAG,CAAC,CAAC;IAChG,CAAC;IAOD,cAAc,CAAC,IAAY;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAQD,qBAAqB,CAAC,WAAmB;QACvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1D,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAMD,QAAQ;QAKN,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YAC1B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;SACzC,CAAC;IACJ,CAAC;IAMD,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,eAAe,EAAE,CAAC;IAC/B,CAAC;CACF","sourcesContent":["/**\n * BookmarkManager - Manages bookmarks in a document\n *\n * Tracks all bookmarks, assigns unique IDs, and ensures name uniqueness.\n *\n * Per ECMA-376, bookmark IDs must be unique across ALL annotation types\n * in a document. Use setIdProvider() to connect to a centralized ID allocator.\n */\n\nimport { Bookmark } from './Bookmark.js';\nimport { InvalidDocxError } from '../zip/errors.js';\n\n/**\n * Type for the centralized ID provider callback.\n * Returns the next available annotation ID from a shared counter.\n */\nexport type IdProviderCallback = () => number;\n\n/**\n * Type for callback to notify of existing IDs (for synchronization).\n * Called when registering an existing bookmark to keep the central counter in sync.\n */\nexport type IdExistsCallback = (existingId: number) => void;\n\n/**\n * Manages document bookmarks\n */\nexport class BookmarkManager {\n private bookmarks = new Map<string, Bookmark>();\n private nextId = 0;\n private idProvider: IdProviderCallback | null = null;\n private idExistsNotifier: IdExistsCallback | null = null;\n\n /**\n * Sets the centralized ID provider callback.\n * When set, IDs will be allocated from the centralized DocumentIdManager\n * instead of the local nextId counter.\n *\n * @param provider - Callback that returns the next available ID\n * @param existsNotifier - Optional callback to notify when existing IDs are found\n */\n setIdProvider(provider: IdProviderCallback, existsNotifier?: IdExistsCallback): void {\n this.idProvider = provider;\n this.idExistsNotifier = existsNotifier || null;\n }\n\n /**\n * Registers a bookmark with the manager\n * Assigns a unique ID and ensures name uniqueness\n * @param bookmark - Bookmark to register\n * @returns The registered bookmark (same instance)\n * @throws Error if a bookmark with the same name already exists\n */\n register(bookmark: Bookmark): Bookmark {\n const name = bookmark.getName();\n\n // Check for duplicate names\n if (this.bookmarks.has(name)) {\n throw new InvalidDocxError(\n `Bookmark with name \"${name}\" already exists. Bookmark names must be unique within a document.`\n );\n }\n\n // Assign unique ID - use centralized provider if available\n const id = this.idProvider ? this.idProvider() : this.nextId++;\n bookmark.setId(id);\n\n // Store bookmark\n this.bookmarks.set(name, bookmark);\n\n return bookmark;\n }\n\n /**\n * Registers an existing bookmark, preserving its ID\n * Used when loading documents to preserve original bookmark IDs and avoid collisions\n * @param bookmark - Bookmark with existing ID to register\n * @returns The registered bookmark (same instance)\n * @throws Error if a bookmark with the same name already exists\n */\n registerExisting(bookmark: Bookmark): Bookmark {\n const name = bookmark.getName();\n const existingId = bookmark.getId();\n\n // Check for duplicate names\n if (this.bookmarks.has(name)) {\n throw new InvalidDocxError(\n `Bookmark with name \"${name}\" already exists. Bookmark names must be unique within a document.`\n );\n }\n\n // Notify centralized ID manager about this existing ID\n if (this.idExistsNotifier) {\n this.idExistsNotifier(existingId);\n }\n\n // Also update local nextId to avoid collisions (for fallback)\n if (existingId >= this.nextId) {\n this.nextId = existingId + 1;\n }\n\n // Store bookmark (keep its existing ID)\n this.bookmarks.set(name, bookmark);\n\n return bookmark;\n }\n\n /**\n * Gets a bookmark by name\n * @param name - Bookmark name\n * @returns The bookmark, or undefined if not found\n */\n getBookmark(name: string): Bookmark | undefined {\n return this.bookmarks.get(name);\n }\n\n /**\n * Checks if a bookmark exists\n * @param name - Bookmark name\n * @returns True if the bookmark exists\n */\n hasBookmark(name: string): boolean {\n return this.bookmarks.has(name);\n }\n\n /**\n * Gets all bookmarks\n * @returns Array of all bookmarks\n */\n getAllBookmarks(): Bookmark[] {\n return Array.from(this.bookmarks.values());\n }\n\n /**\n * Gets the number of bookmarks\n * @returns Number of bookmarks\n */\n getCount(): number {\n return this.bookmarks.size;\n }\n\n /**\n * Removes a bookmark\n * @param name - Bookmark name\n * @returns True if the bookmark was removed\n */\n removeBookmark(name: string): boolean {\n return this.bookmarks.delete(name);\n }\n\n /**\n * Clears all bookmarks\n */\n clear(): void {\n this.bookmarks.clear();\n this.nextId = 0;\n }\n\n /**\n * Sets the next ID to be assigned\n * Used when loading documents to avoid ID collisions with existing bookmarks\n * @param id - The next ID value to use\n */\n setNextId(id: number): void {\n this.nextId = id;\n }\n\n /**\n * Gets a unique bookmark name by adding a suffix if needed\n * Ensures the returned name is always within the 40-character limit\n * @param baseName - Base name for the bookmark\n * @returns A unique bookmark name (max 40 characters)\n */\n getUniqueName(baseName: string): string {\n const maxLength = 40;\n\n if (!this.hasBookmark(baseName)) {\n return baseName;\n }\n\n // Try adding numbers until we find a unique name\n let counter = 1;\n while (counter <= 1000) {\n const suffix = `_${counter}`;\n\n // Truncate base name to leave room for suffix within 40-char limit\n const maxBase = maxLength - suffix.length;\n const truncatedBase = baseName.length > maxBase ? baseName.substring(0, maxBase) : baseName;\n\n const uniqueName = `${truncatedBase}${suffix}`;\n\n if (!this.hasBookmark(uniqueName)) {\n return uniqueName;\n }\n counter++;\n }\n\n throw new InvalidDocxError(`Could not generate unique bookmark name from base \"${baseName}\"`);\n }\n\n /**\n * Creates and registers a new bookmark with a unique name\n * @param name - Desired bookmark name\n * @returns The created and registered bookmark\n */\n createBookmark(name: string): Bookmark {\n const uniqueName = this.getUniqueName(name);\n const bookmark = Bookmark.create(uniqueName);\n return this.register(bookmark);\n }\n\n /**\n * Creates and registers a bookmark for a heading\n * Automatically generates a unique name from the heading text\n * @param headingText - The text of the heading\n * @returns The created and registered bookmark\n */\n createHeadingBookmark(headingText: string): Bookmark {\n const bookmark = Bookmark.createForHeading(headingText);\n const uniqueName = this.getUniqueName(bookmark.getName());\n bookmark.setName(uniqueName);\n return this.register(bookmark);\n }\n\n /**\n * Gets statistics about bookmarks\n * @returns Object with bookmark statistics\n */\n getStats(): {\n total: number;\n nextId: number;\n names: string[];\n } {\n return {\n total: this.bookmarks.size,\n nextId: this.nextId,\n names: Array.from(this.bookmarks.keys()),\n };\n }\n\n /**\n * Creates a new BookmarkManager\n * @returns New BookmarkManager instance\n */\n static create(): BookmarkManager {\n return new BookmarkManager();\n }\n}\n"]}
|