@extend-ai/react-xlsx 0.16.6 → 0.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/README.md +56 -0
  2. package/dist/index.cjs +438 -99
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +35 -1
  5. package/dist/index.d.ts +35 -1
  6. package/dist/index.js +437 -99
  7. package/dist/index.js.map +1 -1
  8. package/dist/xlsx-worker.js +45 -20
  9. package/dist/xlsx-worker.js.map +1 -1
  10. package/package.json +2 -2
package/dist/index.d.cts CHANGED
@@ -17,6 +17,7 @@ interface XlsxResolvedCellStyle {
17
17
  };
18
18
  fill?: Record<string, unknown>;
19
19
  font?: Record<string, unknown>;
20
+ tableStyleOverrides?: XlsxResolvedCellStyle;
20
21
  }
21
22
  interface XlsxTableStyleDefinition {
22
23
  [elementType: string]: XlsxResolvedCellStyle;
@@ -99,6 +100,7 @@ interface XlsxFreezePanes {
99
100
  }
100
101
  type XlsxSheetVisibility = "hidden" | "veryHidden" | "visible";
101
102
  interface XlsxSheetData {
103
+ cellStyleIds?: Record<string, number>;
102
104
  autoFilterRanges: XlsxCellRange[];
103
105
  cachedFormulaValues: Record<string, string>;
104
106
  colWidthOverridesPx: Record<number, number>;
@@ -117,6 +119,7 @@ interface XlsxSheetData {
117
119
  hasVerticalMerges: boolean;
118
120
  maxHorizontalMergeEndCol: number;
119
121
  maxVerticalMergeEndRow: number;
122
+ mergedRanges?: XlsxCellRange[];
120
123
  minUsedCol: number;
121
124
  minUsedRow: number;
122
125
  maxUsedCol: number;
@@ -146,6 +149,23 @@ interface XlsxCellRange {
146
149
  end: XlsxCellAddress;
147
150
  start: XlsxCellAddress;
148
151
  }
152
+ interface XlsxParsedRange {
153
+ kind: "cells" | "rows" | "columns";
154
+ range: XlsxCellRange;
155
+ sheetName: string | null;
156
+ }
157
+ interface XlsxHighlightRangeOptions {
158
+ /** Navigates to the worksheet and reveals the first range. Defaults to true. */
159
+ autoScroll?: boolean;
160
+ /** Visible worksheet index for an unqualified reference. Defaults to the active worksheet. */
161
+ sheetIndex?: number;
162
+ }
163
+ interface XlsxRangeHighlight extends XlsxParsedRange {
164
+ /** Whether this entry is the navigation target for the current highlight update. */
165
+ autoScroll: boolean;
166
+ sheetName: string;
167
+ workbookSheetIndex: number;
168
+ }
149
169
  /**
150
170
  * Color value accepted by persisted workbook style mutation APIs.
151
171
  *
@@ -1037,6 +1057,11 @@ interface XlsxViewerController {
1037
1057
  addFormControl: (input: XlsxFormControlInput, sheetIndex?: number) => number | null;
1038
1058
  clearSelectedCells: () => void;
1039
1059
  clearSelection: () => void;
1060
+ /** Removes all render-only range highlights. */
1061
+ clearHighlightedRanges: () => void;
1062
+ /** Replaces the highlights with validated A1 ranges. Returns false without changing state if any reference cannot be resolved. */
1063
+ highlightRanges: (references: string | readonly string[], options?: XlsxHighlightRangeOptions) => boolean;
1064
+ highlightedRanges: XlsxRangeHighlight[];
1040
1065
  continueDeferredLoad: () => void;
1041
1066
  copySelectionToClipboard: () => Promise<boolean>;
1042
1067
  defaultZoomScale: number;
@@ -1455,6 +1480,12 @@ interface XlsxViewerProviderProps extends UseXlsxViewerControllerOptions {
1455
1480
  isDark?: boolean;
1456
1481
  }
1457
1482
  interface XlsxViewerProps extends UseXlsxViewerControllerOptions {
1483
+ /** Render-only A1 ranges to highlight. Null or an empty array clears them; undefined leaves controller state alone. */
1484
+ highlightedRanges?: string | readonly string[] | null;
1485
+ /** Reveals the first newly highlighted range, including switching worksheets. Defaults to true. */
1486
+ autoScrollToHighlightedRanges?: boolean;
1487
+ /** Additional CSS class applied to the range highlight in both renderers. */
1488
+ highlightClassName?: string;
1458
1489
  /**
1459
1490
  * Allows row and column resizing even while editing is disabled by `readOnly`.
1460
1491
  *
@@ -1669,6 +1700,9 @@ declare class XlsxFileSizeLimitExceededError extends Error {
1669
1700
  }
1670
1701
  declare function useXlsxViewerController(options: UseXlsxViewerControllerOptions): XlsxViewerController;
1671
1702
 
1703
+ /** Parses one rectangular A1 reference into normalized, zero-based coordinates. */
1704
+ declare function parseXlsxRange(reference: string): XlsxParsedRange | null;
1705
+
1672
1706
  type XlsxWasmSource = string | URL | Request | Response | BufferSource | WebAssembly.Module;
1673
1707
  declare function setWasmSource(source: XlsxWasmSource): void;
1674
1708
  declare function initWasm(source?: XlsxWasmSource): Promise<typeof _dukelib_sheets_wasm>;
@@ -1685,4 +1719,4 @@ declare function useXlsxViewerThumbnails(options?: UseXlsxViewerThumbnailsOption
1685
1719
  declare function XlsxViewer(props: XlsxViewerProps): react_jsx_runtime.JSX.Element;
1686
1720
  declare function DefaultXlsxToolbar(): react_jsx_runtime.JSX.Element;
1687
1721
 
1688
- export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };
1722
+ export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxHighlightRangeOptions, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxParsedRange, type XlsxRangeHighlight, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, parseXlsxRange, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };
package/dist/index.d.ts CHANGED
@@ -17,6 +17,7 @@ interface XlsxResolvedCellStyle {
17
17
  };
18
18
  fill?: Record<string, unknown>;
19
19
  font?: Record<string, unknown>;
20
+ tableStyleOverrides?: XlsxResolvedCellStyle;
20
21
  }
21
22
  interface XlsxTableStyleDefinition {
22
23
  [elementType: string]: XlsxResolvedCellStyle;
@@ -99,6 +100,7 @@ interface XlsxFreezePanes {
99
100
  }
100
101
  type XlsxSheetVisibility = "hidden" | "veryHidden" | "visible";
101
102
  interface XlsxSheetData {
103
+ cellStyleIds?: Record<string, number>;
102
104
  autoFilterRanges: XlsxCellRange[];
103
105
  cachedFormulaValues: Record<string, string>;
104
106
  colWidthOverridesPx: Record<number, number>;
@@ -117,6 +119,7 @@ interface XlsxSheetData {
117
119
  hasVerticalMerges: boolean;
118
120
  maxHorizontalMergeEndCol: number;
119
121
  maxVerticalMergeEndRow: number;
122
+ mergedRanges?: XlsxCellRange[];
120
123
  minUsedCol: number;
121
124
  minUsedRow: number;
122
125
  maxUsedCol: number;
@@ -146,6 +149,23 @@ interface XlsxCellRange {
146
149
  end: XlsxCellAddress;
147
150
  start: XlsxCellAddress;
148
151
  }
152
+ interface XlsxParsedRange {
153
+ kind: "cells" | "rows" | "columns";
154
+ range: XlsxCellRange;
155
+ sheetName: string | null;
156
+ }
157
+ interface XlsxHighlightRangeOptions {
158
+ /** Navigates to the worksheet and reveals the first range. Defaults to true. */
159
+ autoScroll?: boolean;
160
+ /** Visible worksheet index for an unqualified reference. Defaults to the active worksheet. */
161
+ sheetIndex?: number;
162
+ }
163
+ interface XlsxRangeHighlight extends XlsxParsedRange {
164
+ /** Whether this entry is the navigation target for the current highlight update. */
165
+ autoScroll: boolean;
166
+ sheetName: string;
167
+ workbookSheetIndex: number;
168
+ }
149
169
  /**
150
170
  * Color value accepted by persisted workbook style mutation APIs.
151
171
  *
@@ -1037,6 +1057,11 @@ interface XlsxViewerController {
1037
1057
  addFormControl: (input: XlsxFormControlInput, sheetIndex?: number) => number | null;
1038
1058
  clearSelectedCells: () => void;
1039
1059
  clearSelection: () => void;
1060
+ /** Removes all render-only range highlights. */
1061
+ clearHighlightedRanges: () => void;
1062
+ /** Replaces the highlights with validated A1 ranges. Returns false without changing state if any reference cannot be resolved. */
1063
+ highlightRanges: (references: string | readonly string[], options?: XlsxHighlightRangeOptions) => boolean;
1064
+ highlightedRanges: XlsxRangeHighlight[];
1040
1065
  continueDeferredLoad: () => void;
1041
1066
  copySelectionToClipboard: () => Promise<boolean>;
1042
1067
  defaultZoomScale: number;
@@ -1455,6 +1480,12 @@ interface XlsxViewerProviderProps extends UseXlsxViewerControllerOptions {
1455
1480
  isDark?: boolean;
1456
1481
  }
1457
1482
  interface XlsxViewerProps extends UseXlsxViewerControllerOptions {
1483
+ /** Render-only A1 ranges to highlight. Null or an empty array clears them; undefined leaves controller state alone. */
1484
+ highlightedRanges?: string | readonly string[] | null;
1485
+ /** Reveals the first newly highlighted range, including switching worksheets. Defaults to true. */
1486
+ autoScrollToHighlightedRanges?: boolean;
1487
+ /** Additional CSS class applied to the range highlight in both renderers. */
1488
+ highlightClassName?: string;
1458
1489
  /**
1459
1490
  * Allows row and column resizing even while editing is disabled by `readOnly`.
1460
1491
  *
@@ -1669,6 +1700,9 @@ declare class XlsxFileSizeLimitExceededError extends Error {
1669
1700
  }
1670
1701
  declare function useXlsxViewerController(options: UseXlsxViewerControllerOptions): XlsxViewerController;
1671
1702
 
1703
+ /** Parses one rectangular A1 reference into normalized, zero-based coordinates. */
1704
+ declare function parseXlsxRange(reference: string): XlsxParsedRange | null;
1705
+
1672
1706
  type XlsxWasmSource = string | URL | Request | Response | BufferSource | WebAssembly.Module;
1673
1707
  declare function setWasmSource(source: XlsxWasmSource): void;
1674
1708
  declare function initWasm(source?: XlsxWasmSource): Promise<typeof _dukelib_sheets_wasm>;
@@ -1685,4 +1719,4 @@ declare function useXlsxViewerThumbnails(options?: UseXlsxViewerThumbnailsOption
1685
1719
  declare function XlsxViewer(props: XlsxViewerProps): react_jsx_runtime.JSX.Element;
1686
1720
  declare function DefaultXlsxToolbar(): react_jsx_runtime.JSX.Element;
1687
1721
 
1688
- export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };
1722
+ export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxHighlightRangeOptions, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxParsedRange, type XlsxRangeHighlight, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, parseXlsxRange, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };