@silurus/ooxml 0.76.2 → 0.77.1

package/dist/types/docx.d.ts

@@ -10,7 +10,7 @@ interface MathRenderer {
   mathMLToSvg(mathml: string): Promise<MathSvg>;
 }
 //#endregion
-//#region dist/.types-work/hyperlink-BnJnsq2_.d.ts
+//#region dist/.types-work/hyperlink-JmvHU-7y.d.ts
 type MathStyle = 'roman' | 'italic' | 'bold' | 'boldItalic';
 interface MathRun {
   kind: 'run';
@@ -383,9 +383,14 @@ interface LegendManualLayout {
   w: number;
   h: number;
 }
+interface ChartRect {
+  x: number;
+  y: number;
+  w: number;
+  h: number;
+}
 type OoxmlErrorCode = 'encrypted' | 'invalid-password' | 'unsupported-encryption' | 'legacy-binary-format' | 'not-ooxml';
 type OoxmlErrorStage = 'container' | 'decompression' | 'parsing' | 'serialization' | 'layout' | 'rendering' | 'worker';
-type OoxmlErrorSource = 'container' | 'zip-part' | 'parser' | 'serializer' | 'layout' | 'renderer' | 'worker';
 declare class OoxmlError extends Error {
   readonly code: OoxmlErrorCode;
   constructor(code: OoxmlErrorCode, message: string);
@@ -486,7 +491,15 @@ type HyperlinkTarget = {
 };
 declare function openExternalHyperlink(url: string, allowed?: readonly string[], win?: Pick<Window, 'open'> | undefined): boolean;
 //#endregion
-//#region dist/.types-work/find-highlight-DkZhNxUb.d.ts
+//#region dist/.types-work/find-highlight-DcNlrW8O.d.ts
+interface TextSelectionContextOptions {
+  readonly maxTextCharacters?: number;
+  readonly maxRunLocators?: number;
+}
+interface ViewerContextMenuEvent<TContext> {
+  readonly originalEvent: MouseEvent;
+  getContext(): Promise<TContext | null>;
+}
 interface AutoResizeOptions {
   pauseWhenHidden?: boolean;
 }
@@ -517,7 +530,7 @@ interface FindHighlightColors {
   active?: string;
 }
 //#endregion
-//#region dist/.types-work/docx-BOSu_OHa.d.ts
+//#region dist/.types-work/docx-BEg7kh7t.d.ts
 interface DocxDocumentModel {
   section: SectionProps;
   body: BodyElement[];
@@ -829,6 +842,12 @@ type PathCmd = {
   y2: number;
   x: number;
   y: number;
+} | {
+  cmd: 'quadBezTo';
+  x1: number;
+  y1: number;
+  x: number;
+  y: number;
 } | {
   cmd: 'arcTo';
   wr: number;
@@ -873,8 +892,17 @@ interface ShapeRun {
   fill: ShapeFill | null;
   stroke: string | null;
   strokeWidth?: number;
+  strokeFill?: ShapeStrokeFill | null;
   strokeDash?: string | null;
-  strokeCap?: CanvasLineCap | null;
+  strokeCustomDash?: Array<{
+    dash: number;
+    space: number;
+  }>;
+  strokeCap?: 'butt' | 'round' | 'square' | null;
+  strokeJoin?: 'round' | 'bevel' | 'miter' | null;
+  strokeMiterLimit?: number | null;
+  strokeAlignment?: 'ctr' | 'in' | null;
+  strokeCompound?: string | null;
   headEnd?: LineEnd | null;
   tailEnd?: LineEnd | null;
   rotation?: number;
@@ -955,6 +983,17 @@ type ShapeFill = {
   stops: GradientStop[];
   angle: number;
   gradType: string;
+  scaled?: boolean;
+  path?: string;
+  fillToRect?: FillRect;
+  tileRect?: FillRect;
+  flip?: string;
+  rotWithShape?: boolean;
+} | {
+  fillType: 'pattern';
+  fg: string;
+  bg: string;
+  preset: string;
 } | {
   fillType: 'image';
   imagePath: string;
@@ -971,6 +1010,23 @@ type ShapeFill = {
   alpha?: number;
   duotone?: Duotone;
 };
+type ShapeStrokeFill = {
+  fillType: 'gradient';
+  stops: GradientStop[];
+  angle: number;
+  gradType: string;
+  scaled?: boolean;
+  path?: string;
+  fillToRect?: FillRect;
+  tileRect?: FillRect;
+  flip?: string;
+  rotWithShape?: boolean;
+} | {
+  fillType: 'pattern';
+  fg: string;
+  bg: string;
+  preset: string;
+};
 interface GradientStop {
   position: number;
   color: string;
@@ -1169,24 +1225,12 @@ interface CellBorders {
   insideH: BorderSpec | null;
   insideV: BorderSpec | null;
 }
-interface RenderPageOptions {
-  width?: number;
-  dpr?: number;
-  defaultTextColor?: string;
-  onTextRun?: (run: {
-    text: string;
-    x: number;
-    y: number;
-    w: number;
-    h: number;
-    fontSize: number;
-    font: string;
-    transform?: string;
-  }) => void;
-  showTrackChanges?: boolean;
-  currentDate?: Date | number;
-}
 interface DocxTextRunInfo {
+  source?: Readonly<{
+    story: 'body' | 'header' | 'footer' | 'footnote' | 'endnote' | 'textbox';
+    storyInstance: string;
+    path: readonly number[];
+  }>;
   paragraphId?: string;
   text: string;
   x: number;
@@ -1200,12 +1244,74 @@ interface DocxTextRunInfo {
   hyperlink?: HyperlinkTarget;
   eastAsianVert?: boolean;
 }
-type WireRenderPageOptions = Omit<RenderPageOptions, 'onTextRun'>;
+interface RenderPageOptions {
+  width?: number;
+  dpr?: number;
+  defaultTextColor?: string;
+  onTextRun?: (run: DocxTextRunInfo) => void;
+  currentDate?: Date | number;
+}
+type DocxSelectionContextOptions = TextSelectionContextOptions;
+interface DocxSelectionSourceLocator {
+  readonly story: 'body' | 'header' | 'footer' | 'footnote' | 'endnote' | 'textbox';
+  readonly storyInstance: string;
+  readonly path: readonly number[];
+}
+interface DocxSelectionRunLocator {
+  readonly pageIndex: number;
+  readonly runIndex: number;
+  readonly paragraphId?: string;
+  readonly source?: DocxSelectionSourceLocator;
+}
+interface DocxTextSelectionContext {
+  readonly format: 'docx';
+  readonly kind: 'text';
+  readonly text: string;
+  readonly pageIndexes: readonly number[];
+  readonly paragraphIds: readonly string[];
+  readonly runs: readonly DocxSelectionRunLocator[];
+  readonly truncated: boolean;
+  readonly truncationReasons: readonly ('text' | 'runs')[];
+  readonly textCharacters: number;
+  readonly maxTextCharacters: number;
+  readonly maxRunLocators: number;
+}
+interface DocxPagePoint {
+  readonly xPt: number;
+  readonly yPt: number;
+}
+interface DocxElementContext {
+  readonly format: 'docx';
+  readonly kind: 'element';
+  readonly pageIndex: number;
+  readonly elementIndex: number;
+  readonly elementType: 'chart' | 'image' | 'shape';
+  readonly point: DocxPagePoint;
+  readonly bounds: Readonly<DocxPagePoint & {
+    widthPt: number;
+    heightPt: number;
+  }>;
+  readonly source: DocxSelectionSourceLocator;
+  readonly text?: string;
+  readonly mimeType?: string;
+  readonly seriesCount?: number;
+  readonly truncated: boolean;
+  readonly truncationReasons: readonly ('text')[];
+  readonly textCharacters: number;
+  readonly maxTextCharacters: number;
+}
+type DocxSelectionContext = DocxTextSelectionContext | DocxElementContext;
+declare function readDocxTextSelectionContext(root: HTMLElement, selection: Selection | null, options?: DocxSelectionContextOptions): DocxTextSelectionContext | null;
+interface DocxElementContextOptions {
+  readonly maxTextCharacters?: number;
+  readonly currentDate?: Date | number;
+}
 interface LoadOptions extends LoadOptions$1 {
   math?: MathRenderer;
   mode?: 'main' | 'worker';
 }
-type RenderPageToBitmapOptions = WireRenderPageOptions & {
+type CollectPageRunsOptions = Pick<RenderPageOptions, 'width' | 'currentDate'>;
+type RenderPageToBitmapOptions = Omit<RenderPageOptions, 'onTextRun'> & {
   onTextRun?: (run: DocxTextRunInfo) => void;
 };
 declare class DocxDocument {
@@ -1246,14 +1352,18 @@ declare class DocxDocument {
   };
   renderPage(target: HTMLCanvasElement | OffscreenCanvas, pageIndex: number, opts?: RenderPageOptions): Promise<void>;
   renderPageToBitmap(pageIndex: number, opts?: RenderPageToBitmapOptions): Promise<ImageBitmap>;
-  collectPageRuns(pageIndex: number, opts?: WireRenderPageOptions): Promise<DocxTextRunInfo[]>;
+  collectPageRuns(pageIndex: number, opts?: CollectPageRunsOptions): Promise<DocxTextRunInfo[]>;
+  getElementContextAt(pageIndex: number, point: DocxPagePoint, opts?: DocxElementContextOptions): Promise<DocxElementContext | null>;
 }
 interface DocxMatchLocation {
   page: number;
 }
-interface DocxViewerOptions extends RenderPageOptions, LoadOptions {
+interface DocxViewerOptions extends Omit<RenderPageOptions, 'onTextRun'>, LoadOptions {
   container?: HTMLElement;
   enableTextSelection?: boolean;
+  enableElementSelection?: boolean;
+  onSelectionContextChange?: (context: DocxSelectionContext | null) => void;
+  onContextMenu?: (event: ViewerContextMenuEvent<DocxSelectionContext>) => void;
   findHighlightColors?: FindHighlightColors;
   onPageChange?: (index: number, total: number) => void;
   zoomMin?: number;
@@ -1275,6 +1385,7 @@ declare class DocxViewer implements ZoomableViewer {
   private readonly _canvasMount;
   private _textLayer;
   private _highlightLayer;
+  private _elementLayer;
   private _find;
   private _measureCtx;
   private _opts;
@@ -1282,6 +1393,12 @@ declare class DocxViewer implements ZoomableViewer {
   private readonly _renderDispatcher;
   private readonly _errorRouter;
   private _destroyed;
+  private _selectionChangeListener;
+  private _selectionContextKey;
+  private _elementContext;
+  private _elementHitGeneration;
+  private _elementClickListener;
+  private _contextMenuListener;
   static fromDocument(canvas: HTMLCanvasElement, document: DocxDocument, opts?: Omit<DocxViewerOptions, keyof LoadOptions>): Omit<DocxViewer, 'load'>;
   constructor(canvas: HTMLCanvasElement, opts?: DocxViewerOptions);
   load(source: string | ArrayBuffer): Promise<void>;
@@ -1310,6 +1427,14 @@ declare class DocxViewer implements ZoomableViewer {
   private _activateMatch;
   private _redrawHighlights;
   getResourceMetrics(): Promise<OoxmlResourceMetrics>;
+  getSelectionContext(options?: DocxSelectionContextOptions): DocxSelectionContext | null;
+  private _emitSelectionContextChange;
+  private _setElementContext;
+  private _invalidateElementContext;
+  private _redrawElementOutline;
+  private _onElementClick;
+  private _onContextMenu;
+  private _resolveContextAt;
   destroy(): void;
   private _render;
   private _reportRenderError;
@@ -1330,6 +1455,9 @@ interface DocxScrollViewerOptions extends Omit<RenderPageOptions, 'onTextRun'>,
   paddingRight?: number;
   overscan?: number;
   enableTextSelection?: boolean;
+  enableElementSelection?: boolean;
+  onSelectionContextChange?: (context: DocxSelectionContext | null) => void;
+  onContextMenu?: (event: ViewerContextMenuEvent<DocxSelectionContext>) => void;
   findHighlightColors?: FindHighlightColors;
   zoomMin?: number;
   zoomMax?: number;
@@ -1362,6 +1490,12 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private _lastRange;
   private _lastTopIndex;
   private _scrollListener;
+  private _selectionChangeListener;
+  private _selectionContextKey;
+  private _elementClickListener;
+  private _contextMenuListener;
+  private _elementContext;
+  private _elementHitGeneration;
   private _destroyed;
   private _measureCtx;
   private readonly _bitmapInFlight;
@@ -1384,6 +1518,7 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private _fitWidthPx;
   private _baseScale;
   relayout(): void;
+  private _relayout;
   private _recomputeHeights;
   private _gap;
   private _overscan;
@@ -1433,9 +1568,18 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private _onResize;
   get topVisiblePage(): number;
   getResourceMetrics(): Promise<OoxmlResourceMetrics>;
+  getSelectionContext(options?: DocxSelectionContextOptions): DocxSelectionContext | null;
+  private _emitSelectionContextChange;
+  private _setElementContext;
+  private _invalidateElementContext;
+  private _redrawElementOutlines;
+  private _redrawElementOutlineForSlot;
+  private _onElementClick;
+  private _onContextMenu;
+  private _resolveContextAt;
   destroy(): void;
 }
-declare function buildDocxTextLayer(layer: HTMLDivElement, runs: DocxTextRunInfo[], cssWidth: number, cssHeight: number, onHyperlinkClick?: (target: HyperlinkTarget) => void, measureForFont?: (font: string) => (s: string) => number): void;
+declare function buildDocxTextLayer(layer: HTMLDivElement, runs: DocxTextRunInfo[], cssWidth: number, cssHeight: number, onHyperlinkClick?: (target: HyperlinkTarget) => void, measureForFont?: (font: string) => (s: string) => number, pageIndex?: number): void;
 interface DocxHighlightMatch {
   slices: MatchRunSlice[];
   active: boolean;
@@ -1443,4 +1587,4 @@ interface DocxHighlightMatch {
 type DocxHighlightColors = FindHighlightColors;
 declare function buildDocxHighlightLayer(layer: HTMLDivElement, runs: DocxTextRunInfo[], matches: DocxHighlightMatch[], cssWidth: number, cssHeight: number, measureForFont: (font: string) => (s: string) => number, colors?: DocxHighlightColors): void;
 //#endregion
-export { type AnchorHostMetrics, type AutoResizeOptions, type BodyElement, type BorderSpec, type CellBorders, type CellElement, type ChartRun, type ColSpec, type ColumnsSpec, type DocComment, type DocNote, type DocParagraph, type DocRevision, type DocRun, type DocSettings, type DocTable, type DocTableCell, type DocTableRow, DocxDocument, type DocxDocumentModel, type DocxHighlightColors, type DocxHighlightMatch, type DocxMatchLocation, type DocxRunBorder, DocxScrollViewer, type DocxScrollViewerOptions, type DocxTextRun, type DocxTextRunInfo, DocxViewer, type DocxViewerOptions, type EmbeddedFontRef, type FieldRun, type FindHighlightColors, type FindMatch, type FindMatchesOptions, type FramePr, type GradientStop, type HeaderFooter, type HeadersFooters, type HyperlinkTarget, type ImageRun, type LineEnd, type LineNumbering, type LineSpacing, type LoadOptions, type NoteRef, type NumberingInfo, OoxmlDecodedImageLimitError, type OoxmlDecodedImageLimitMetric, OoxmlError, type OoxmlErrorCode, type OoxmlErrorSource, type OoxmlErrorStage, type OoxmlFormat, type OoxmlResourceLimit, OoxmlResourceLimitError, type OoxmlResourceLimitErrorDetails, type OoxmlResourceLimits, type OoxmlResourceMetric, type OoxmlResourceMetrics, type OoxmlResourceMetricsCheckpoint, type OoxmlResourceName, type OoxmlResourcePolicySnapshot, type OoxmlResourceUsageSnapshot, type OoxmlResourceViolation, type PTabRun, type PageBorderEdge, type PageBorders, type PageNumType, type ParaBorderEdge, type ParagraphBorders, type PathCmd, type RenderPageOptions, type RenderPageToBitmapOptions, type RubyAnnotation, type RunRevision, type SectionGeom, type SectionProps, type ShapeRun, type ShapeText, type ShapeTextRun, type TabStop, type TableBorders, type TblpPr, type TextPath, type WireRenderPageOptions, autoResize, buildDocxHighlightLayer, buildDocxTextLayer, isOoxmlDecodedImageLimitError, noteText, openExternalHyperlink };
+export { type AnchorHostMetrics, type AutoResizeOptions, type BodyElement, type BorderSpec, type CellBorders, type CellElement, type ChartDataLabelOverride, type ChartDataPointOverride, type ChartErrBars, type ChartLabelBox, type ChartManualLayout, type ChartModel, type ChartRect, type ChartRun, type ChartSeries, type ChartSeriesDataLabels, type ChartTrendline, type ChartType, type ChartexBoxSeries, type ChartexBoxWhisker, type ChartexSunburst, type ChartexSunburstRow, type ColSpec, type CollectPageRunsOptions, type ColumnsSpec, type DocComment, type DocNote, type DocParagraph, type DocRevision, type DocRun, type DocSettings, type DocTable, type DocTableCell, type DocTableRow, DocxDocument, type DocxDocumentModel, type DocxElementContext, type DocxElementContextOptions, type DocxHighlightColors, type DocxHighlightMatch, type DocxMatchLocation, type DocxPagePoint, type DocxRunBorder, DocxScrollViewer, type DocxScrollViewerOptions, type DocxSelectionContext, type DocxSelectionContextOptions, type DocxSelectionRunLocator, type DocxSelectionSourceLocator, type DocxTextRun, type DocxTextRunInfo, type DocxTextSelectionContext, DocxViewer, type DocxViewerOptions, type Duotone, type EmbeddedFontRef, type FieldRun, type FillRect, type FindHighlightColors, type FindMatch, type FindMatchesOptions, type FramePr, type GradientStop, type HeaderFooter, type HeadersFooters, type HyperlinkTarget, type ImageRun, type LegendManualLayout, type LineEnd, type LineNumbering, type LineSpacing, type LoadOptions, type MatchRunSlice, type MathAccent, type MathArray, type MathBar, type MathBorderBox, type MathBox, type MathDelimiter, type MathFraction, type MathFunc, type MathGroup, type MathGroupChr, type MathLimit, type MathNary, type MathNode, type MathPhant, type MathRadical, type MathRenderer, type MathRun, type MathSPre, type MathScript, type MathStyle, type MathSvg, type NoteRef, type NumberingInfo, OoxmlDecodedImageLimitError, type OoxmlDecodedImageLimitMetric, OoxmlError, type OoxmlErrorCode, type OoxmlErrorStage, type OoxmlFormat, type OoxmlResourceLimit, OoxmlResourceLimitError, type OoxmlResourceLimitErrorDetails, type OoxmlResourceLimits, type OoxmlResourceMetric, type OoxmlResourceMetrics, type OoxmlResourceMetricsCheckpoint, type OoxmlResourceName, type OoxmlResourcePolicySnapshot, type OoxmlResourceUsageSnapshot, type OoxmlResourceViolation, type PTabRun, type PageBorderEdge, type PageBorders, type PageNumType, type ParaBorderEdge, type ParagraphBorders, type PathCmd, type RenderPageOptions, type RenderPageToBitmapOptions, type RubyAnnotation, type RunRevision, type SecondaryValueAxis, type SectionGeom, type SectionProps, type ShapeFill, type ShapeRun, type ShapeStrokeFill, type ShapeText, type ShapeTextRun, type TabStop, type TableBorders, type TblpPr, type TextPath, type TextSelectionContextOptions, type TileInfo, type ViewerContextMenuEvent, type ZoomableViewer, autoResize, buildDocxHighlightLayer, buildDocxTextLayer, isOoxmlDecodedImageLimitError, noteText, openExternalHyperlink, readDocxTextSelectionContext };