@docxkit/plugin-page-number 0.3.0 → 0.4.0

package/README.md

@@ -7,6 +7,6 @@ Page number plugin for docx-kit.
 ```ts
 import { pageNumberPlugin } from '@docxkit/plugin-page-number'
 
-builder.use(pageNumberPlugin)
+builder.use(pageNumberPlugin())
 builder.pageNumber({ alignment: 'center' })
 ```

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { AlignmentType } from "docx";
-
 //#region ../../packages/types/dist/utility.d.ts
 /** Hexadecimal CSS color string, e.g. `"#ff0000"`. */
 type HexColor = `#${string}`;
@@ -146,12 +145,18 @@ interface ParagraphStyleRule {
   marginRight?: UnitValue;
   /** Top margin. */
   marginTop?: UnitValue;
+  /** Outline level used by Word navigation and table-of-contents fields (0–9). */
+  outlineLevel?: number;
   /** Force page break before this paragraph. */
   pageBreakBefore?: boolean;
+  /** Custom tab stops for this paragraph. */
+  tabStops?: TabStopRule[];
   /** Horizontal text alignment. */
   textAlign?: TextAlign;
   /** First-line indent. */
   textIndent?: UnitValue;
+  /** Prevent isolated first or last lines across page boundaries. */
+  widowControl?: boolean;
   /**
    * CSS-like margin shorthand.
    *
@@ -193,6 +198,15 @@ interface StyleSheetEntry extends DocxStyleRule {
   /** Inherit style properties from one or more other style classes. */
   extends?: string | string[];
 }
+/** A paragraph tab stop. */
+interface TabStopRule {
+  /** Position from the paragraph's left edge. */
+  position: UnitValue;
+  /** Optional leader characters before the tab stop. */
+  leader?: 'dot' | 'hyphen' | 'middleDot' | 'none' | 'underscore';
+  /** Tab alignment. */
+  type: 'bar' | 'center' | 'clear' | 'decimal' | 'end' | 'left' | 'num' | 'right' | 'start';
+}
 /** Horizontal text alignment. */
 type TextAlign = 'center' | 'justify' | 'left' | 'right';
 /**
@@ -216,7 +230,7 @@ interface TextStyleRule {
    * Takes precedence over `fontWeight` when both are set.
    */
   bold?: boolean;
-  /** Character spacing (letter-spacing). */
+  /** Raw OOXML character spacing in twips. Prefer `letterSpacing` for CSS units. */
   characterSpacing?: number;
   /** Text / foreground color (hex, named, or theme token like `"$colors.primary"`). */
   color?: HexColor | StyleToken<string>;
@@ -225,6 +239,10 @@ interface TextStyleRule {
    * Use for properties not yet covered by the CSS-like mapping.
    */
   docx?: Record<string, unknown>;
+  /** Double strikethrough toggle. */
+  doubleStrike?: boolean;
+  /** Embossed text effect. */
+  emboss?: boolean;
   /**
    * Font family name (e.g. `"Arial"`, or theme token like `"$fonts.heading"`).
    */
@@ -237,13 +255,17 @@ interface TextStyleRule {
   fontWeight?: FontWeight;
   /** Text highlight color (background marker). */
   highlight?: HighlightColor;
+  /** Imprinted (engraved) text effect. */
+  imprint?: boolean;
   /**
    * Convenience boolean: `true` maps to `fontStyle: 'italic'`.
    * Takes precedence over `fontStyle` when both are set.
    */
   italic?: boolean;
-  /** Character spacing. */
+  /** CSS-like character spacing with unit conversion. */
   letterSpacing?: UnitValue;
+  /** Right-to-left run direction. */
+  rightToLeft?: boolean;
   /** Small caps text variant. */
   smallCaps?: boolean;
   /** Strikethrough toggle. */
@@ -281,17 +303,29 @@ interface BaseNode<TStyles extends StyleSheet = StyleSheet> {
  *
  * @template TStyles — The user's stylesheet type
  */
-type BlockNode<TStyles extends StyleSheet = StyleSheet> = BulletListNode<TStyles> | HeadingNode<TStyles> | HyperlinkNode<TStyles> | ImageNode<TStyles> | NumberedListNode<TStyles> | PageBreakNode | ParagraphNode<TStyles> | PluginNode<string, unknown, TStyles> | SectionBreakNode | TableNode<Record<string, unknown>, TStyles>;
+type BlockNode<TStyles extends StyleSheet = StyleSheet> = BookmarkNode<TStyles> | BulletListNode<TStyles> | CheckboxNode<TStyles> | ColumnBreakNode | CommentNode<TStyles> | FootnoteNode<TStyles> | HeadingNode<TStyles> | HyperlinkNode<TStyles> | ImageNode<TStyles> | MathNode | NumberedListNode<TStyles> | PageBreakNode | ParagraphNode<TStyles> | PluginNode<string, unknown, TStyles> | RevisionNode<TStyles> | SectionBreakNode | TableNode<Record<string, unknown>, TStyles> | TextBoxNode<TStyles> | ThematicBreakNode<TStyles>;
+/**
+ * A named bookmark that can be targeted by an internal hyperlink.
+ */
+interface BookmarkNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
+  /** Text or styled text runs contained by the bookmark. */
+  children: (string | TextNode<TStyles>)[];
+  /** Stable bookmark name. */
+  name: string;
+  type: 'bookmark';
+}
 /**
  * A structured list item (for rich bullet/numbered items).
  *
  * @template TStyles — The user's stylesheet type
  */
 interface BulletItem<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
-  /** Item text content. */
-  text: string;
   /** Optional inline children override (instead of text). */
   children?: InlineNode<TStyles>[];
+  /** Per-item nested list level (0–8). Overrides the list-level default. */
+  level?: number;
+  /** Item text content, used when `children` is absent. */
+  text?: string;
 }
 /**
  * A bullet list node.
@@ -309,12 +343,65 @@ interface BulletListNode<TStyles extends StyleSheet = StyleSheet> extends BaseNo
   /** Nested list level (0 = top-level). */
   level?: number;
 }
+/**
+ * A Word checkbox content control.
+ */
+interface CheckboxNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
+  type: 'checkbox';
+  /** Accessible alias for the checkbox control. */
+  alias?: string;
+  /** Whether the checkbox is checked. */
+  checked?: boolean;
+  /** Checked-state glyph and font. */
+  checkedState?: CheckboxSymbol;
+  /** Optional label rendered after the checkbox. */
+  label?: string;
+  /** Unchecked-state glyph and font. */
+  uncheckedState?: CheckboxSymbol;
+}
+/** Checkbox glyph customization. */
+interface CheckboxSymbol {
+  /** Font containing the glyph. */
+  font?: string;
+  /** Unicode code point expressed as a hexadecimal string. */
+  value?: string;
+}
 /**
  * Extract valid class name keys from a stylesheet type.
  *
  * @template TStyles — The user's stylesheet type
  */
 type ClassName<TStyles extends StyleSheet> = Extract<keyof TStyles, string>;
+/**
+ * A forced column break.
+ */
+interface ColumnBreakNode {
+  type: 'columnBreak';
+}
+/**
+ * An annotated content range backed by a Word comment.
+ */
+interface CommentNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
+  /** Comment author. */
+  author: string;
+  /** Annotated inline content. */
+  children: InlineNode<TStyles>[];
+  /** Comment body paragraphs or plain text. */
+  comment: (string | ParagraphNode<TStyles>)[];
+  type: 'comment';
+  /** ISO-8601 creation timestamp. */
+  date?: string;
+  /** Author initials. */
+  initials?: string;
+}
+/**
+ * A footnote reference and its document-level footnote content.
+ */
+interface FootnoteNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
+  /** Footnote body paragraphs or plain text. */
+  content: (string | ParagraphNode<TStyles>)[];
+  type: 'footnote';
+}
 /**
  * A heading node (h1–h6).
  *
@@ -336,8 +423,10 @@ interface HyperlinkNode<TStyles extends StyleSheet = StyleSheet> extends BaseNod
   /** Display text or inline children. */
   children: (string | TextNode<TStyles>)[];
   type: 'hyperlink';
-  /** Link target URL. */
-  url: string;
+  /** Internal bookmark target (used instead of `url`). */
+  anchor?: string;
+  /** External link target URL. */
+  url?: string;
 }
 /**
  * An image node.
@@ -365,8 +454,11 @@ interface ImageNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TS
    * - Object allows wrap mode and position offsets
    */
   floating?: boolean | {
-    /** Text wrap mode. */wrap?: 'square' | 'tight' | 'topAndBottom'; /** Horizontal offset. */
-    x?: UnitValue; /** Vertical offset. */
+    /** Text wrap mode. */
+    wrap?: 'square' | 'tight' | 'topAndBottom';
+    /** Horizontal offset. */
+    x?: UnitValue;
+    /** Vertical offset. */
     y?: UnitValue;
   };
 }
@@ -375,7 +467,63 @@ interface ImageNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TS
  *
  * @template TStyles — The user's stylesheet type
  */
-type InlineNode<TStyles extends StyleSheet = StyleSheet> = HyperlinkNode<TStyles> | ImageNode<TStyles> | TextNode<TStyles>;
+type InlineNode<TStyles extends StyleSheet = StyleSheet> = BookmarkNode<TStyles> | CheckboxNode<TStyles> | CommentNode<TStyles> | FootnoteNode<TStyles> | HyperlinkNode<TStyles> | ImageNode<TStyles> | MathNode | RevisionNode<TStyles> | TextNode<TStyles>;
+/**
+ * A recursive expression used by {@link MathNode}.
+ */
+type MathExpression = MathFractionExpression | MathFunctionExpression | MathIntegralExpression | MathRadicalExpression | MathScriptExpression | MathSumExpression | MathTextExpression;
+/** A mathematical fraction. */
+interface MathFractionExpression {
+  denominator: MathExpression[];
+  numerator: MathExpression[];
+  type: 'fraction';
+}
+/** A named mathematical function. */
+interface MathFunctionExpression {
+  arguments: MathExpression[];
+  name: MathExpression[];
+  type: 'function';
+}
+/** A mathematical integral. */
+interface MathIntegralExpression {
+  children: MathExpression[];
+  type: 'integral';
+  subScript?: MathExpression[];
+  superScript?: MathExpression[];
+}
+/**
+ * An Office Math (OMML) expression.
+ */
+interface MathNode {
+  /** Structured mathematical expression tree. */
+  children: MathExpression[];
+  type: 'math';
+}
+/** A mathematical radical with an optional degree. */
+interface MathRadicalExpression {
+  children: MathExpression[];
+  type: 'radical';
+  degree?: MathExpression[];
+}
+/** Subscript, superscript, or combined script. */
+interface MathScriptExpression {
+  children: MathExpression[];
+  type: 'script';
+  subScript?: MathExpression[];
+  superScript?: MathExpression[];
+}
+/** A mathematical sum. */
+interface MathSumExpression {
+  children: MathExpression[];
+  type: 'sum';
+  subScript?: MathExpression[];
+  superScript?: MathExpression[];
+}
+/** Plain text inside a mathematical expression. */
+interface MathTextExpression {
+  text: string;
+  type: 'text';
+}
 /**
  * A numbered / ordered list node.
  *
@@ -431,6 +579,21 @@ interface PluginNode<TName extends string = string, TOptions = unknown, TStyles
   options: TOptions;
   type: 'plugin';
 }
+/**
+ * An inserted or deleted text revision.
+ */
+interface RevisionNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
+  /** Revision author. */
+  author: string;
+  /** Text or styled text runs in the revision. */
+  children: (string | TextNode<TStyles>)[];
+  /** ISO-8601 revision timestamp. */
+  date: string;
+  /** Document-unique revision identifier. */
+  revisionId: number;
+  /** Revision kind. */
+  type: 'deletedText' | 'insertedText';
+}
 /**
  * Internal marker node that represents a section boundary.
  *
@@ -445,6 +608,17 @@ interface SectionBreakNode {
   /** Optional per-section page/header/footer overrides. */
   config?: SectionConfig;
 }
+/** Table-level border configuration. */
+interface TableBordersConfig {
+  bottom?: BorderRule;
+  insideHorizontal?: BorderRule;
+  insideVertical?: BorderRule;
+  left?: BorderRule;
+  right?: BorderRule;
+  top?: BorderRule;
+}
+/** Per-cell style resolver. */
+type TableCellStyleResolver<TData extends Record<string, unknown> = Record<string, unknown>> = (value: TData[keyof TData], row: TData, rowIndex: number, column: TableColumn<TData>) => DocxStyleRule;
 /**
  * A column definition for a table.
  *
@@ -457,17 +631,22 @@ interface TableColumn<TData extends Record<string, unknown> = Record<string, unk
   title: string;
   /** Cell text alignment. */
   align?: 'center' | 'left' | 'right';
+  /** Per-column data cell style or resolver. */
+  cellStyle?: DocxStyleRule | TableCellStyleResolver<TData>;
   /**
    * Span multiple columns horizontally.
    *
    * Applied to all cells in this column.
    */
   colSpan?: number;
+  /** Per-column header cell style. */
+  headerCellStyle?: DocxStyleRule;
   /**
    * Span multiple rows vertically (per-cell via data hints).
    *
-   * Set `rowSpan` on individual data objects using `_rowSpan: N` or keep it
-   * as a static column default.
+   * Set a keyed `_${key}_rowSpan: N` hint on an individual data object,
+   * use `_rowSpan: N` for every cell in that row, or keep this as a static
+   * column default.
    */
   rowSpan?: number;
   /** Column width. Supports percentage strings (e.g. `"30%"`). */
@@ -480,6 +659,40 @@ interface TableColumn<TData extends Record<string, unknown> = Record<string, unk
    */
   render?: (value: TData[keyof TData], row: TData, index: number) => string | InlineNode[];
 }
+/** Floating table positioning. */
+interface TableFloatingOptions {
+  /** Bottom distance from surrounding text. */
+  bottomFromText?: UnitValue;
+  /** Horizontal anchor. */
+  horizontalAnchor?: 'margin' | 'page' | 'text';
+  /** Left distance from surrounding text. */
+  leftFromText?: UnitValue;
+  /** Whether the table may overlap other floating objects. */
+  overlap?: boolean;
+  /** Right distance from surrounding text. */
+  rightFromText?: UnitValue;
+  /** Top distance from surrounding text. */
+  topFromText?: UnitValue;
+  /** Vertical anchor. */
+  verticalAnchor?: 'margin' | 'page' | 'text';
+  /** Absolute horizontal offset. */
+  x?: UnitValue;
+  /** Absolute vertical offset. */
+  y?: UnitValue;
+  /** Relative horizontal placement. */
+  relativeHorizontalPosition?: 'center' | 'inside' | 'left' | 'outside' | 'right';
+  /** Relative vertical placement. */
+  relativeVerticalPosition?: 'bottom' | 'center' | 'inline' | 'inside' | 'outside' | 'top';
+}
+/** Native Word table-look flags. */
+interface TableLookOptions {
+  firstColumn?: boolean;
+  firstRow?: boolean;
+  lastColumn?: boolean;
+  lastRow?: boolean;
+  noHBand?: boolean;
+  noVBand?: boolean;
+}
 /**
  * A table node with column definitions and data rows.
  *
@@ -492,16 +705,59 @@ interface TableNode<TData extends Record<string, unknown> = Record<string, unkno
   /** Row data objects. */
   data: TData[];
   type: 'table';
+  /** Horizontal table alignment. */
+  alignment?: 'center' | 'left' | 'right';
   /** Show table borders. */
   bordered?: boolean;
-  /** Default cell style for data rows. */
-  cellStyle?: DocxStyleRule;
+  /** Explicit outer and inner table borders. */
+  borders?: TableBordersConfig;
+  /** Default data cell style or per-cell resolver. */
+  cellStyle?: DocxStyleRule | TableCellStyleResolver<TData>;
+  /** Floating table positioning. Enables side-by-side layouts. */
+  floating?: TableFloatingOptions;
   /** Show header row (default: `true`). */
   header?: boolean;
   /** Style for header cells. */
   headerCellStyle?: DocxStyleRule;
+  /** Word table layout algorithm. */
+  layout?: 'autofit' | 'fixed';
   /** Alternate row shading. */
   striped?: boolean;
+  /** Native Word table style ID. */
+  styleName?: string;
+  /** Native Word table-look flags. */
+  tableLook?: TableLookOptions;
+  /** Render the table grid from right to left. */
+  visuallyRightToLeft?: boolean;
+  /** Overall table width. */
+  width?: UnitValue;
+}
+/**
+ * A legacy Word text box positioned as a block-level shape.
+ */
+interface TextBoxNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
+  /** Text box dimensions and positioning. */
+  box: TextBoxOptions;
+  type: 'textBox';
+  /** Inline children (used instead of `text`). */
+  children?: InlineNode<TStyles>[];
+  /** Plain text content. */
+  text?: string;
+}
+/** Text box dimensions and positioning. */
+interface TextBoxOptions {
+  /** Text box width. */
+  width: UnitValue;
+  /** Text box height. */
+  height?: UnitValue;
+  /** Horizontal offset. */
+  left?: UnitValue;
+  /** Shape positioning mode. */
+  position?: 'absolute' | 'relative' | 'static';
+  /** Vertical offset. */
+  top?: UnitValue;
+  /** Text wrapping behavior. */
+  wrap?: 'none' | 'square';
 }
 /**
  * A text run node (inline content).
@@ -513,8 +769,31 @@ interface TextNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TSt
   text: string;
   type: 'text';
 }
+/**
+ * A horizontal thematic break rendered as a paragraph border.
+ */
+interface ThematicBreakNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TStyles> {
+  type: 'thematicBreak';
+}
 //#endregion
 //#region ../../packages/types/dist/document.d.ts
+/** OOXML document properties shown in Word's File → Info panel. */
+interface DocumentMetadata {
+  /** Document author. */
+  creator?: string;
+  /** Application-specific string properties. */
+  customProperties?: Record<string, string>;
+  /** Document description / summary. */
+  description?: string;
+  /** Keywords / tags. */
+  keywords?: string[];
+  /** Last editor. */
+  lastModifiedBy?: string;
+  /** Document subject. */
+  subject?: string;
+  /** Document title. */
+  title?: string;
+}
 /**
  * Top-level configuration passed to `createDocx()`.
  *
@@ -524,6 +803,10 @@ interface TextNode<TStyles extends StyleSheet = StyleSheet> extends BaseNode<TSt
  * @template TStyles — The user's stylesheet type (inferred from `styles`).
  */
 interface DocxKitConfig<TStyles extends StyleSheet = StyleSheet> {
+  /** Font files embedded into the generated DOCX package. */
+  fonts?: EmbeddedFont[];
+  /** OOXML core properties (appear in File → Info). */
+  metadata?: DocumentMetadata;
   /** Page dimensions and margins. */
   page?: PageConfig;
   /** Named style classes (class → style rule map). */
@@ -532,20 +815,23 @@ interface DocxKitConfig<TStyles extends StyleSheet = StyleSheet> {
   theme?: DocxTheme;
   /** Default styles applied as base for each element type. */
   defaults?: {
-    /** Default table cell style. */cell?: DocxStyleRule; /** Default image style (applied to the paragraph wrapping the image). */
-    image?: DocxStyleRule; /** Default paragraph style. */
-    paragraph?: DocxStyleRule; /** Default table style. */
-    table?: DocxStyleRule; /** Default text run style. */
+    /** Default table cell style. */
+    cell?: DocxStyleRule;
+    /** Default image style (applied to the paragraph wrapping the image). */
+    image?: DocxStyleRule;
+    /** Default paragraph style. */
+    paragraph?: DocxStyleRule;
+    /** Default table style. */
+    table?: DocxStyleRule;
+    /** Default text run style. */
     text?: DocxStyleRule;
   };
-  /** OOXML core properties (appear in File → Info). */
-  metadata?: {
-    /** Document author. */creator?: string; /** Document description / summary. */
-    description?: string; /** Keywords / tags. */
-    keywords?: string[]; /** Last editor. */
-    lastModifiedBy?: string; /** Document subject. */
-    subject?: string; /** Document title. */
-    title?: string;
+  /** Document-level Word feature switches. */
+  features?: {
+    /** Enable tracked revision display and behavior. */
+    trackRevisions?: boolean;
+    /** Ask Word to update fields when the document opens. */
+    updateFields?: boolean;
   };
 }
 /**
@@ -565,6 +851,13 @@ interface DocxTheme {
   /** Spacing tokens (name → value). */
   spacing?: ThemeSpacing;
 }
+/** A TrueType/OpenType font embedded into the DOCX package. */
+interface EmbeddedFont {
+  /** Raw font-file bytes. */
+  data: Uint8Array;
+  /** Font family name written to the OOXML font table. */
+  name: string;
+}
 /**
  * Header/footer configuration for a section.
  *
@@ -590,12 +883,39 @@ interface HeaderFooterContent {
 }
 /** Page orientation. */
 type Orientation = 'landscape' | 'portrait';
+/** Page border configuration. */
+interface PageBorderConfig {
+  /** Bottom page border. */
+  bottom?: BorderRule;
+  /** Pages that display the border. */
+  display?: 'allPages' | 'firstPage' | 'notFirstPage';
+  /** Left page border. */
+  left?: BorderRule;
+  /** Measure border offsets from the page edge or text area. */
+  offsetFrom?: 'page' | 'text';
+  /** Right page border. */
+  right?: BorderRule;
+  /** Top page border. */
+  top?: BorderRule;
+  /** Render the border behind or in front of document content. */
+  zOrder?: 'back' | 'front';
+}
 /**
  * Page configuration (size, orientation, margin).
  */
 interface PageConfig {
+  /** Page border configuration. */
+  borders?: PageBorderConfig;
+  /** Distance between the footer and the page edge. */
+  footerDistance?: UnitValue;
+  /** Extra gutter width for binding. */
+  gutter?: UnitValue;
+  /** Distance between the header and the page edge. */
+  headerDistance?: UnitValue;
   /** Page orientation (`"portrait"` default). */
   orientation?: Orientation;
+  /** Page-number sequence configuration for this section. */
+  pageNumber?: PageNumberConfig;
   /** Page size: preset name or explicit dimensions. */
   size?: PageSize | {
     height: UnitValue;
@@ -609,8 +929,35 @@ interface PageConfig {
    */
   margin?: `${string} ${string}` | `${string} ${string} ${string} ${string}` | UnitValue;
 }
+/** Per-section page-number sequence configuration. */
+interface PageNumberConfig {
+  /** First page number in the section. */
+  start?: number;
+  /** Page number format. */
+  format?: 'decimal' | 'lowerLetter' | 'lowerRoman' | 'upperLetter' | 'upperRoman';
+}
 /** Available page size presets. */
 type PageSize = 'A3' | 'A4' | 'Legal' | 'Letter';
+/** An explicitly sized section column. */
+interface SectionColumn {
+  /** Column width. */
+  width: UnitValue;
+  /** Space after this column. */
+  spacing?: UnitValue;
+}
+/** Multi-column layout for a section. */
+interface SectionColumnsConfig {
+  /** Explicit column widths for unequal-width layouts. */
+  columns?: SectionColumn[];
+  /** Number of equal-width columns. */
+  count?: number;
+  /** Whether Word should keep columns equally sized. */
+  equalWidth?: boolean;
+  /** Draw a separator line between columns. */
+  separator?: boolean;
+  /** Default spacing between columns. */
+  spacing?: UnitValue;
+}
 /**
  * Per-section configuration.
  *
@@ -619,13 +966,32 @@ type PageSize = 'A3' | 'A4' | 'Legal' | 'Letter';
  * sections.
  */
 interface SectionConfig {
+  /** Multi-column layout. */
+  columns?: SectionColumnsConfig;
   /** Section footer(s). */
   footer?: HeaderFooterConfig;
   /** Section header(s). */
   header?: HeaderFooterConfig;
+  /** Line numbering. */
+  lineNumbers?: SectionLineNumberConfig;
   /** Section-specific page dimensions (overrides document-level `page`). */
   page?: PageConfig;
+  /** Section break behavior. */
+  type?: SectionType;
+}
+/** Line-numbering configuration for a section. */
+interface SectionLineNumberConfig {
+  /** Number every Nth line. */
+  countBy?: number;
+  /** Distance between line numbers and text. */
+  distance?: UnitValue;
+  /** When line numbering restarts. */
+  restart?: 'continuous' | 'newPage' | 'newSection';
+  /** Starting line number. */
+  start?: number;
 }
+/** Section break behavior. */
+type SectionType = 'continuous' | 'evenPage' | 'nextColumn' | 'nextPage' | 'oddPage';
 /**
  * Theme color palette — semantic color tokens referenced by name.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docxkit/plugin-page-number",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Page number field for headers/footers — docx-kit plugin",
   "keywords": [
     "docx",
@@ -35,10 +35,10 @@
   "sideEffects": false,
   "peerDependencies": {
     "docx": "^9.7.1",
-    "@docxkit/core": "0.3.0"
+    "@docxkit/core": "0.4.0"
   },
   "devDependencies": {
-    "@docxkit/pdk": "0.3.0"
+    "@docxkit/pdk": "0.4.0"
   },
   "scripts": {
     "build": "tsdown",