@silurus/ooxml 0.82.1 → 0.83.0

package/dist/types/docx.d.ts

@@ -1069,7 +1069,7 @@ interface ChartRegionMapRenderer {
   render(ctx: CanvasRenderingContext2D, chart: ChartModel, rect: ChartRect, ptToPx: number, shapeRotationDeg?: number): boolean;
 }
 //#endregion
-//#region dist/.types-work/hyperlink-CZoV-4B8.d.ts
+//#region dist/.types-work/hyperlink-Bk5fiM_m.d.ts
 type OoxmlErrorCode = 'encrypted' | 'invalid-password' | 'unsupported-encryption' | 'legacy-binary-format' | 'not-ooxml';
 type OoxmlErrorStage = 'container' | 'decompression' | 'parsing' | 'serialization' | 'layout' | 'rendering' | 'worker';
 declare class OoxmlError extends Error {
@@ -1142,6 +1142,14 @@ interface OoxmlResourceLimits {
   maxTotalInflatedBytes?: OoxmlResourceLimit;
   maxArchiveEntries?: OoxmlResourceLimit;
 }
+interface ProgressiveLayoutProgress {
+  committedUnits: number;
+}
+interface ProgressiveLayoutPartial {
+  availableUnits: number;
+  totalUnits?: number;
+  exact: boolean;
+}
 interface LoadOptions$1 {
   useGoogleFonts?: boolean;
   password?: string;
@@ -1236,7 +1244,7 @@ interface FindHighlightColors {
   active?: string;
 }
 //#endregion
-//#region dist/.types-work/types-HfeSaZtq.d.ts
+//#region dist/.types-work/types-B2UaFocY.d.ts
 interface DocxDocumentModel {
   section: SectionProps;
   body: BodyElement[];
@@ -1979,9 +1987,10 @@ interface RenderPageOptions {
   defaultTextColor?: string;
   onTextRun?: (run: DocxTextRunInfo) => void;
   currentDate?: Date | number;
+  showTrackedChanges?: boolean;
 }
 //#endregion
-//#region dist/.types-work/docx-CDchTe6F.d.ts
+//#region dist/.types-work/docx-CBra4_iJ.d.ts
 interface CommentAnchorRange {
   readonly commentId: string;
   readonly source: Readonly<DocxStorySource>;
@@ -2088,6 +2097,7 @@ declare function readDocxTextSelectionContext(root: HTMLElement, selection: Sele
 interface DocxElementContextOptions {
   readonly maxTextCharacters?: number;
   readonly currentDate?: Date | number;
+  readonly showTrackedChanges?: boolean;
 }
 interface RevisionAnchorRange {
   readonly revisionIndex: number;
@@ -2104,8 +2114,15 @@ declare function resolveRevisionAnchorRuns(anchor: Readonly<RevisionAnchorRange>
 interface LoadOptions extends LoadOptions$1 {
   math?: MathRenderer;
   mode?: 'main' | 'worker';
+  sliceLayout?: boolean;
+  onLayoutProgress?: (progress: Readonly<ProgressiveLayoutProgress>) => void;
+  progressiveLayout?: boolean;
+  onLayoutComplete?: (error?: unknown) => void;
+  onLayoutPartial?: (progress: Readonly<ProgressiveLayoutPartial>) => void;
+  showTrackedChanges?: boolean;
+  currentDate?: Date | number;
 }
-type CollectPageRunsOptions = Pick<RenderPageOptions, 'width' | 'currentDate'>;
+type CollectPageRunsOptions = Pick<RenderPageOptions, 'width' | 'currentDate' | 'showTrackedChanges'>;
 interface DocxPageCommentThreadsOptions extends CollectPageRunsOptions, ResolveDocxCommentThreadsOptions {}
 type RenderPageToBitmapOptions = Omit<RenderPageOptions, 'onTextRun'> & {
   onTextRun?: (run: DocxTextRunInfo) => void;
@@ -2116,10 +2133,19 @@ declare class DocxDocument {
   private _source;
   private _meta;
   private _review;
+  private readonly _layoutLifecycle;
+  private readonly _layoutObservers;
+  private _layoutCompletion;
+  private _layoutAbort;
   private _bookmarkPages;
   private _commentAnchorRanges;
   private _revisionAnchorRanges;
-  private _reviewTextRunSourceIndex;
+  private _reviewProjectionIndex;
+  private _parseRequestId;
+  private _progressive;
+  private _parseWatchdog;
+  private _parseWatchdogMs;
+  private _layoutViewGeneration;
   private _mode;
   private _threeD;
   private _regionMap;
@@ -2134,6 +2160,18 @@ declare class DocxDocument {
   private constructor();
   static load(source: string | ArrayBuffer, opts?: LoadOptions): Promise<DocxDocument>;
   private _parse;
+  private _onWorkerLayoutPush;
+  private _applyLayoutPartial;
+  private _onAuthoritativeMeta;
+  private _invalidateLayoutDerivedCaches;
+  private _replaceMainLayoutPublication;
+  private _isLayoutViewActive;
+  private _rearmParseWatchdog;
+  private _clearParseWatchdog;
+  private _onParseWentSilent;
+  private _failWorkerProgressive;
+  private _parseViewFields;
+  private _parseProgressively;
   destroy(): void;
   getImage(imagePath: string, mimeType: string): Promise<Blob>;
   getFontBytes(partPath: string): Promise<Uint8Array>;
@@ -2141,6 +2179,8 @@ declare class DocxDocument {
   getResourceMetrics(): Promise<OoxmlResourceMetrics>;
   toMarkdown(): Promise<string>;
   get pageCount(): number;
+  get layoutComplete(): boolean;
+  waitUntilLayoutComplete(): Promise<void>;
   get mode(): 'main' | 'worker';
   get document(): DocxDocumentModel;
   get comments(): readonly Readonly<DocComment>[];
@@ -2151,12 +2191,17 @@ declare class DocxDocument {
   get footnotes(): DocNote[];
   get endnotes(): DocNote[];
   private _getLayout;
+  setLayoutView(view?: Readonly<{
+    showTrackedChanges?: boolean;
+    currentDate?: Date | number;
+  }>): Promise<void>;
   private _getBookmarkPages;
   getBookmarkPage(bookmarkName: string): number | undefined;
   pageSize(pageIndex: number): {
     widthPt: number;
     heightPt: number;
   };
+  private _withActiveView;
   renderPage(target: HTMLCanvasElement | OffscreenCanvas, pageIndex: number, opts?: RenderPageOptions): Promise<void>;
   renderPageToBitmap(pageIndex: number, opts?: RenderPageToBitmapOptions): Promise<ImageBitmap>;
   collectPageRuns(pageIndex: number, opts?: CollectPageRunsOptions): Promise<DocxTextRunInfo[]>;
@@ -2173,7 +2218,7 @@ interface DocxViewerOptions extends Omit<RenderPageOptions, 'onTextRun'>, LoadOp
   onSelectionContextChange?: (context: DocxSelectionContext | null) => void;
   onContextMenu?: (event: ViewerContextMenuEvent<DocxSelectionContext>) => void;
   findHighlightColors?: FindHighlightColors;
-  onPageChange?: (index: number, total: number) => void;
+  onPageChange?: (index: number, total: number, layoutComplete: boolean) => void;
   zoomMin?: number;
   zoomMax?: number;
   onScaleChange?: (scale: number) => void;
@@ -2195,6 +2240,7 @@ declare class DocxViewer implements ZoomableViewer {
   private _highlightLayer;
   private _elementLayer;
   private _find;
+  private _findRequestGeneration;
   private _measureCtx;
   private _opts;
   private readonly _mode;
@@ -2205,6 +2251,13 @@ declare class DocxViewer implements ZoomableViewer {
   private _selectionContextKey;
   private _elementContext;
   private _elementHitGeneration;
+  private _layoutViewGeneration;
+  private _navigationGeneration;
+  private _layoutUnsubscribe;
+  private _internalHyperlinkGeneration;
+  private readonly _layoutWaiters;
+  private _layoutFailed;
+  private readonly _loadingLayer;
   private _elementClickListener;
   private _contextMenuListener;
   static fromDocument(canvas: HTMLCanvasElement, document: DocxDocument, opts?: Omit<DocxViewerOptions, keyof LoadOptions>): Omit<DocxViewer, 'load'>;
@@ -2212,6 +2265,8 @@ declare class DocxViewer implements ZoomableViewer {
   load(source: string | ArrayBuffer): Promise<void>;
   get pageCount(): number;
   get currentPage(): number;
+  get layoutComplete(): boolean;
+  waitUntilLayoutComplete(): Promise<void>;
   get canvasElement(): HTMLCanvasElement;
   goToPage(index: number): Promise<void>;
   nextPage(): Promise<void>;
@@ -2247,12 +2302,21 @@ declare class DocxViewer implements ZoomableViewer {
   private _render;
   private _reportRenderError;
   private _renderPage;
+  private _bindLayoutDocument;
+  private _unbindLayoutDocument;
+  private _onLayoutPublication;
+  private _waitForPage;
+  private _wakeLayoutWaiters;
+  private _cancelPendingNavigation;
+  private _setLoading;
+  setShowTrackedChanges(value: boolean): Promise<void>;
   private _buildHighlightLayer;
   private _canvasCssPx;
   private _measureForFont;
   private _collectPageRuns;
   private _buildTextLayer;
   private _hyperlinkHandler;
+  private _navigateInternalHyperlink;
 }
 interface DocxCommentsOptions extends ViewerCommentsOptions {
   readonly cards?: boolean;
@@ -2268,6 +2332,8 @@ interface DocxScrollViewerOptions extends Omit<RenderPageOptions, 'onTextRun'>,
   paddingLeft?: number;
   paddingRight?: number;
   overscan?: number;
+  progressiveLayout?: boolean;
+  sliceLayout?: boolean;
   enableTextSelection?: boolean;
   comments?: boolean | DocxCommentsOptions;
   enableElementSelection?: boolean;
@@ -2280,7 +2346,7 @@ interface DocxScrollViewerOptions extends Omit<RenderPageOptions, 'onTextRun'>,
   refitOnResize?: boolean;
   background?: string;
   pageShadow?: string | false;
-  onVisiblePageChange?: (topIndex: number, total: number) => void;
+  onVisiblePageChange?: (topIndex: number, total: number, layoutComplete: boolean) => void;
   onScaleChange?: (scale: number) => void;
   onHyperlinkClick?: (target: HyperlinkTarget) => void;
   enableHyperlinks?: boolean;
@@ -2291,6 +2357,7 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private get _doc();
   private readonly _borrowed;
   private readonly _opts;
+  private readonly _errorRouter;
   private readonly _container;
   private readonly _wrapper;
   private readonly _scrollHost;
@@ -2305,6 +2372,11 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private _scrollGeometry;
   private _lastRange;
   private _lastTopIndex;
+  private _lastReportedTotal;
+  private _lastReportedLayoutComplete;
+  private _layoutUnsubscribe;
+  private _presentedPageCount;
+  private _pendingLayoutPublication;
   private _scrollListener;
   private _selectionChangeListener;
   private _selectionContextKey;
@@ -2320,8 +2392,10 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private readonly _commentIndexedPages;
   private _commentScanFrontier;
   private _commentNavigationGeneration;
+  private _internalHyperlinkGeneration;
   private _commentAnchorRangesForMargin;
   private _commentAnchorIds;
+  private _reviewOriginPx;
   private _commentGeometryScheduled;
   private _commentGeometryFrame;
   private readonly _pendingCommentGeometry;
@@ -2339,10 +2413,22 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private readonly _pageShadow;
   private readonly _find;
   private _findActive;
+  private _findRequestGeneration;
+  private _showTrackedChanges;
+  private _layoutViewGeneration;
   static fromDocument(container: HTMLElement, document: DocxDocument, opts?: Omit<DocxScrollViewerOptions, keyof LoadOptions>): Omit<DocxScrollViewer, 'load'>;
   constructor(container: HTMLElement, opts?: DocxScrollViewerOptions);
   load(source: string | ArrayBuffer): Promise<void>;
   get pageCount(): number;
+  get layoutComplete(): boolean;
+  waitUntilLayoutComplete(): Promise<void>;
+  private _bindLayoutDocument;
+  private _unbindLayoutDocument;
+  private _onLayoutPublication;
+  private _refreshCommentSurface;
+  private _applyLayoutPublication;
+  private _revealPendingLayoutAtPresentedTail;
+  private _revealPendingLayoutThroughPage;
   private _pageWidthPx;
   private _pageHeightPx;
   private _fitWidthPx;
@@ -2368,6 +2454,7 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private _syncSpacerWidth;
   private _onScroll;
   private _mountVisible;
+  private _emitVisiblePageChange;
   private _applyPageShadow;
   private _acquireSlot;
   private _recycleSlot;
@@ -2375,6 +2462,7 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private _dpr;
   private _renderSlot;
   private _hyperlinkHandler;
+  private _navigateInternalHyperlink;
   private _measureForFont;
   private _canvasCssPx;
   private _reportRenderError;
@@ -2388,9 +2476,11 @@ declare class DocxScrollViewer implements ZoomableViewer {
   private _fit;
   private _previewVisible;
   private _previewSlot;
+  private _clearTextLayerPreview;
   private _scheduleSettle;
   private _settleRender;
-  private _settleSlot;
+  private _refreshSlotAtomically;
+  setShowTrackedChanges(value: boolean): Promise<void>;
   scrollToPage(index: number, opts?: {
     behavior?: 'auto' | 'smooth';
   }): void;