@usejunior/docx-core 0.0.1 → 0.1.1

package/dist/core-types.d.ts

@@ -0,0 +1,296 @@
+/**
+ * WmlComparer Core Data Structures
+ *
+ * TypeScript equivalents of WmlComparer's core C# data structures.
+ * These types form the foundation for the atomization pipeline that
+ * flattens OOXML into comparable units.
+ *
+ * @see https://github.com/OpenXmlDev/Open-Xml-PowerTools/blob/536ca1fb4bcdce1f4c920658bd66807b970393d7/OpenXmlPowerTools/WmlComparer.cs
+ */
+/**
+ * Correlation status for comparison units.
+ *
+ * Tracks the result of comparing atoms between two documents.
+ *
+ * @see WmlComparer.cs line 2264
+ */
+export declare enum CorrelationStatus {
+    /** Not yet processed by comparison algorithm */
+    Unknown = "Unknown",
+    /** Content matches in both documents */
+    Equal = "Equal",
+    /** Content only exists in original document (removed) */
+    Deleted = "Deleted",
+    /** Content only exists in revised document (added) */
+    Inserted = "Inserted",
+    /** Content was moved from this location (source of move) */
+    MovedSource = "MovedSource",
+    /** Content was moved to this location (destination of move) */
+    MovedDestination = "MovedDestination",
+    /** Text content matches but formatting differs */
+    FormatChanged = "FormatChanged"
+}
+/**
+ * Represents an Open Packaging Conventions (OPC) part.
+ *
+ * Minimal interface for tracking which file/part a node originated from.
+ * Integrates with DocxArchive for ZIP extraction.
+ *
+ * @see OpenXmlPart in DocumentFormat.OpenXml.Packaging
+ */
+export interface OpcPart {
+    /** Part URI within the package, e.g., "word/document.xml" */
+    uri: string;
+    /** Content type of the part, e.g., "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml" */
+    contentType: string;
+}
+/**
+ * Transition alias: WmlElement is now the native DOM Element from @xmldom/xmldom.
+ *
+ * All attribute access uses `.getAttribute(name)`, children use DOM traversal,
+ * and parent navigation uses `.parentNode` / `.parentElement`.
+ *
+ * This alias will be removed once all imports are updated to use `Element` directly.
+ */
+export type WmlElement = Element;
+/**
+ * Base interface for any comparison unit (atom or group).
+ *
+ * Represents a unit of content that can be compared between documents.
+ *
+ * @see ComparisonUnit abstract class in WmlComparer.cs lines 2230-2270
+ */
+export interface ComparisonUnit {
+    /** SHA1 hash of the unit's content for quick equality check */
+    sha1Hash: string;
+    /** Current correlation status after comparison */
+    correlationStatus: CorrelationStatus;
+    /** Child comparison units (for groups) */
+    contents?: ComparisonUnit[];
+}
+/**
+ * Format change information for atoms where text matches but formatting differs.
+ *
+ * Stores the old and new run properties along with the specific property names
+ * that changed (e.g., "bold", "italic").
+ */
+export interface FormatChangeInfo {
+    /** Run properties from the original document (before changes) */
+    oldRunProperties: WmlElement | null;
+    /** Run properties from the modified document (after changes) */
+    newRunProperties: WmlElement | null;
+    /** List of property names that changed (e.g., "bold", "italic", "fontSize") */
+    changedProperties: string[];
+}
+/**
+ * Atomic leaf-node unit used in LCS comparison.
+ *
+ * Represents the smallest comparable unit of content. Created by atomizing
+ * the document tree into individual text nodes, breaks, and other leaf elements.
+ *
+ * @see ComparisonUnitAtom class in WmlComparer.cs lines 2305-2350
+ */
+export interface ComparisonUnitAtom extends ComparisonUnit {
+    /** The leaf element (w:t, w:br, w:cr, etc.) */
+    contentElement: WmlElement;
+    /**
+     * Convenience references used by some reconstruction paths (e.g. in-place mode).
+     * These are optional because they can be derived from `ancestorElements`.
+     */
+    sourceRunElement?: WmlElement;
+    sourceParagraphElement?: WmlElement;
+    /** Ancestor elements from root to parent of contentElement */
+    ancestorElements: WmlElement[];
+    /** Unique identifiers extracted from ancestors (w:Unid attributes) */
+    ancestorUnids: string[];
+    /** The OPC part this atom belongs to */
+    part: OpcPart;
+    /** Revision tracking element if this atom is inside w:ins or w:del */
+    revTrackElement?: WmlElement;
+    /** Sequential index of the paragraph this atom belongs to (0-indexed) */
+    paragraphIndex?: number;
+    /** Group ID for atoms that are part of a move operation */
+    moveGroupId?: number;
+    /** Move name for linking source and destination (e.g., "move1") */
+    moveName?: string;
+    /** Format change details when text is equal but formatting differs */
+    formatChange?: FormatChangeInfo;
+    /** Reference to the corresponding atom in the other document (for Equal atoms) */
+    comparisonUnitAtomBefore?: ComparisonUnitAtom;
+    /** True if this atom represents an empty paragraph (paragraph with only w:pPr, no content) */
+    isEmptyParagraph?: boolean;
+    /** Original atoms when this atom represents a collapsed field sequence */
+    collapsedFieldAtoms?: ComparisonUnitAtom[];
+    /** Reference to the parent atom when this atom was created by word-level splitting */
+    splitFromAtom?: ComparisonUnitAtom;
+    /** Which document this atom originated from (for correct formatting application) */
+    sourceDocument?: 'original' | 'revised';
+    /** Cloned run properties (w:rPr) captured at atomization time, or null if no formatting */
+    rPr?: Element | null;
+}
+/**
+ * Settings for move detection algorithm.
+ *
+ * @see WmlComparerSettings in WmlComparer.cs
+ */
+export interface MoveDetectionSettings {
+    /** Enable move detection. Default: true */
+    detectMoves: boolean;
+    /** Minimum Jaccard similarity for a match to be considered a move. Default: 0.8 */
+    moveSimilarityThreshold: number;
+    /** Minimum word count for a block to be considered for move detection. Default: 5 */
+    moveMinimumWordCount: number;
+    /** Case insensitive comparison for move matching. Default: true */
+    caseInsensitiveMove: boolean;
+}
+/**
+ * Default settings for move detection.
+ */
+export declare const DEFAULT_MOVE_DETECTION_SETTINGS: MoveDetectionSettings;
+/**
+ * Block of consecutive atoms with the same status.
+ *
+ * Used during move detection to group atoms into comparable blocks.
+ */
+export interface AtomBlock {
+    /** Status of all atoms in this block (Deleted or Inserted) */
+    status: CorrelationStatus;
+    /** The atoms in this block */
+    atoms: ComparisonUnitAtom[];
+    /** Joined text content from all atoms */
+    text: string;
+    /** Number of words in the text */
+    wordCount: number;
+}
+/**
+ * Settings for format change detection.
+ */
+export interface FormatDetectionSettings {
+    /** Enable format change detection. Default: true */
+    detectFormatChanges: boolean;
+}
+/**
+ * Default settings for format change detection.
+ */
+export declare const DEFAULT_FORMAT_DETECTION_SETTINGS: FormatDetectionSettings;
+/**
+ * Mapping of OOXML run property tag names to friendly names.
+ */
+export declare const RUN_PROPERTY_FRIENDLY_NAMES: Record<string, string>;
+/**
+ * Combined settings for document comparison.
+ */
+export interface WmlComparerSettings extends MoveDetectionSettings, FormatDetectionSettings {
+    /** Author name for revision tracking. Default: "Comparison" */
+    author: string;
+    /** Timestamp for revisions. Default: current time */
+    dateTime: Date;
+}
+/**
+ * Default comparison settings.
+ */
+export declare const DEFAULT_COMPARER_SETTINGS: WmlComparerSettings;
+/**
+ * Information about list continuation patterns.
+ *
+ * Used to detect "orphan" list items that should render at a different
+ * effective level than their ilvl suggests.
+ */
+export interface ContinuationInfo {
+    /** Whether this paragraph is a continuation pattern */
+    isContinuation: boolean;
+    /** The effective level for rendering (0 for continuations) */
+    effectiveLevel: number;
+}
+/**
+ * Numbering level properties.
+ */
+export interface ListLevelInfo {
+    /** The indentation level (0-based) */
+    ilvl: number;
+    /** Starting number for this level */
+    start: number;
+    /** Number format (decimal, lowerLetter, upperRoman, etc.) */
+    numFmt: string;
+    /** Level text format string (e.g., "%1.", "%1.%2") */
+    lvlText: string;
+    /** Whether legal numbering is enabled */
+    isLgl?: boolean;
+}
+/**
+ * Numbering definition with all levels.
+ */
+export interface NumberingDefinition {
+    /** Numbering definition ID */
+    numId: number;
+    /** Abstract numbering ID */
+    abstractNumId: number;
+    /** Level definitions */
+    levels: ListLevelInfo[];
+}
+/**
+ * Reserved footnote/endnote IDs per ECMA-376.
+ */
+export declare const RESERVED_FOOTNOTE_IDS: {
+    /** Separator footnote */
+    readonly SEPARATOR: "0";
+    /** Continuation separator footnote */
+    readonly CONTINUATION_SEPARATOR: "1";
+};
+/**
+ * Footnote reference information.
+ */
+export interface FootnoteReference {
+    /** XML ID from w:id attribute */
+    xmlId: string;
+    /** Whether this uses a custom mark (suppresses automatic numbering) */
+    customMarkFollows: boolean;
+    /** Display number (sequential order in document) */
+    displayNumber?: number;
+}
+/**
+ * Types of revisions that can be detected.
+ */
+export declare enum WmlComparerRevisionType {
+    /** Text was inserted */
+    Insertion = "Insertion",
+    /** Text was deleted */
+    Deletion = "Deletion",
+    /** Content was moved (source) */
+    MoveFrom = "MoveFrom",
+    /** Content was moved (destination) */
+    MoveTo = "MoveTo",
+    /** Formatting was changed */
+    FormatChanged = "FormatChanged"
+}
+/**
+ * Details about a format change revision.
+ */
+export interface FormatChangeDetails {
+    /** Properties that were added */
+    addedProperties: string[];
+    /** Properties that were removed */
+    removedProperties: string[];
+    /** Properties that were modified */
+    changedProperties: string[];
+}
+/**
+ * A detected revision in the comparison output.
+ */
+export interface WmlComparerRevision {
+    /** Type of revision */
+    type: WmlComparerRevisionType;
+    /** Author of the revision */
+    author: string;
+    /** Timestamp of the revision */
+    date: Date;
+    /** Text content affected by the revision */
+    text: string;
+    /** Revision ID (w:id attribute) */
+    revisionId: number;
+    /** Move name if this is a move revision */
+    moveName?: string;
+    /** Format change details if this is a format change */
+    formatChangeDetails?: FormatChangeDetails;
+}
+//# sourceMappingURL=core-types.d.ts.map

package/dist/core-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-types.d.ts","sourceRoot":"","sources":["../src/core-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH;;;;;;GAMG;AACH,oBAAY,iBAAiB;IAC3B,gDAAgD;IAChD,OAAO,YAAY;IACnB,wCAAwC;IACxC,KAAK,UAAU;IACf,yDAAyD;IACzD,OAAO,YAAY;IACnB,sDAAsD;IACtD,QAAQ,aAAa;IACrB,4DAA4D;IAC5D,WAAW,gBAAgB;IAC3B,+DAA+D;IAC/D,gBAAgB,qBAAqB;IACrC,kDAAkD;IAClD,aAAa,kBAAkB;CAChC;AAMD;;;;;;;GAOG;AACH,MAAM,WAAW,OAAO;IACtB,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC;IACZ,yHAAyH;IACzH,WAAW,EAAE,MAAM,CAAC;CACrB;AAMD;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC;AAMjC;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iEAAiE;IACjE,gBAAgB,EAAE,UAAU,GAAG,IAAI,CAAC;IACpC,gEAAgE;IAChE,gBAAgB,EAAE,UAAU,GAAG,IAAI,CAAC;IACpC,+EAA+E;IAC/E,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,+CAA+C;IAC/C,cAAc,EAAE,UAAU,CAAC;IAC3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC;IAC9B,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,8DAA8D;IAC9D,gBAAgB,EAAE,UAAU,EAAE,CAAC;IAC/B,sEAAsE;IACtE,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,wCAAwC;IACxC,IAAI,EAAE,OAAO,CAAC;IACd,sEAAsE;IACtE,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,yEAAyE;IACzE,cAAc,CAAC,EAAE,MAAM,CAAC;IAGxB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,sEAAsE;IACtE,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,kFAAkF;IAClF,wBAAwB,CAAC,EAAE,kBAAkB,CAAC;IAG9C,8FAA8F;IAC9F,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAG3B,0EAA0E;IAC1E,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAG3C,sFAAsF;IACtF,aAAa,CAAC,EAAE,kBAAkB,CAAC;IAGnC,oFAAoF;IACpF,cAAc,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAGxC,2FAA2F;IAC3F,GAAG,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACtB;AAMD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,2CAA2C;IAC3C,WAAW,EAAE,OAAO,CAAC;IACrB,mFAAmF;IACnF,uBAAuB,EAAE,MAAM,CAAC;IAChC,qFAAqF;IACrF,oBAAoB,EAAE,MAAM,CAAC;IAC7B,mEAAmE;IACnE,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,+BAA+B,EAAE,qBAK7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,8DAA8D;IAC9D,MAAM,EAAE,iBAAiB,CAAC;IAC1B,8BAA8B;IAC9B,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,oDAAoD;IACpD,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,iCAAiC,EAAE,uBAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CA0B9D,CAAC;AAMF;;GAEG;AACH,MAAM,WAAW,mBACf,SAAQ,qBAAqB,EAC3B,uBAAuB;IACzB,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,QAAQ,EAAE,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,mBAKvC,CAAC;AAMF;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uDAAuD;IACvD,cAAc,EAAE,OAAO,CAAC;IACxB,8DAA8D;IAC9D,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,wBAAwB;IACxB,MAAM,EAAE,aAAa,EAAE,CAAC;CACzB;AAMD;;GAEG;AACH,eAAO,MAAM,qBAAqB;IAChC,yBAAyB;;IAEzB,sCAAsC;;CAE9B,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oDAAoD;IACpD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD;;GAEG;AACH,oBAAY,uBAAuB;IACjC,wBAAwB;IACxB,SAAS,cAAc;IACvB,uBAAuB;IACvB,QAAQ,aAAa;IACrB,iCAAiC;IACjC,QAAQ,aAAa;IACrB,sCAAsC;IACtC,MAAM,WAAW;IACjB,6BAA6B;IAC7B,aAAa,kBAAkB;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iCAAiC;IACjC,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mCAAmC;IACnC,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,oCAAoC;IACpC,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,uBAAuB;IACvB,IAAI,EAAE,uBAAuB,CAAC;IAC9B,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,IAAI,EAAE,IAAI,CAAC;IACX,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;CAC3C"}

package/dist/core-types.js

@@ -0,0 +1,122 @@
+/**
+ * WmlComparer Core Data Structures
+ *
+ * TypeScript equivalents of WmlComparer's core C# data structures.
+ * These types form the foundation for the atomization pipeline that
+ * flattens OOXML into comparable units.
+ *
+ * @see https://github.com/OpenXmlDev/Open-Xml-PowerTools/blob/536ca1fb4bcdce1f4c920658bd66807b970393d7/OpenXmlPowerTools/WmlComparer.cs
+ */
+// =============================================================================
+// Correlation Status Enum
+// =============================================================================
+/**
+ * Correlation status for comparison units.
+ *
+ * Tracks the result of comparing atoms between two documents.
+ *
+ * @see WmlComparer.cs line 2264
+ */
+export var CorrelationStatus;
+(function (CorrelationStatus) {
+    /** Not yet processed by comparison algorithm */
+    CorrelationStatus["Unknown"] = "Unknown";
+    /** Content matches in both documents */
+    CorrelationStatus["Equal"] = "Equal";
+    /** Content only exists in original document (removed) */
+    CorrelationStatus["Deleted"] = "Deleted";
+    /** Content only exists in revised document (added) */
+    CorrelationStatus["Inserted"] = "Inserted";
+    /** Content was moved from this location (source of move) */
+    CorrelationStatus["MovedSource"] = "MovedSource";
+    /** Content was moved to this location (destination of move) */
+    CorrelationStatus["MovedDestination"] = "MovedDestination";
+    /** Text content matches but formatting differs */
+    CorrelationStatus["FormatChanged"] = "FormatChanged";
+})(CorrelationStatus || (CorrelationStatus = {}));
+/**
+ * Default settings for move detection.
+ */
+export const DEFAULT_MOVE_DETECTION_SETTINGS = {
+    detectMoves: true,
+    moveSimilarityThreshold: 0.8,
+    moveMinimumWordCount: 5,
+    caseInsensitiveMove: true,
+};
+/**
+ * Default settings for format change detection.
+ */
+export const DEFAULT_FORMAT_DETECTION_SETTINGS = {
+    detectFormatChanges: true,
+};
+/**
+ * Mapping of OOXML run property tag names to friendly names.
+ */
+export const RUN_PROPERTY_FRIENDLY_NAMES = {
+    'w:b': 'bold',
+    'w:bCs': 'boldComplex',
+    'w:i': 'italic',
+    'w:iCs': 'italicComplex',
+    'w:u': 'underline',
+    'w:strike': 'strikethrough',
+    'w:dstrike': 'doubleStrikethrough',
+    'w:sz': 'fontSize',
+    'w:szCs': 'fontSizeComplex',
+    'w:rFonts': 'font',
+    'w:color': 'color',
+    'w:highlight': 'highlight',
+    'w:shd': 'shading',
+    'w:vertAlign': 'verticalAlign',
+    'w:caps': 'allCaps',
+    'w:smallCaps': 'smallCaps',
+    'w:vanish': 'hidden',
+    'w:emboss': 'emboss',
+    'w:imprint': 'imprint',
+    'w:outline': 'outline',
+    'w:shadow': 'shadow',
+    'w:spacing': 'spacing',
+    'w:w': 'width',
+    'w:kern': 'kerning',
+    'w:position': 'position',
+};
+/**
+ * Default comparison settings.
+ */
+export const DEFAULT_COMPARER_SETTINGS = {
+    ...DEFAULT_MOVE_DETECTION_SETTINGS,
+    ...DEFAULT_FORMAT_DETECTION_SETTINGS,
+    author: 'Comparison',
+    dateTime: new Date(),
+};
+// =============================================================================
+// Footnote Numbering Types
+// =============================================================================
+/**
+ * Reserved footnote/endnote IDs per ECMA-376.
+ */
+export const RESERVED_FOOTNOTE_IDS = {
+    /** Separator footnote */
+    SEPARATOR: '0',
+    /** Continuation separator footnote */
+    CONTINUATION_SEPARATOR: '1',
+};
+// =============================================================================
+// Revision Reporting Types
+// =============================================================================
+/**
+ * Types of revisions that can be detected.
+ */
+export var WmlComparerRevisionType;
+(function (WmlComparerRevisionType) {
+    /** Text was inserted */
+    WmlComparerRevisionType["Insertion"] = "Insertion";
+    /** Text was deleted */
+    WmlComparerRevisionType["Deletion"] = "Deletion";
+    /** Content was moved (source) */
+    WmlComparerRevisionType["MoveFrom"] = "MoveFrom";
+    /** Content was moved (destination) */
+    WmlComparerRevisionType["MoveTo"] = "MoveTo";
+    /** Formatting was changed */
+    WmlComparerRevisionType["FormatChanged"] = "FormatChanged";
+})(WmlComparerRevisionType || (WmlComparerRevisionType = {}));
+//# sourceMappingURL=core-types.js.map

package/dist/core-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-types.js","sourceRoot":"","sources":["../src/core-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,gFAAgF;AAChF,0BAA0B;AAC1B,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,iBAeX;AAfD,WAAY,iBAAiB;IAC3B,gDAAgD;IAChD,wCAAmB,CAAA;IACnB,wCAAwC;IACxC,oCAAe,CAAA;IACf,yDAAyD;IACzD,wCAAmB,CAAA;IACnB,sDAAsD;IACtD,0CAAqB,CAAA;IACrB,4DAA4D;IAC5D,gDAA2B,CAAA;IAC3B,+DAA+D;IAC/D,0DAAqC,CAAA;IACrC,kDAAkD;IAClD,oDAA+B,CAAA;AACjC,CAAC,EAfW,iBAAiB,KAAjB,iBAAiB,QAe5B;AAuJD;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAA0B;IACpE,WAAW,EAAE,IAAI;IACjB,uBAAuB,EAAE,GAAG;IAC5B,oBAAoB,EAAE,CAAC;IACvB,mBAAmB,EAAE,IAAI;CAC1B,CAAC;AA8BF;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAA4B;IACxE,mBAAmB,EAAE,IAAI;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAA2B;IACjE,KAAK,EAAE,MAAM;IACb,OAAO,EAAE,aAAa;IACtB,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,eAAe;IACxB,KAAK,EAAE,WAAW;IAClB,UAAU,EAAE,eAAe;IAC3B,WAAW,EAAE,qBAAqB;IAClC,MAAM,EAAE,UAAU;IAClB,QAAQ,EAAE,iBAAiB;IAC3B,UAAU,EAAE,MAAM;IAClB,SAAS,EAAE,OAAO;IAClB,aAAa,EAAE,WAAW;IAC1B,OAAO,EAAE,SAAS;IAClB,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,SAAS;IACnB,aAAa,EAAE,WAAW;IAC1B,UAAU,EAAE,QAAQ;IACpB,UAAU,EAAE,QAAQ;IACpB,WAAW,EAAE,SAAS;IACtB,WAAW,EAAE,SAAS;IACtB,UAAU,EAAE,QAAQ;IACpB,WAAW,EAAE,SAAS;IACtB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,SAAS;IACnB,YAAY,EAAE,UAAU;CACzB,CAAC;AAkBF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAwB;IAC5D,GAAG,+BAA+B;IAClC,GAAG,iCAAiC;IACpC,MAAM,EAAE,YAAY;IACpB,QAAQ,EAAE,IAAI,IAAI,EAAE;CACrB,CAAC;AA+CF,gFAAgF;AAChF,2BAA2B;AAC3B,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,yBAAyB;IACzB,SAAS,EAAE,GAAG;IACd,sCAAsC;IACtC,sBAAsB,EAAE,GAAG;CACnB,CAAC;AAcX,gFAAgF;AAChF,2BAA2B;AAC3B,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAN,IAAY,uBAWX;AAXD,WAAY,uBAAuB;IACjC,wBAAwB;IACxB,kDAAuB,CAAA;IACvB,uBAAuB;IACvB,gDAAqB,CAAA;IACrB,iCAAiC;IACjC,gDAAqB,CAAA;IACrB,sCAAsC;IACtC,4CAAiB,CAAA;IACjB,6BAA6B;IAC7B,0DAA+B,CAAA;AACjC,CAAC,EAXW,uBAAuB,KAAvB,uBAAuB,QAWlC"}

package/dist/footnotes.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Footnote Numbering Module
+ *
+ * Handles sequential footnote/endnote numbering by document order.
+ *
+ * Per ECMA-376, w:id on footnoteReference is a reference identifier, NOT the
+ * display number. Display numbers are sequential based on document order.
+ *
+ * @example
+ * Document has 91 footnotes with XML IDs 2-92 (IDs 0, 1 are reserved):
+ * - Incorrect: Display as 2, 3, 4, ..., 92
+ * - Correct: Display as 1, 2, 3, ..., 91
+ */
+import { FootnoteReference, WmlElement } from './core-types.js';
+/**
+ * Find all footnote or endnote references in document order.
+ *
+ * Recursively traverses the document tree to find references in reading order.
+ *
+ * @param element - The root element to search from
+ * @param tagName - The reference tag to find ('w:footnoteReference' or 'w:endnoteReference')
+ * @returns Array of reference elements in document order
+ */
+export declare function findReferencesInOrder(element: WmlElement, tagName: 'w:footnoteReference' | 'w:endnoteReference'): WmlElement[];
+/**
+ * Check if a footnote/endnote ID is reserved.
+ *
+ * IDs 0 and 1 are reserved for separator types per ECMA-376.
+ *
+ * @param xmlId - The XML ID to check
+ * @returns True if this is a reserved ID
+ */
+export declare function isReservedId(xmlId: string): boolean;
+/**
+ * Tracks sequential footnote/endnote numbering by document order.
+ *
+ * Scans the document for footnote/endnote references and builds a mapping
+ * from XML IDs to display numbers.
+ *
+ * @example
+ * const tracker = new FootnoteNumberingTracker(documentRoot);
+ * const displayNum = tracker.getDisplayNumber('42'); // Returns 1 if '42' is the first footnote
+ */
+export declare class FootnoteNumberingTracker {
+    private footnoteIdToDisplayNumber;
+    private endnoteIdToDisplayNumber;
+    private footnoteCustomMarks;
+    private endnoteCustomMarks;
+    /**
+     * Create a new tracker by scanning the document.
+     *
+     * @param documentRoot - The root element of the main document (w:document or w:body)
+     */
+    constructor(documentRoot: WmlElement);
+    /**
+     * Scan the document for footnote and endnote references.
+     */
+    private scanDocument;
+    /**
+     * Build the ID to display number mapping.
+     */
+    private buildNumbering;
+    /**
+     * Get the display number for a footnote by its XML ID.
+     *
+     * @param xmlId - The XML ID (w:id attribute)
+     * @returns The display number, or undefined if not found or uses custom mark
+     */
+    getFootnoteDisplayNumber(xmlId: string): number | undefined;
+    /**
+     * Get the display number for an endnote by its XML ID.
+     *
+     * @param xmlId - The XML ID (w:id attribute)
+     * @returns The display number, or undefined if not found or uses custom mark
+     */
+    getEndnoteDisplayNumber(xmlId: string): number | undefined;
+    /**
+     * Get the display number for a footnote or endnote by its XML ID.
+     *
+     * Convenience method that checks both footnotes and endnotes.
+     *
+     * @param xmlId - The XML ID
+     * @returns The display number, or undefined if not found
+     */
+    getDisplayNumber(xmlId: string): number | undefined;
+    /**
+     * Check if a footnote uses a custom mark.
+     *
+     * @param xmlId - The XML ID
+     * @returns True if this footnote has w:customMarkFollows
+     */
+    hasFootnoteCustomMark(xmlId: string): boolean;
+    /**
+     * Check if an endnote uses a custom mark.
+     *
+     * @param xmlId - The XML ID
+     * @returns True if this endnote has w:customMarkFollows
+     */
+    hasEndnoteCustomMark(xmlId: string): boolean;
+    /**
+     * Get the total number of footnotes (excluding custom marks).
+     */
+    getFootnoteCount(): number;
+    /**
+     * Get the total number of endnotes (excluding custom marks).
+     */
+    getEndnoteCount(): number;
+    /**
+     * Get all footnote references as structured data.
+     *
+     * @returns Array of FootnoteReference objects
+     */
+    getFootnoteReferences(): FootnoteReference[];
+    /**
+     * Get all endnote references as structured data.
+     *
+     * @returns Array of FootnoteReference objects
+     */
+    getEndnoteReferences(): FootnoteReference[];
+}
+/**
+ * Find a footnote element by its ID in the footnotes.xml part.
+ *
+ * @param footnotesRoot - The root of the footnotes.xml document
+ * @param xmlId - The XML ID to find
+ * @returns The w:footnote element, or undefined if not found
+ */
+export declare function findFootnoteById(footnotesRoot: WmlElement, xmlId: string): WmlElement | undefined;
+/**
+ * Find an endnote element by its ID in the endnotes.xml part.
+ *
+ * @param endnotesRoot - The root of the endnotes.xml document
+ * @param xmlId - The XML ID to find
+ * @returns The w:endnote element, or undefined if not found
+ */
+export declare function findEndnoteById(endnotesRoot: WmlElement, xmlId: string): WmlElement | undefined;
+/**
+ * Extract plain text content from a footnote/endnote element.
+ *
+ * @param noteElement - The w:footnote or w:endnote element
+ * @returns Plain text content
+ */
+export declare function extractNoteText(noteElement: WmlElement): string;
+//# sourceMappingURL=footnotes.d.ts.map

package/dist/footnotes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"footnotes.d.ts","sourceRoot":"","sources":["../src/footnotes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,iBAAiB,EAEjB,UAAU,EACX,MAAM,iBAAiB,CAAC;AAOzB;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,UAAU,EACnB,OAAO,EAAE,qBAAqB,GAAG,oBAAoB,GACpD,UAAU,EAAE,CAcd;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAKnD;AAMD;;;;;;;;;GASG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,yBAAyB,CAAkC;IACnE,OAAO,CAAC,wBAAwB,CAAkC;IAClE,OAAO,CAAC,mBAAmB,CAA0B;IACrD,OAAO,CAAC,kBAAkB,CAA0B;IAEpD;;;;OAIG;gBACS,YAAY,EAAE,UAAU;IAIpC;;OAEG;IACH,OAAO,CAAC,YAAY;IAwBpB;;OAEG;IACH,OAAO,CAAC,cAAc;IAmCtB;;;;;OAKG;IACH,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI3D;;;;;OAKG;IACH,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1D;;;;;;;OAOG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAOnD;;;;;OAKG;IACH,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAI7C;;;;;OAKG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAI5C;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,eAAe,IAAI,MAAM;IAIzB;;;;OAIG;IACH,qBAAqB,IAAI,iBAAiB,EAAE;IAwB5C;;;;OAIG;IACH,oBAAoB,IAAI,iBAAiB,EAAE;CAuB5C;AAMD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,aAAa,EAAE,UAAU,EACzB,KAAK,EAAE,MAAM,GACZ,UAAU,GAAG,SAAS,CAYxB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,UAAU,EACxB,KAAK,EAAE,MAAM,GACZ,UAAU,GAAG,SAAS,CAYxB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,UAAU,GAAG,MAAM,CAiB/D"}