docxmlater 10.4.0 → 11.0.4

package/src/index.ts

@@ -13,7 +13,7 @@ export {
   DocumentOptions,
   DocumentLoadOptions,
   DocumentPart,
-} from './core/Document';
+} from './core/Document.js';
 
 // =============================================================================
 // PUBLIC API — Document Elements
@@ -34,8 +34,8 @@ export {
   isRangeMarker,
   isShape,
   isTextBox,
-} from './elements/Paragraph';
-export { Run, RunFormatting, ThemeColorValue, LanguageConfig } from './elements/Run';
+} from './elements/Paragraph.js';
+export { Run, RunFormatting, ThemeColorValue, LanguageConfig } from './elements/Run.js';
 export {
   Section,
   PageOrientation,
@@ -48,7 +48,7 @@ export {
   SectionProperties,
   LineNumbering,
   LineNumberingRestart,
-} from './elements/Section';
+} from './elements/Section.js';
 export {
   Table,
   TableAlignment,
@@ -56,16 +56,20 @@ export {
   TableBorder,
   TableBorders,
   TableFormatting,
-} from './elements/Table';
-export { TableRow, RowFormatting } from './elements/TableRow';
+} from './elements/Table.js';
+export { TableRow, RowFormatting } from './elements/TableRow.js';
 export {
   TableCell,
   CellBorder,
   CellBorders,
   CellShading,
   CellFormatting,
-} from './elements/TableCell';
-export { TableGridChange, GridColumn, TableGridChangeProperties } from './elements/TableGridChange';
+} from './elements/TableCell.js';
+export {
+  TableGridChange,
+  GridColumn,
+  TableGridChangeProperties,
+} from './elements/TableGridChange.js';
 export {
   Image,
   ImageFormat,
@@ -76,18 +80,18 @@ export {
   BlipCompressionState,
   PicLockAttribute,
   PicNonVisualProperties,
-} from './elements/Image';
-export { ImageRun } from './elements/ImageRun';
-export { Shape, ShapeType, ShapeProperties, ShapeFill, ShapeOutline } from './elements/Shape';
-export { TextBox, TextBoxProperties, TextBoxFill, TextBoxMargins } from './elements/TextBox';
-export { Header, HeaderType, HeaderProperties } from './elements/Header';
-export { Footer, FooterType, FooterProperties } from './elements/Footer';
-export { Hyperlink, HyperlinkProperties } from './elements/Hyperlink';
-export { Bookmark, BookmarkProperties } from './elements/Bookmark';
-export { RangeMarker, RangeMarkerType, RangeMarkerProperties } from './elements/RangeMarker';
-export { Comment, CommentProperties } from './elements/Comment';
-export { Footnote, FootnoteType, FootnoteProperties } from './elements/Footnote';
-export { Endnote, EndnoteType, EndnoteProperties } from './elements/Endnote';
+} from './elements/Image.js';
+export { ImageRun } from './elements/ImageRun.js';
+export { Shape, ShapeType, ShapeProperties, ShapeFill, ShapeOutline } from './elements/Shape.js';
+export { TextBox, TextBoxProperties, TextBoxFill, TextBoxMargins } from './elements/TextBox.js';
+export { Header, HeaderType, HeaderProperties } from './elements/Header.js';
+export { Footer, FooterType, FooterProperties } from './elements/Footer.js';
+export { Hyperlink, HyperlinkProperties } from './elements/Hyperlink.js';
+export { Bookmark, BookmarkProperties } from './elements/Bookmark.js';
+export { RangeMarker, RangeMarkerType, RangeMarkerProperties } from './elements/RangeMarker.js';
+export { Comment, CommentProperties } from './elements/Comment.js';
+export { Footnote, FootnoteType, FootnoteProperties } from './elements/Footnote.js';
+export { Endnote, EndnoteType, EndnoteProperties } from './elements/Endnote.js';
 export {
   Field,
   FieldType,
@@ -97,7 +101,7 @@ export {
   FieldCharType,
   TOCFieldOptions,
   createTOCField,
-} from './elements/Field';
+} from './elements/Field.js';
 export {
   createNestedIFMergeField,
   createMergeField,
@@ -108,7 +112,7 @@ export {
   buildHyperlinkInstruction,
   isHyperlinkInstruction,
   ParsedHyperlinkInstruction,
-} from './elements/FieldHelpers';
+} from './elements/FieldHelpers.js';
 export {
   StructuredDocumentTag,
   SDTProperties,
@@ -117,20 +121,20 @@ export {
   SDTPlaceholder,
   SDTDataBinding,
   ContentControlType,
-} from './elements/StructuredDocumentTag';
-export { TableOfContents, TOCProperties } from './elements/TableOfContents';
-export { TableOfContentsElement } from './elements/TableOfContentsElement';
-export { AlternateContent } from './elements/AlternateContent';
-export { MathParagraph, MathExpression } from './elements/MathElement';
-export { CustomXmlBlock } from './elements/CustomXml';
-export { PreservedElement, PreservedElementContext } from './elements/PreservedElement';
+} from './elements/StructuredDocumentTag.js';
+export { TableOfContents, TOCProperties } from './elements/TableOfContents.js';
+export { TableOfContentsElement } from './elements/TableOfContentsElement.js';
+export { AlternateContent } from './elements/AlternateContent.js';
+export { MathParagraph, MathExpression } from './elements/MathElement.js';
+export { CustomXmlBlock } from './elements/CustomXml.js';
+export { PreservedElement, PreservedElementContext } from './elements/PreservedElement.js';
 
 // =============================================================================
 // PUBLIC API — Track Changes / Revisions
 // =============================================================================
 
-export { Revision, RevisionType, RevisionProperties, FieldContext } from './elements/Revision';
-export { RevisionContent, isRunContent, isHyperlinkContent } from './elements/RevisionContent';
+export { Revision, RevisionType, RevisionProperties, FieldContext } from './elements/Revision.js';
+export { RevisionContent, isRunContent, isHyperlinkContent } from './elements/RevisionContent.js';
 export {
   RevisionLocation,
   RunPropertyChange,
@@ -151,7 +155,7 @@ export {
   isTablePropertyChange,
   isSectionPropertyChange,
   isNumberingChange,
-} from './elements/PropertyChangeTypes';
+} from './elements/PropertyChangeTypes.js';
 export {
   acceptRevisionsInMemory,
   AcceptRevisionsOptions,
@@ -160,16 +164,16 @@ export {
   getRevisionsFromParagraph,
   countRevisionsByType,
   stripRevisionsFromXml,
-} from './utils/InMemoryRevisionAcceptor';
+} from './processors/InMemoryRevisionAcceptor.js';
 export {
   MoveOperationHelper,
   MoveOperationOptions,
   MoveOperationResult,
-} from './utils/MoveOperationHelper';
+} from './processors/MoveOperationHelper.js';
 export {
   SelectiveRevisionAcceptor,
   SelectiveAcceptResult,
-} from './utils/SelectiveRevisionAcceptor';
+} from './processors/SelectiveRevisionAcceptor.js';
 export {
   RevisionAwareProcessor,
   RevisionHandlingMode,
@@ -178,7 +182,7 @@ export {
   RevisionProcessingResult,
   ConflictInfo,
   ProcessingLogEntry,
-} from './utils/RevisionAwareProcessor';
+} from './processors/RevisionAwareProcessor.js';
 export {
   ChangelogGenerator,
   ChangeEntry,
@@ -188,19 +192,19 @@ export {
   ChangelogFormat,
   ConsolidatedChange,
   ChangelogSummary,
-} from './utils/ChangelogGenerator';
+} from './processors/ChangelogGenerator.js';
 
 // =============================================================================
 // PUBLIC API — Formatting / Styles / Numbering
 // =============================================================================
 
-export { Style, StyleType, StyleProperties } from './formatting/Style';
+export { Style, StyleType, StyleProperties } from './formatting/Style.js';
 export {
   StylesManager,
   ValidationResult,
   LatentStylesConfig,
   LatentStyleException,
-} from './formatting/StylesManager';
+} from './formatting/StylesManager.js';
 export {
   NumberingLevel,
   NumberFormat,
@@ -208,14 +212,14 @@ export {
   NumberingLevelProperties,
   WORD_NATIVE_BULLETS,
   WordNativeBullet,
-} from './formatting/NumberingLevel';
-export { AbstractNumbering, AbstractNumberingProperties } from './formatting/AbstractNumbering';
-export { NumberingInstance, NumberingInstanceProperties } from './formatting/NumberingInstance';
+} from './formatting/NumberingLevel.js';
+export { AbstractNumbering, AbstractNumberingProperties } from './formatting/AbstractNumbering.js';
+export { NumberingInstance, NumberingInstanceProperties } from './formatting/NumberingInstance.js';
 export {
   NumberingManager,
   NumberingConsolidationOptions,
   NumberingConsolidationResult,
-} from './formatting/NumberingManager';
+} from './formatting/NumberingManager.js';
 export {
   StyleRunFormatting,
   StyleParagraphFormatting,
@@ -223,33 +227,33 @@ export {
   StyleConfig,
   Heading2Config,
   ApplyCustomFormattingOptions,
-} from './types/styleConfig';
-export { FormatOptions, StyleApplyOptions, EmphasisType, ListPrefix } from './types/formatting';
+} from './types/styleConfig.js';
+export { FormatOptions, StyleApplyOptions, EmphasisType, ListPrefix } from './types/formatting.js';
 
 // =============================================================================
 // PUBLIC API — Managers
 // =============================================================================
 
-export { RevisionManager, RevisionCategory, RevisionSummary } from './elements/RevisionManager';
-export { ImageManager } from './elements/ImageManager';
-export { BookmarkManager } from './elements/BookmarkManager';
-export { CommentManager } from './elements/CommentManager';
-export { FootnoteManager } from './elements/FootnoteManager';
-export { EndnoteManager } from './elements/EndnoteManager';
-export { HeaderFooterManager } from './elements/HeaderFooterManager';
-export { FontManager, FontFormat, FontEntry } from './elements/FontManager';
+export { RevisionManager, RevisionCategory, RevisionSummary } from './elements/RevisionManager.js';
+export { ImageManager } from './elements/ImageManager.js';
+export { BookmarkManager } from './elements/BookmarkManager.js';
+export { CommentManager } from './elements/CommentManager.js';
+export { FootnoteManager } from './elements/FootnoteManager.js';
+export { EndnoteManager } from './elements/EndnoteManager.js';
+export { HeaderFooterManager } from './elements/HeaderFooterManager.js';
+export { FontManager, FontFormat, FontEntry } from './elements/FontManager.js';
 export {
   DrawingManager,
   DrawingElement,
   DrawingType,
   PreservedDrawing,
-} from './managers/DrawingManager';
+} from './managers/DrawingManager.js';
 
 // =============================================================================
 // PUBLIC API — Image Optimization
 // =============================================================================
 
-export type { ImageOptimizationResult } from './images/ImageOptimizer';
+export type { ImageOptimizationResult } from './images/ImageOptimizer.js';
 
 // =============================================================================
 // TYPES — Common / Shared Type Definitions
@@ -291,7 +295,7 @@ export {
   isWidthType,
   DEFAULT_BORDER,
   NO_BORDER,
-} from './elements/CommonTypes';
+} from './elements/CommonTypes.js';
 export {
   ListCategory,
   NumberFormat as ListNumberFormat,
@@ -301,28 +305,32 @@ export {
   ListNormalizationOptions,
   ListNormalizationReport,
   IndentationLevel,
-} from './types/list-types';
+} from './types/list-types.js';
 
-export { CompatibilityMode, CompatibilityInfo, CompatSetting } from './types/compatibility-types';
+export {
+  CompatibilityMode,
+  CompatibilityInfo,
+  CompatSetting,
+} from './types/compatibility-types.js';
 
 export {
   DocumentProtection,
   RevisionViewSettings,
   TrackChangesSettings,
   WebSettingsInfo,
-} from './types/settings-types';
+} from './types/settings-types.js';
 
 // =============================================================================
 // TYPES — Compatibility Upgrade
 // =============================================================================
 
-export { CompatibilityUpgrader, UpgradeReport } from './utils/CompatibilityUpgrader';
+export { CompatibilityUpgrader, UpgradeReport } from './processors/CompatibilityUpgrader.js';
 export {
   LEGACY_COMPAT_ELEMENTS,
   LEGACY_COMPAT_ELEMENT_NAMES,
   MODERN_COMPAT_SETTINGS,
   MS_WORD_COMPAT_URI,
-} from './constants/legacyCompatFlags';
+} from './constants/legacyCompatFlags.js';
 
 // =============================================================================
 // UTILITIES — Unit Conversions
@@ -363,7 +371,7 @@ export {
   pixelsToTwips,
   pixelsToCm,
   pixelsToPoints,
-} from './utils/units';
+} from './utils/units.js';
 
 // =============================================================================
 // UTILITIES — Validation, Corruption Detection, Error Handling
@@ -392,7 +400,7 @@ export {
   sanitizeHyperlinkUrl,
   SanitizeHyperlinkUrlResult,
   TextValidationResult,
-} from './utils/validation';
+} from './utils/validation.js';
 export {
   detectCorruptionInDocument,
   detectCorruptionInText,
@@ -401,8 +409,8 @@ export {
   CorruptionReport,
   CorruptionLocation,
   CorruptionType,
-} from './utils/corruptionDetection';
-export { isError, toError, wrapError, getErrorMessage } from './utils/errorHandling';
+} from './utils/corruptionDetection.js';
+export { isError, toError, wrapError, getErrorMessage } from './utils/errorHandling.js';
 export {
   REVISION_RULES,
   ValidationSeverity,
@@ -419,7 +427,7 @@ export {
   getAutoFixableRules,
   RevisionValidator,
   RevisionAutoFixer,
-} from './validation';
+} from './validation/index.js';
 
 // =============================================================================
 // UTILITIES — Formatting, Parsing, Sanitization
@@ -432,20 +440,20 @@ export {
   cleanFormatting,
   isEqualFormatting,
   applyDefaults,
-} from './utils/formatting';
+} from './utils/formatting.js';
 export {
   safeParseInt,
   parseOoxmlBoolean,
   isExplicitlySet,
   parseNumericAttribute,
   parseOnOffAttribute,
-} from './utils/parsingHelpers';
+} from './utils/parsingHelpers.js';
 export {
   removeInvalidXmlChars,
   findInvalidXmlChars,
   hasInvalidXmlChars,
   XML_CONTROL_CHARS,
-} from './utils/xmlSanitization';
+} from './utils/xmlSanitization.js';
 
 // =============================================================================
 // UTILITIES — List Detection (kept for basic detection; normalization moved to consumer)
@@ -462,7 +470,7 @@ export {
   TYPED_LIST_PATTERNS,
   PATTERN_TO_CATEGORY,
   FORMAT_TO_LEVEL,
-} from './utils/list-detection';
+} from './utils/list-detection.js';
 
 // =============================================================================
 // UTILITIES — Logging
@@ -481,81 +489,64 @@ export {
   getGlobalLogger,
   setGlobalLogger,
   resetGlobalLogger,
-} from './utils/logger';
+} from './utils/logger.js';
 
 // =============================================================================
 // UTILITIES — Revision Walker
 // =============================================================================
 
-export { RevisionWalker, RevisionWalkerOptions } from './utils/RevisionWalker';
-export { resolveCellShading } from './utils/ShadingResolver';
-export { decodeCnfStyle, getActiveConditionalsInPriorityOrder } from './utils/cnfStyleDecoder';
+export { RevisionWalker, RevisionWalkerOptions } from './processors/RevisionWalker.js';
+export { resolveCellShading } from './processors/ShadingResolver.js';
+export {
+  decodeCnfStyle,
+  getActiveConditionalsInPriorityOrder,
+} from './processors/cnfStyleDecoder.js';
 
 // =============================================================================
 // UTILITIES — Cleanup
 // =============================================================================
 
-export { CleanupHelper, CleanupOptions, CleanupReport } from './helpers/CleanupHelper';
+export { CleanupHelper, CleanupOptions, CleanupReport } from './helpers/CleanupHelper.js';
 
 // =============================================================================
-// INTERNAL — ZIP Handling (advanced usage)
+// PUBLIC — Type unions consumers see when iterating doc.getBodyElements()
 // =============================================================================
 
-export { ZipHandler } from './zip/ZipHandler';
-export { ZipReader } from './zip/ZipReader';
-export { ZipWriter } from './zip/ZipWriter';
-export {
-  ZipFile,
-  FileMap,
-  LoadOptions,
-  SaveOptions,
-  AddFileOptions,
-  SizeLimitOptions,
-  DEFAULT_SIZE_LIMITS,
-  REQUIRED_DOCX_FILES,
-  DOCX_PATHS,
-} from './zip/types';
+export type { BodyElement } from './core/DocumentContent.js';
 export {
-  DocxError,
-  DocxNotFoundError,
-  InvalidDocxError,
-  CorruptedArchiveError,
-  MissingRequiredFileError,
-  FileOperationError,
-} from './zip/errors';
+  RelationshipType,
+  type Relationship,
+  type RelationshipProperties,
+} from './core/Relationship.js';
 
 // =============================================================================
-// INTERNAL — XML Builder and Parser (advanced usage)
+// EXTENSIBILITY — Plugin Registries and Document Events
 // =============================================================================
 
-export { XMLBuilder, XMLElement } from './xml/XMLBuilder';
 export {
-  XMLParser,
-  ParseToObjectOptions,
-  ParsedXMLValue,
-  ParsedXMLObject,
-  DEFAULT_MAX_NESTING_DEPTH,
-} from './xml/XMLParser';
-
-// =============================================================================
-// INTERNAL — Parser, Generator, Validator (advanced usage)
-// =============================================================================
-
-export { Relationship, RelationshipType, RelationshipProperties } from './core/Relationship';
-export { RelationshipManager } from './core/RelationshipManager';
-export { DocumentParser, ParseError } from './core/DocumentParser';
-export { DocumentGenerator, IZipHandlerReader } from './core/DocumentGenerator';
-export { DocumentValidator, SizeEstimate, MemoryOptions } from './core/DocumentValidator';
-export { DocumentIdManager } from './core/DocumentIdManager';
-
-// =============================================================================
-// INTERNAL — Document Subsystem Classes (advanced usage)
-// =============================================================================
-
-export { DocumentContent, BodyElement } from './core/DocumentContent';
-
-// =============================================================================
-// INTERNAL — Constants
-// =============================================================================
+  ElementRegistry,
+  type ElementHandler,
+  type ElementParseContext,
+  type ElementSerializeContext,
+} from './core/ElementRegistry.js';
+export { RegisteredBodyElement } from './elements/RegisteredBodyElement.js';
+export {
+  ValidationRuleRegistry,
+  type CustomValidationRule,
+  type CustomValidationIssue,
+  type CustomValidationSeverity,
+} from './validation/ValidationRuleRegistry.js';
+export type {
+  DocumentEventMap,
+  DocumentEventType,
+  DocumentEventListener,
+} from './core/DocumentEvents.js';
 
-export { LIMITS } from './constants/limits';
+// Low-level building blocks — XMLBuilder, XMLParser, ZipHandler,
+// ZipReader, ZipWriter, DocumentParser, DocumentGenerator,
+// DocumentValidator, DocumentIdManager, DocumentContent,
+// RelationshipManager, DocumentEventEmitter, plus zip/xml types and
+// DocxError hierarchy — moved to the `docxmlater/internal` subpath in
+// 11.0.0. Migrate via:
+//   import { XMLParser, ZipHandler } from 'docxmlater/internal';
+// The internal subpath has relaxed semver — pin an exact version.

package/src/internal.ts

@@ -0,0 +1,79 @@
+/**
+ * docxmlater INTERNAL API
+ *
+ * Subpath export consumed via `import { ... } from 'docxmlater/internal'`.
+ * Surfaces low-level building blocks for advanced consumers writing
+ * tooling that needs raw XML / ZIP / parser access:
+ *   - ZipHandler, ZipReader, ZipWriter (+ types and DocxError hierarchy)
+ *   - XMLBuilder, XMLParser (+ ParseToObjectOptions etc.)
+ *   - DocumentParser, DocumentGenerator, DocumentValidator
+ *   - DocumentIdManager, DocumentContent, RelationshipManager
+ *   - DocumentEventEmitter (the emitter class itself)
+ *   - LIMITS constants
+ *
+ * **Stability:** these exports follow a relaxed semver — minor version
+ * bumps may change signatures. Pin an exact docxmlater version when
+ * consuming the internal subpath. The main API (`from 'docxmlater'`)
+ * follows full semver.
+ *
+ * Symbols moved out of the main API in 11.0.0 — see CHANGELOG.
+ *
+ * The plugin registries (`ElementRegistry`, `ValidationRuleRegistry`)
+ * and event types (`DocumentEventMap`, `DocumentEventListener`,
+ * `DocumentEventType`) are NOT re-exported here — they belong in the
+ * main API as stable extension points.
+ */
+
+// ZIP layer
+export { ZipHandler } from './zip/ZipHandler.js';
+export { ZipReader } from './zip/ZipReader.js';
+export { ZipWriter } from './zip/ZipWriter.js';
+export {
+  type ZipFile,
+  type FileMap,
+  type LoadOptions,
+  type SaveOptions,
+  type AddFileOptions,
+  type SizeLimitOptions,
+  DEFAULT_SIZE_LIMITS,
+  REQUIRED_DOCX_FILES,
+  DOCX_PATHS,
+} from './zip/types.js';
+export {
+  DocxError,
+  DocxNotFoundError,
+  InvalidDocxError,
+  CorruptedArchiveError,
+  MissingRequiredFileError,
+  FileOperationError,
+} from './zip/errors.js';
+
+// XML layer
+export { XMLBuilder, type XMLElement } from './xml/XMLBuilder.js';
+export {
+  XMLParser,
+  type ParseToObjectOptions,
+  type ParsedXMLValue,
+  type ParsedXMLObject,
+  DEFAULT_MAX_NESTING_DEPTH,
+} from './xml/XMLParser.js';
+
+// Core orchestration
+export { RelationshipManager } from './core/RelationshipManager.js';
+export { DocumentParser, ParseError } from './core/DocumentParser.js';
+export { DocumentGenerator, type IZipHandlerReader } from './core/DocumentGenerator.js';
+export {
+  DocumentValidator,
+  type SizeEstimate,
+  type MemoryOptions,
+} from './core/DocumentValidator.js';
+export { DocumentIdManager } from './core/DocumentIdManager.js';
+export { DocumentContent } from './core/DocumentContent.js';
+
+// Document events — the emitter class is internal; the type aliases
+// (DocumentEventMap, DocumentEventListener, DocumentEventType) live in
+// the main API.
+export { DocumentEventEmitter } from './core/DocumentEvents.js';
+
+// Constants
+export { LIMITS } from './constants/limits.js';

package/src/managers/DrawingManager.ts

@@ -5,9 +5,9 @@
  * Assigns unique IDs and handles relationship management.
  */
 
-import { Image } from '../elements/Image';
-import { Shape } from '../elements/Shape';
-import { TextBox } from '../elements/TextBox';
+import { Image } from '../elements/Image.js';
+import { Shape } from '../elements/Shape.js';
+import { TextBox } from '../elements/TextBox.js';
 
 /**
  * Type representing any drawing element

package/src/{utils → processors}/ChangelogGenerator.ts

@@ -10,9 +10,9 @@
  * @module ChangelogGenerator
  */
 
-import type { Document } from '../core/Document';
-import { Revision, RevisionType } from '../elements/Revision';
-import { getGlobalLogger, createScopedLogger, ILogger } from './logger';
+import type { Document } from '../core/Document.js';
+import { Revision, RevisionType } from '../elements/Revision.js';
+import { getGlobalLogger, createScopedLogger, ILogger } from '../utils/logger.js';
 
 // Scoped logger for ChangelogGenerator
 function getLogger(): ILogger {

package/src/{utils → processors}/CompatibilityUpgrader.ts

@@ -12,8 +12,8 @@ import {
   LEGACY_COMPAT_ELEMENT_NAMES,
   MODERN_COMPAT_SETTINGS,
   MS_WORD_COMPAT_URI,
-} from '../constants/legacyCompatFlags';
-import type { CompatSetting } from '../types/compatibility-types';
+} from '../constants/legacyCompatFlags.js';
+import type { CompatSetting } from '../types/compatibility-types.js';
 
 /**
  * Report of what changed during an upgrade operation.