docxmlater 10.1.4 → 10.1.6

package/src/types/formatting.ts

@@ -1,210 +1,210 @@
-/**
- * Additional formatting types for enhanced document manipulation
- */
-
-// Forward references to avoid circular dependencies
-import type { Paragraph } from '../elements/Paragraph';
-import type { Run } from '../elements/Run';
-
-/**
- * Border style options
- */
-export type BorderStyleType = 'single' | 'double' | 'dashed' | 'dotted' | 'triple' | 'none';
-
-/**
- * Individual border configuration
- */
-export interface BorderStyle {
-  /** Border style */
-  style: BorderStyleType;
-  /** Border width in eighths of a point */
-  width: number;
-  /** Border color in hex format */
-  color: string;
-  /** Space between border and text in points */
-  space?: number;
-}
-
-/**
- * Paragraph border configuration
- */
-export interface ParagraphBorder {
-  /** Top border */
-  top?: BorderStyle;
-  /** Bottom border */
-  bottom?: BorderStyle;
-  /** Left border */
-  left?: BorderStyle;
-  /** Right border */
-  right?: BorderStyle;
-  /** Apply border between paragraphs */
-  between?: boolean;
-}
-
-/**
- * Shading patterns — re-exported from CommonTypes for backward compatibility.
- * @see CommonTypes.ShadingPattern for the canonical definition
- */
-export type { ShadingPattern } from '../elements/CommonTypes';
-
-/**
- * Paragraph shading configuration — re-exported from CommonTypes for backward compatibility.
- * @see CommonTypes.ShadingConfig for the canonical definition (includes theme attributes)
- */
-export type { ShadingConfig as ParagraphShading } from '../elements/CommonTypes';
-
-/**
- * Tab stop alignment
- */
-export type TabAlignment = 'left' | 'center' | 'right' | 'decimal' | 'bar' | 'clear';
-
-/**
- * Tab leader character
- */
-export type TabLeader = 'none' | 'dot' | 'dash' | 'underscore' | 'heavy' | 'middleDot';
-
-/**
- * Tab stop configuration
- */
-export interface TabStop {
-  /** Position in twips from left margin */
-  position: number;
-  /** Tab alignment type */
-  type: TabAlignment;
-  /** Leader character */
-  leader?: TabLeader;
-}
-
-/**
- * Text search options
- */
-export interface FindOptions {
-  /** Case sensitive search */
-  caseSensitive?: boolean;
-  /** Match whole words only */
-  wholeWord?: boolean;
-  /** Use regular expressions */
-  useRegex?: boolean;
-  /** Include headers and footers */
-  includeHeadersFooters?: boolean;
-  /** Include footnotes and endnotes */
-  includeNotes?: boolean;
-}
-
-/**
- * Text replacement options
- */
-export interface ReplaceOptions extends FindOptions {
-  /** Maximum number of replacements (0 = unlimited) */
-  maxReplacements?: number;
-  /** Track changes for replacements */
-  trackChanges?: boolean;
-  /** Author for track changes */
-  author?: string;
-}
-
-/**
- * Search result
- */
-export interface SearchResult {
-  /** The paragraph containing the match */
-  paragraph: Paragraph;
-  /** The run containing the match */
-  run?: Run;
-  /** Match start position in paragraph */
-  startIndex: number;
-  /** Match end position in paragraph */
-  endIndex: number;
-  /** The matched text */
-  match: string;
-}
-
-/**
- * Text emphasis options
- */
-export type EmphasisType = 'bold' | 'italic' | 'underline';
-
-/**
- * List prefix configuration
- */
-export interface ListPrefix {
-  /** List format type */
-  format: 'bullet' | 'number';
-  /** Custom style string (e.g., '•', '1.', 'a)') */
-  style: string;
-}
-
-/**
- * Format options for style application
- */
-export interface FormatOptions {
-  // Text formatting
-  /** Font family name (e.g., 'Arial', 'Verdana') */
-  font?: string;
-  /** Font size in points */
-  size?: number;
-  /** Text color as 6-digit hex (e.g., 'FF0000' for red) */
-  color?: string;
-  /** Text emphasis (bold, italic, underline) */
-  emphasis?: EmphasisType[];
-
-  // Alignment
-  /** Paragraph alignment */
-  alignment?: 'left' | 'right' | 'center' | 'justify';
-
-  // Spacing (in points)
-  /** Space before paragraph in points */
-  spaceAbove?: number;
-  /** Space after paragraph in points */
-  spaceBelow?: number;
-  /** Line spacing in points or multiplier */
-  lineSpacing?: number;
-
-  // Indentation (in inches)
-  /** Left indentation in inches */
-  indentLeft?: number;
-  /** Right indentation in inches */
-  indentRight?: number;
-  /** First line indentation in inches */
-  indentFirst?: number;
-  /** Hanging indentation in inches */
-  indentHanging?: number;
-
-  // Padding (in points) - for table cells
-  /** Top padding in points */
-  paddingTop?: number;
-  /** Bottom padding in points */
-  paddingBottom?: number;
-  /** Left padding in points */
-  paddingLeft?: number;
-  /** Right padding in points */
-  paddingRight?: number;
-
-  // List formatting
-  /** List prefix style */
-  prefixList?: string | ListPrefix;
-
-  // Advanced options
-  /** Border color as 6-digit hex */
-  borderColor?: string;
-  /** Border width in points */
-  borderWidth?: number;
-  /** Background shading color as 6-digit hex */
-  shading?: string;
-  /** Keep with next paragraph */
-  keepWithNext?: boolean;
-  /** Keep lines together */
-  keepLines?: boolean;
-}
-
-/**
- * Options for applying styles to paragraphs
- */
-export interface StyleApplyOptions {
-  /** Specific paragraphs to apply style to (default: auto-detect) */
-  paragraphs?: Paragraph[];
-  /** Properties to preserve from existing formatting */
-  keepProperties?: string[];
-  /** Custom formatting to apply */
-  format?: FormatOptions;
-}
+/**
+ * Additional formatting types for enhanced document manipulation
+ */
+
+// Forward references to avoid circular dependencies
+import type { Paragraph } from '../elements/Paragraph';
+import type { Run } from '../elements/Run';
+
+/**
+ * Border style options
+ */
+export type BorderStyleType = 'single' | 'double' | 'dashed' | 'dotted' | 'triple' | 'none';
+
+/**
+ * Individual border configuration
+ */
+export interface BorderStyle {
+  /** Border style */
+  style: BorderStyleType;
+  /** Border width in eighths of a point */
+  width: number;
+  /** Border color in hex format */
+  color: string;
+  /** Space between border and text in points */
+  space?: number;
+}
+
+/**
+ * Paragraph border configuration
+ */
+export interface ParagraphBorder {
+  /** Top border */
+  top?: BorderStyle;
+  /** Bottom border */
+  bottom?: BorderStyle;
+  /** Left border */
+  left?: BorderStyle;
+  /** Right border */
+  right?: BorderStyle;
+  /** Apply border between paragraphs */
+  between?: boolean;
+}
+
+/**
+ * Shading patterns — re-exported from CommonTypes for backward compatibility.
+ * @see CommonTypes.ShadingPattern for the canonical definition
+ */
+export type { ShadingPattern } from '../elements/CommonTypes';
+
+/**
+ * Paragraph shading configuration — re-exported from CommonTypes for backward compatibility.
+ * @see CommonTypes.ShadingConfig for the canonical definition (includes theme attributes)
+ */
+export type { ShadingConfig as ParagraphShading } from '../elements/CommonTypes';
+
+/**
+ * Tab stop alignment
+ */
+export type TabAlignment = 'left' | 'center' | 'right' | 'decimal' | 'bar' | 'clear';
+
+/**
+ * Tab leader character
+ */
+export type TabLeader = 'none' | 'dot' | 'dash' | 'underscore' | 'heavy' | 'middleDot';
+
+/**
+ * Tab stop configuration
+ */
+export interface TabStop {
+  /** Position in twips from left margin */
+  position: number;
+  /** Tab alignment type */
+  type: TabAlignment;
+  /** Leader character */
+  leader?: TabLeader;
+}
+
+/**
+ * Text search options
+ */
+export interface FindOptions {
+  /** Case sensitive search */
+  caseSensitive?: boolean;
+  /** Match whole words only */
+  wholeWord?: boolean;
+  /** Use regular expressions */
+  useRegex?: boolean;
+  /** Include headers and footers */
+  includeHeadersFooters?: boolean;
+  /** Include footnotes and endnotes */
+  includeNotes?: boolean;
+}
+
+/**
+ * Text replacement options
+ */
+export interface ReplaceOptions extends FindOptions {
+  /** Maximum number of replacements (0 = unlimited) */
+  maxReplacements?: number;
+  /** Track changes for replacements */
+  trackChanges?: boolean;
+  /** Author for track changes */
+  author?: string;
+}
+
+/**
+ * Search result
+ */
+export interface SearchResult {
+  /** The paragraph containing the match */
+  paragraph: Paragraph;
+  /** The run containing the match */
+  run?: Run;
+  /** Match start position in paragraph */
+  startIndex: number;
+  /** Match end position in paragraph */
+  endIndex: number;
+  /** The matched text */
+  match: string;
+}
+
+/**
+ * Text emphasis options
+ */
+export type EmphasisType = 'bold' | 'italic' | 'underline';
+
+/**
+ * List prefix configuration
+ */
+export interface ListPrefix {
+  /** List format type */
+  format: 'bullet' | 'number';
+  /** Custom style string (e.g., '•', '1.', 'a)') */
+  style: string;
+}
+
+/**
+ * Format options for style application
+ */
+export interface FormatOptions {
+  // Text formatting
+  /** Font family name (e.g., 'Arial', 'Verdana') */
+  font?: string;
+  /** Font size in points */
+  size?: number;
+  /** Text color as 6-digit hex (e.g., 'FF0000' for red) */
+  color?: string;
+  /** Text emphasis (bold, italic, underline) */
+  emphasis?: EmphasisType[];
+
+  // Alignment
+  /** Paragraph alignment */
+  alignment?: 'left' | 'right' | 'center' | 'justify';
+
+  // Spacing (in points)
+  /** Space before paragraph in points */
+  spaceAbove?: number;
+  /** Space after paragraph in points */
+  spaceBelow?: number;
+  /** Line spacing in points or multiplier */
+  lineSpacing?: number;
+
+  // Indentation (in inches)
+  /** Left indentation in inches */
+  indentLeft?: number;
+  /** Right indentation in inches */
+  indentRight?: number;
+  /** First line indentation in inches */
+  indentFirst?: number;
+  /** Hanging indentation in inches */
+  indentHanging?: number;
+
+  // Padding (in points) - for table cells
+  /** Top padding in points */
+  paddingTop?: number;
+  /** Bottom padding in points */
+  paddingBottom?: number;
+  /** Left padding in points */
+  paddingLeft?: number;
+  /** Right padding in points */
+  paddingRight?: number;
+
+  // List formatting
+  /** List prefix style */
+  prefixList?: string | ListPrefix;
+
+  // Advanced options
+  /** Border color as 6-digit hex */
+  borderColor?: string;
+  /** Border width in points */
+  borderWidth?: number;
+  /** Background shading color as 6-digit hex */
+  shading?: string;
+  /** Keep with next paragraph */
+  keepWithNext?: boolean;
+  /** Keep lines together */
+  keepLines?: boolean;
+}
+
+/**
+ * Options for applying styles to paragraphs
+ */
+export interface StyleApplyOptions {
+  /** Specific paragraphs to apply style to (default: auto-detect) */
+  paragraphs?: Paragraph[];
+  /** Properties to preserve from existing formatting */
+  keepProperties?: string[];
+  /** Custom formatting to apply */
+  format?: FormatOptions;
+}

package/src/types/list-types.ts

@@ -6,21 +6,21 @@
  */
 
 /** High-level list category */
-export type ListCategory = "numbered" | "bullet" | "none";
+export type ListCategory = 'numbered' | 'bullet' | 'none';
 
 /** Specific number format patterns */
 export type NumberFormat =
-  | "decimal" // 1. 2. 3.
-  | "lowerLetter" // a. b. c.
-  | "upperLetter" // A. B. C.
-  | "lowerRoman" // i. ii. iii.
-  | "upperRoman"; // I. II. III.
+  | 'decimal' // 1. 2. 3.
+  | 'lowerLetter' // a. b. c.
+  | 'upperLetter' // A. B. C.
+  | 'lowerRoman' // i. ii. iii.
+  | 'upperRoman'; // I. II. III.
 
 /** Specific bullet format patterns */
 export type BulletFormat =
-  | "bullet" // • ● ○
-  | "dash" // - – —
-  | "arrow"; // ► ▸
+  | 'bullet' // • ● ○
+  | 'dash' // - – —
+  | 'arrow'; // ► ▸
 
 /**
  * Result of detecting list type for a single paragraph
@@ -82,7 +82,7 @@ export interface ListAnalysis {
   };
 
   /** Recommended action */
-  recommendedAction: "normalize" | "none";
+  recommendedAction: 'normalize' | 'none';
 }
 
 /**
@@ -90,8 +90,8 @@ export interface ListAnalysis {
  */
 export interface IndentationLevel {
   level: number;
-  textIndent: number;      // in inches
-  symbolIndent: number;    // in inches
+  textIndent: number; // in inches
+  symbolIndent: number; // in inches
   bulletChar?: string;
   numberedFormat?: NumberFormat | string;
 }
@@ -107,7 +107,7 @@ export interface ListNormalizationOptions {
   bulletStyleNumId?: number;
 
   /** Processing scope */
-  scope?: "cell" | "table" | "document";
+  scope?: 'cell' | 'table' | 'document';
 
   /**
    * If true, convert ALL list items to majority type.
@@ -146,7 +146,7 @@ export interface ListNormalizationReport {
   /** Detailed per-paragraph results */
   details: {
     originalText: string;
-    action: "normalized" | "skipped" | "error";
+    action: 'normalized' | 'skipped' | 'error';
     reason?: string;
   }[];
 }

package/src/types/settings-types.ts

@@ -1,59 +1,59 @@
-/**
- * Shared type definitions for document settings (settings.xml)
- *
- * These types are used by both Document.ts (in-memory state) and
- * DocumentGenerator.ts (XML generation) to ensure consistency.
- */
-
-/**
- * Document protection settings per ECMA-376 CT_DocProtect
- */
-export interface DocumentProtection {
-  edit: 'readOnly' | 'comments' | 'trackedChanges' | 'forms';
-  enforcement: boolean;
-  cryptProviderType?: string;
-  cryptAlgorithmClass?: string;
-  cryptAlgorithmType?: string;
-  cryptAlgorithmSid?: number;
-  cryptSpinCount?: number;
-  hash?: string;
-  salt?: string;
-}
-
-/**
- * Revision view settings per ECMA-376 CT_TrackChangesView
- */
-export interface RevisionViewSettings {
-  showInsertionsAndDeletions: boolean;
-  showFormatting: boolean;
-  showInkAnnotations: boolean;
-}
-
-/**
- * Track changes and related settings passed to DocumentGenerator.generateSettings()
- */
-export interface TrackChangesSettings {
-  trackChangesEnabled?: boolean;
-  trackFormatting?: boolean;
-  revisionView?: RevisionViewSettings;
-  rsidRoot?: string;
-  rsids?: string[];
-  documentProtection?: DocumentProtection;
-}
-
-/**
- * Information about webSettings.xml per ECMA-376 CT_WebSettings
- */
-export interface WebSettingsInfo {
-  divCount: number;
-  optimizeForBrowser: boolean;
-  allowPNG: boolean;
-  relyOnVML: boolean;
-  doNotRelyOnCSS: boolean;
-  doNotSaveAsSingleFile: boolean;
-  doNotOrganizeInFolder: boolean;
-  doNotUseLongFileNames: boolean;
-  pixelsPerInch?: number;
-  targetScreenSz?: string;
-  encoding?: string;
-}
+/**
+ * Shared type definitions for document settings (settings.xml)
+ *
+ * These types are used by both Document.ts (in-memory state) and
+ * DocumentGenerator.ts (XML generation) to ensure consistency.
+ */
+
+/**
+ * Document protection settings per ECMA-376 CT_DocProtect
+ */
+export interface DocumentProtection {
+  edit: 'readOnly' | 'comments' | 'trackedChanges' | 'forms';
+  enforcement: boolean;
+  cryptProviderType?: string;
+  cryptAlgorithmClass?: string;
+  cryptAlgorithmType?: string;
+  cryptAlgorithmSid?: number;
+  cryptSpinCount?: number;
+  hash?: string;
+  salt?: string;
+}
+
+/**
+ * Revision view settings per ECMA-376 CT_TrackChangesView
+ */
+export interface RevisionViewSettings {
+  showInsertionsAndDeletions: boolean;
+  showFormatting: boolean;
+  showInkAnnotations: boolean;
+}
+
+/**
+ * Track changes and related settings passed to DocumentGenerator.generateSettings()
+ */
+export interface TrackChangesSettings {
+  trackChangesEnabled?: boolean;
+  trackFormatting?: boolean;
+  revisionView?: RevisionViewSettings;
+  rsidRoot?: string;
+  rsids?: string[];
+  documentProtection?: DocumentProtection;
+}
+
+/**
+ * Information about webSettings.xml per ECMA-376 CT_WebSettings
+ */
+export interface WebSettingsInfo {
+  divCount: number;
+  optimizeForBrowser: boolean;
+  allowPNG: boolean;
+  relyOnVML: boolean;
+  doNotRelyOnCSS: boolean;
+  doNotSaveAsSingleFile: boolean;
+  doNotOrganizeInFolder: boolean;
+  doNotUseLongFileNames: boolean;
+  pixelsPerInch?: number;
+  targetScreenSz?: string;
+  encoding?: string;
+}