@silurus/ooxml 0.76.2 → 0.77.0

package/dist/types/xlsx.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-BqgLAFOG.d.ts
 type MathStyle = 'roman' | 'italic' | 'bold' | 'boldItalic';
 interface MathRun {
   kind: 'run';
@@ -372,9 +372,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);
@@ -475,7 +480,11 @@ 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 ViewerContextMenuEvent<TContext> {
+  readonly originalEvent: MouseEvent;
+  getContext(): Promise<TContext | null>;
+}
 interface AutoResizeOptions {
   pauseWhenHidden?: boolean;
 }
@@ -501,7 +510,7 @@ interface FindHighlightColors {
   active?: string;
 }
 //#endregion
-//#region dist/.types-work/xlsx-DrRsBH8s.d.ts
+//#region dist/.types-work/xlsx-DrlamDaR.d.ts
 interface Workbook {
   sheets: SheetMeta[];
   date1904?: boolean;
@@ -543,7 +552,7 @@ interface Worksheet {
   rightToLeft?: boolean;
   outlinePr?: OutlinePr;
   tabColor?: string | null;
-  autoFilter?: CellRange$1 | null;
+  autoFilter?: WorksheetCellRange | null;
   hyperlinks?: Hyperlink[];
   commentRefs?: string[];
   comments?: XlsxComment[];
@@ -574,7 +583,7 @@ interface PivotTableMetadata {
   status: PivotMetadataStatus;
   extensionUris?: string[];
 }
-interface PivotLocation extends CellRange$1 {
+interface PivotLocation extends WorksheetCellRange {
   firstHeaderRow: number;
   firstDataRow: number;
   firstDataCol: number;
@@ -717,7 +726,7 @@ interface SlicerElementStyle {
   borderColor?: string;
 }
 interface TableInfo {
-  range: CellRange$1;
+  range: WorksheetCellRange;
   styleName: string;
   headerRowCount: number;
   totalsRowCount: number;
@@ -762,12 +771,6 @@ interface DataValidation {
   errorTitle?: string;
   errorMessage?: string;
 }
-type XlsxChartSeries = ChartSeries;
-type SeriesDataLabels = ChartSeriesDataLabels;
-type DataLabelOverride = ChartDataLabelOverride;
-type DataPointOverride = ChartDataPointOverride;
-type ErrBars = ChartErrBars;
-type ManualLayout = ChartManualLayout;
 interface ChartAnchor {
   fromCol: number;
   fromColOff: number;
@@ -932,7 +935,7 @@ interface ImageAnchor {
   alpha?: number;
   duotone?: Duotone;
 }
-interface CellRange$1 {
+interface WorksheetCellRange {
   top: number;
   left: number;
   bottom: number;
@@ -946,7 +949,7 @@ interface Hyperlink {
   display?: string | null;
 }
 interface ConditionalFormat {
-  sqref: CellRange$1[];
+  sqref: WorksheetCellRange[];
   rules: CfRule[];
 }
 type CfRule = {
@@ -1181,7 +1184,7 @@ interface XlsxTextRunInfo {
   row: number;
   col: number;
 }
-interface RenderViewportOptions {
+interface XlsxRenderViewportOptions {
   width?: number;
   height?: number;
   dpr?: number;
@@ -1192,8 +1195,6 @@ interface RenderViewportOptions {
   freezeRows?: number;
   freezeCols?: number;
   cellScale?: number;
-  loadedImages?: Map<string, CanvasImageSource | null>;
-  fetchImage?: (path: string, mimeType: string) => Promise<Blob>;
   onTextRun?: (info: XlsxTextRunInfo) => void;
   selectedRowRange?: {
     start: number;
@@ -1213,12 +1214,9 @@ type ResolvedList = {
   kind: 'formula';
   formula: string;
 };
-interface WireSizeOverrides {
-  rows?: Record<number, number | null>;
-  cols?: Record<number, number | null>;
-}
-type WireRenderViewportOptions = Omit<RenderViewportOptions, 'onTextRun' | 'loadedImages' | 'fetchImage'> & {
-  sizeOverrides?: WireSizeOverrides;
+type RenderViewportToBitmapOptions = Omit<XlsxRenderViewportOptions, 'onTextRun'> & {
+  width: number;
+  height: number;
 };
 interface LoadOptions extends LoadOptions$1 {
   mode?: 'main' | 'worker';
@@ -1267,16 +1265,97 @@ declare class XlsxWorkbook {
   toMarkdown(): Promise<string>;
   resolveValidationList(sheetIndex: number, formula1: string | undefined): Promise<ResolvedList>;
   cellText(ws: Worksheet, cell: Cell): string;
-  renderViewport(target: HTMLCanvasElement | OffscreenCanvas, sheetIndex: number, viewport: ViewportRange, opts?: RenderViewportOptions): Promise<void>;
-  renderViewportToBitmap(sheetIndex: number, viewport: ViewportRange, opts: WireRenderViewportOptions & {
-    width: number;
-    height: number;
-  }): Promise<ImageBitmap>;
+  renderViewport(target: HTMLCanvasElement | OffscreenCanvas, sheetIndex: number, viewport: ViewportRange, opts?: XlsxRenderViewportOptions): Promise<void>;
+  renderViewportToBitmap(sheetIndex: number, viewport: ViewportRange, opts: RenderViewportToBitmapOptions): Promise<ImageBitmap>;
   private withWorksheetArchiveOperation;
   destroy(): void;
   private assertResourceHealthy;
 }
 type CanvasViewerRenderMode = 'main' | 'worker';
+interface CellAddress {
+  row: number;
+  col: number;
+}
+type XlsxSelectionArea = Readonly<{
+  kind: 'cells';
+  top: number;
+  left: number;
+  bottom: number;
+  right: number;
+}> | Readonly<{
+  kind: 'rows';
+  firstRow: number;
+  lastRow: number;
+}> | Readonly<{
+  kind: 'columns';
+  firstColumn: number;
+  lastColumn: number;
+}> | Readonly<{
+  kind: 'sheet';
+}>;
+interface XlsxSelectionState {
+  readonly areas: readonly XlsxSelectionArea[];
+  readonly activeAreaIndex: number;
+  readonly activeCell: CellAddress;
+  readonly extensionAnchor: CellAddress;
+}
+type XlsxSelectionInput = string | XlsxSelectionState | null;
+interface XlsxSelectionContextOptions {
+  readonly maxCells?: number;
+  readonly maxTextCharacters?: number;
+}
+interface XlsxSelectionContextCell {
+  readonly address: CellAddress;
+  readonly displayText: string;
+  readonly valueType: 'empty' | 'text' | 'number' | 'bool' | 'error' | 'shared';
+  readonly value: string | number | boolean | null;
+  readonly formula?: string;
+}
+interface XlsxRangeSelectionContext {
+  readonly format: 'xlsx';
+  readonly kind: 'range';
+  readonly sheetIndex: number;
+  readonly sheetName: string;
+  readonly selection: XlsxSelectionState;
+  readonly coordinateCountUpperBound: number;
+  readonly cells: readonly XlsxSelectionContextCell[];
+  readonly truncated: boolean;
+  readonly truncationReasons: readonly ('cells' | 'text')[];
+  readonly maxCells: number;
+  readonly textCharacters: number;
+  readonly maxTextCharacters: number;
+}
+interface XlsxElementAnchorMarker {
+  readonly row: number;
+  readonly col: number;
+  readonly offsetX: number;
+  readonly offsetY: number;
+}
+interface XlsxElementContext {
+  readonly format: 'xlsx';
+  readonly kind: 'element';
+  readonly sheetIndex: number;
+  readonly sheetName: string;
+  readonly elementType: 'chart' | 'image' | 'shape';
+  readonly elementIndex: number;
+  readonly shapeIndex?: number;
+  readonly anchor: Readonly<{
+    from: XlsxElementAnchorMarker;
+    to: XlsxElementAnchorMarker;
+  }>;
+  readonly text?: string;
+  readonly mimeType?: string;
+  readonly seriesCount?: number;
+  readonly shapeCount?: number;
+  readonly truncated: boolean;
+  readonly truncationReasons: readonly ('text')[];
+  readonly textCharacters: number;
+  readonly maxTextCharacters: number;
+}
+type XlsxSelectionContext = XlsxRangeSelectionContext | XlsxElementContext;
+declare const MAX_SELECTION_AREAS = 128;
+declare const MAX_SELECTION_CONTEXT_CELLS = 10000;
+declare const MAX_SELECTION_CONTEXT_TEXT_CHARACTERS: number;
 interface XlsxMatchLocation {
   sheet: number;
   sheetName: string;
@@ -1285,7 +1364,7 @@ interface XlsxMatchLocation {
   col: number;
 }
 type HiddenSheetMode = 'show' | 'skip' | 'dim';
-interface XlsxSheetViewerOptions extends LoadOptions$1 {
+interface XlsxSheetViewerOptions extends LoadOptions {
   cellScale?: number;
   resizable?: boolean;
   showScrollbars?: boolean;
@@ -1295,12 +1374,14 @@ interface XlsxSheetViewerOptions extends LoadOptions$1 {
   onReady?: (sheetNames: string[]) => void;
   onSheetChange?: (index: number, total: number) => void;
   onError?: (err: Error) => void;
-  onSelectionChange?: (selection: CellRange | null) => void;
+  onSelectionStateChange?: (selection: XlsxSelectionState | null) => void;
+  onSelectionContextChange?: (context: XlsxSelectionContext | null) => void;
+  onContextMenu?: (event: ViewerContextMenuEvent<XlsxSelectionContext>) => void;
+  enableElementSelection?: boolean;
   onHyperlinkClick?: (target: HyperlinkTarget) => void;
   enableHyperlinks?: boolean;
   selectionColor?: string;
   findHighlightColors?: FindHighlightColors;
-  mode?: 'main' | 'worker';
   hiddenSheetMode?: HiddenSheetMode;
   onViewportChange?: (offset: XlsxViewportOffset) => void;
 }
@@ -1314,16 +1395,22 @@ interface XlsxViewportOffset {
 interface XlsxScrollToCellOptions {
   readonly align?: 'nearest' | 'start' | 'center' | 'end';
 }
-interface CellAddress {
-  row: number;
-  col: number;
-}
-type SelectionMode = 'cells' | 'rows' | 'cols' | 'all';
-interface CellRange {
-  anchor: CellAddress;
-  active: CellAddress;
-  mode: SelectionMode;
-}
+type XlsxCopyResult = Readonly<{
+  status: 'copied';
+  cellCount: number;
+  utf16CodeUnits: number;
+}> | Readonly<{
+  status: 'empty-selection';
+}> | Readonly<{
+  status: 'unsupported-multiple-areas';
+}> | Readonly<{
+  status: 'too-large';
+  limit: 'cells' | 'text';
+}> | Readonly<{
+  status: 'clipboard-unavailable';
+}> | Readonly<{
+  status: 'clipboard-denied';
+}>;
 type XlsxViewerMount = {
   readonly kind: 'composite';
 } | {
@@ -1383,22 +1470,30 @@ declare class XlsxViewerEngine implements ZoomableViewer {
   private resizeObserver;
   private _lastViewportNotification;
   private get anchorCell();
-  private set anchorCell(value);
   private get activeCell();
-  private set activeCell(value);
   private get selectionMode();
-  private set selectionMode(value);
   private get isSelecting();
   private get selectionPointerId();
   private beginSelectionDrag;
   private _pendingZoomAnchor;
   private readonly selectionController;
+  private lastNotifiedSelectionState;
+  private emittingSelectionChange;
+  private pendingSelectionChange;
+  private selectionNotificationScheduled;
+  private selectionNotificationCount;
+  private selectionContextNotificationFrame;
+  private selectionContextNotificationMicrotask;
+  private readonly selectionContextRows;
+  private readonly selectionContextCells;
+  private elementContext;
   private selectionOverlay;
   private findOverlay;
   private _find;
   private keydownHandler;
   private pendingTap;
   private pendingClick;
+  private pendingElementClick;
   private resizeDrag;
   private selectionAutoScrollPointer;
   private selectionAutoScrollFrame;
@@ -1423,7 +1518,7 @@ declare class XlsxViewerEngine implements ZoomableViewer {
   private get workbook();
   private get wb();
   private set wb(value);
-  showSheet(index: number): Promise<void>;
+  private showSheet;
   private isCurrentSheetRequest;
   private buildOutline;
   private layoutGutters;
@@ -1466,9 +1561,18 @@ declare class XlsxViewerEngine implements ZoomableViewer {
   private _stepSheet;
   private _initialSheet;
   getCellAt(clientX: number, clientY: number): CellAddress | null;
+  private elementContextViewport;
+  private elementContextAt;
   private getCellRect;
-  get selection(): CellRange | null;
-  select(ref: string): void;
+  get selectionState(): XlsxSelectionState | null;
+  setSelection(input: XlsxSelectionInput): void;
+  getSelectionContext(options?: XlsxSelectionContextOptions): XlsxSelectionContext | null;
+  private commitSelection;
+  private setElementContext;
+  private scheduleSelectionContextNotification;
+  private emitSelectionChange;
+  private scheduleSelectionNotification;
+  private finishSelectionNotificationChain;
   private getHeaderHit;
   private getResizeTarget;
   private applyResize;
@@ -1476,8 +1580,9 @@ declare class XlsxViewerEngine implements ZoomableViewer {
   setHiddenSheetMode(mode: HiddenSheetMode): Promise<void>;
   get hiddenSheetMode(): HiddenSheetMode;
   get visibleSheetCount(): number;
-  private copySelection;
+  copySelection(): Promise<XlsxCopyResult>;
   private updateSelectionOverlay;
+  private drawElementContextOverlay;
   private maybeDrawValidationDropdown;
   private updateFindOverlay;
   findText(query: string, opts?: FindMatchesOptions): Promise<FindMatch<XlsxMatchLocation>[]>;
@@ -1508,6 +1613,8 @@ declare class XlsxViewerEngine implements ZoomableViewer {
   private trackSelectionAutoScroll;
   private runSelectionAutoScroll;
   private stopSelectionAutoScroll;
+  private contextMenuTargetIsSelected;
+  private resolveContextMenuContext;
   private setupSelectionEvents;
   private buildTabs;
   private makeNavButton;
@@ -1542,7 +1649,7 @@ declare class XlsxViewerEngine implements ZoomableViewer {
   private destroyedError;
 }
 declare class XlsxViewer extends XlsxViewerEngine {
-  static fromWorkbook(container: HTMLElement, workbook: XlsxWorkbook, opts?: Omit<XlsxViewerOptions, keyof LoadOptions$1>): Omit<XlsxViewer, 'load'>;
+  static fromWorkbook(container: HTMLElement, workbook: XlsxWorkbook, opts?: Omit<XlsxViewerOptions, keyof LoadOptions>): Omit<XlsxViewer, 'load'>;
   constructor(container: HTMLElement, opts?: XlsxViewerOptions);
 }
 declare class XlsxSheetViewer implements ZoomableViewer {
@@ -1552,7 +1659,7 @@ declare class XlsxSheetViewer implements ZoomableViewer {
   private destroyed;
   private snapshot;
   private lastMetrics;
-  static fromWorkbook(canvasElement: HTMLCanvasElement, workbook: XlsxWorkbook, options?: Omit<XlsxSheetViewerOptions, keyof LoadOptions$1>): Omit<XlsxSheetViewer, 'load'>;
+  static fromWorkbook(canvasElement: HTMLCanvasElement, workbook: XlsxWorkbook, options?: Omit<XlsxSheetViewerOptions, keyof LoadOptions>): Omit<XlsxSheetViewer, 'load'>;
   constructor(canvasElement: HTMLCanvasElement, options?: XlsxSheetViewerOptions);
   load(source: string | ArrayBuffer): Promise<void>;
   get sheetIndex(): number;
@@ -1572,8 +1679,10 @@ declare class XlsxSheetViewer implements ZoomableViewer {
   fitWidth(): void;
   fitPage(): void;
   getCellAt(clientX: number, clientY: number): CellAddress | null;
-  get selection(): CellRange | null;
-  select(ref: string): void;
+  get selectionState(): XlsxSelectionState | null;
+  setSelection(selection: XlsxSelectionInput): void;
+  getSelectionContext(options?: XlsxSelectionContextOptions): XlsxSelectionContext | null;
+  copySelection(): Promise<XlsxCopyResult>;
   setSelectionColor(color: string): void;
   setHiddenSheetMode(mode: HiddenSheetMode): Promise<void>;
   get hiddenSheetMode(): HiddenSheetMode;
@@ -1590,4 +1699,4 @@ declare class XlsxSheetViewer implements ZoomableViewer {
 }
 declare function resolveSharedStrings(ws: Worksheet, sharedStrings: SharedString[]): Worksheet;
 //#endregion
-export { type AutoResizeOptions, type Border, type BorderEdge, type Cell, type CellAddress, type CellFill, type CellFont, type CellRange, type CellValue, type CellXf, type CfIcon, type CfRule, type CfStop, type CfValue, type ChartAnchor, type ChartDataLabelOverride, type ChartDataPointOverride, type ChartErrBars, type ChartManualLayout, type ChartModel, type ChartSeries, type ChartSeriesDataLabels, type ConditionalFormat, type DataLabelOverride, type DataPointOverride, type DataValidation, type DefinedName, type Duotone, type Dxf, type ErrBars, type FindHighlightColors, type FindMatch, type FindMatchesOptions, type GradientFillSpec, type HiddenSheetMode, type Hyperlink, type HyperlinkTarget, type ImageAnchor, type LegendManualLayout, type LoadOptions, type ManualLayout, type MergeCell, type NumFmt, 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 OutlinePr, type ParsedWorkbook, type PathCmd, type PathInfo, type PhoneticAlignment, type PhoneticProperties, type PhoneticRun, type PhoneticType, type PivotCacheSource, type PivotDataField, type PivotDiagnostic, type PivotLocation, type PivotMetadataStatus, type PivotPageField, type PivotPartialReason, type PivotTableMetadata, type RenderViewportOptions, type ResolvedList, type Row, type Run, type RunFont, type SelectionMode, type SeriesDataLabels, type ShapeAnchor, type ShapeGeom, type ShapeInfo, type ShapeParagraph, type ShapeText, type ShapeTextRun, type SharedString, type SheetMeta, type SheetVisibility, type SlicerAnchor, type SlicerElementStyle, type SlicerItem, type SlicerStyle, type Sparkline, type SparklineGroup, type Styles, type TableColumnInfo, type TableInfo, type ViewportRange, type WireRenderViewportOptions, type WireSizeOverrides, type Workbook, type Worksheet, type XlsxChartSeries, type XlsxComment, type XlsxMatchLocation, type XlsxScrollToCellOptions, XlsxSheetViewer, type XlsxSheetViewerOptions, type XlsxTextRunInfo, XlsxViewer, type XlsxViewerOptions, type XlsxViewportOffset, XlsxWorkbook, autoResize, isOoxmlDecodedImageLimitError, openExternalHyperlink, resolveSharedStrings };
+export { type AutoResizeOptions, type Border, type BorderEdge, type Cell, type CellAddress, type CellFill, type CellFont, type CellValue, type CellXf, type CfIcon, type CfRule, type CfStop, type CfValue, type ChartAnchor, type ChartDataLabelOverride, type ChartDataPointOverride, type ChartErrBars, type ChartLabelBox, type ChartManualLayout, type ChartModel, type ChartRect, type ChartSeries, type ChartSeriesDataLabels, type ChartTrendline, type ChartType, type ChartexBoxSeries, type ChartexBoxWhisker, type ChartexSunburst, type ChartexSunburstRow, type ConditionalFormat, type DataValidation, type DefinedName, type Duotone, type Dxf, type FindHighlightColors, type FindMatch, type FindMatchesOptions, type GradientFillSpec, type HiddenSheetMode, type Hyperlink, type HyperlinkTarget, type ImageAnchor, type LegendManualLayout, type LoadOptions, MAX_SELECTION_AREAS, MAX_SELECTION_CONTEXT_CELLS, MAX_SELECTION_CONTEXT_TEXT_CHARACTERS, 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 MergeCell, type NumFmt, 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 OutlinePr, type ParsedWorkbook, type PathCmd, type PathInfo, type PhoneticAlignment, type PhoneticProperties, type PhoneticRun, type PhoneticType, type PivotCacheSource, type PivotDataField, type PivotDiagnostic, type PivotLocation, type PivotMetadataStatus, type PivotPageField, type PivotPartialReason, type PivotTableMetadata, type RenderViewportToBitmapOptions, type ResolvedList, type Row, type Run, type RunFont, type SecondaryValueAxis, type ShapeAnchor, type ShapeGeom, type ShapeInfo, type ShapeParagraph, type ShapeText, type ShapeTextRun, type SharedString, type SheetMeta, type SheetVisibility, type SlicerAnchor, type SlicerElementStyle, type SlicerItem, type SlicerStyle, type SpaceLine, type Sparkline, type SparklineGroup, type Styles, type TableColumnInfo, type TableInfo, type ViewerContextMenuEvent, type ViewportRange, type Workbook, type Worksheet, type WorksheetCellRange, type XlsxComment, type XlsxCopyResult, type XlsxElementAnchorMarker, type XlsxElementContext, type XlsxMatchLocation, type XlsxRangeSelectionContext, type XlsxRenderViewportOptions, type XlsxScrollToCellOptions, type XlsxSelectionArea, type XlsxSelectionContext, type XlsxSelectionContextCell, type XlsxSelectionContextOptions, type XlsxSelectionInput, type XlsxSelectionState, XlsxSheetViewer, type XlsxSheetViewerOptions, type XlsxTextRunInfo, XlsxViewer, type XlsxViewerOptions, type XlsxViewportOffset, XlsxWorkbook, type ZoomableViewer, autoResize, isOoxmlDecodedImageLimitError, openExternalHyperlink, resolveSharedStrings };