@extend-ai/react-xlsx 0.14.1 → 0.15.0

package/dist/index.d.cts

@@ -441,56 +441,58 @@ interface XlsxShape {
 type XlsxFormControlKind = "button" | "checkbox" | "dropdown" | "editbox" | "group-box" | "label" | "listbox" | "radio" | "scrollbar" | "spinner" | "unknown";
 type XlsxFormControlState = "unchecked" | "checked" | "mixed";
 type XlsxFormControlSelectionMode = "single" | "multi" | "extend";
-/** Duke Sheets' flat worksheet anchor used when creating or updating form controls. */
-interface XlsxFormControlAnchor {
-    editAs: "twoCell" | "oneCell" | "absolute";
-    fromCol: number;
-    fromColOffset: number;
-    fromRow: number;
-    fromRowOffset: number;
-    toCol: number;
-    toColOffset: number;
-    toRow: number;
-    toRowOffset: number;
-}
-/** Kind-specific input accepted by Duke Sheets for form-control mutations. */
+interface XlsxFormControlCaptionRun {
+    font?: XlsxCellFontStyleInput;
+    text: string;
+}
+interface XlsxFormControlCaption {
+    horizontalAlignment?: "general" | "left" | "center" | "right" | "fill" | "justify" | "centerContinuous" | "distributed";
+    runs: XlsxFormControlCaptionRun[];
+    verticalAlignment?: "top" | "center" | "bottom" | "justify" | "distributed";
+}
+type XlsxFormControlCaptionInput = string | XlsxFormControlCaption;
 type XlsxFormControlKindInput = {
     kind: "button";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
 } | {
     kind: "checkbox";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
     state: XlsxFormControlState;
     cellLink?: string;
-    no3D: boolean;
+    no3D?: boolean;
 } | {
     kind: "optionButton";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
     state: Exclude<XlsxFormControlState, "mixed">;
     cellLink?: string;
-    firstInGroup?: boolean;
-    no3D: boolean;
+    no3D?: boolean;
 } | {
     kind: "label";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
 } | {
     kind: "groupBox";
-    caption: string;
-    no3D: boolean;
+    caption: XlsxFormControlCaptionInput;
+    no3D?: boolean;
 } | {
     kind: "listBox";
     inputRange?: string;
     cellLink?: string;
     selection: XlsxFormControlSelectionMode;
-    selected: number[];
-    no3D: boolean;
+    selected?: number[];
+    no3D?: boolean;
 } | {
     kind: "dropdown";
     inputRange?: string;
     cellLink?: string;
     selected?: number;
     lines: number;
-    no3D: boolean;
+    no3D?: boolean;
+} | {
+    kind: "editbox";
+    caption: XlsxFormControlCaptionInput;
+    legacyObjectType?: number;
+    rawObj?: Uint8Array | number[];
+    rawProperties?: Array<[string, string]>;
 } | {
     kind: "scrollbar";
     value: number;
@@ -498,7 +500,7 @@ type XlsxFormControlKindInput = {
     max: number;
     increment: number;
     page: number;
-    horizontal: boolean;
+    horizontal?: boolean;
     cellLink?: string;
 } | {
     kind: "spinner";
@@ -507,30 +509,51 @@ type XlsxFormControlKindInput = {
     max: number;
     increment: number;
     cellLink?: string;
+} | {
+    kind: "unknown";
+    objectType: string;
+    legacyObjectType?: number;
+    caption?: XlsxFormControlCaptionInput;
+    rawObj?: Uint8Array | number[];
+    rawProperties?: Array<[string, string]>;
 };
-/** Complete Duke Sheets input for adding a worksheet form control. */
-interface XlsxFormControlInput {
-    anchor: XlsxFormControlAnchor;
+interface XlsxFormControlMetadataInput {
+    altText?: string;
+    hidden?: boolean;
     kind: XlsxFormControlKindInput;
     locked?: boolean;
+    macroName?: string;
     name?: string;
     printable?: boolean;
+    rawClientData?: Array<Uint8Array | number[]>;
+    title?: string;
 }
-/** Partial Duke Sheets input for changing an existing worksheet form control. */
-type XlsxFormControlPatch = Partial<Omit<XlsxFormControlInput, "kind">> & {
+type XlsxFormControlInput = XlsxFormControlMetadataInput & ({
+    anchor: Extract<XlsxImageAnchor, {
+        kind: "two-cell";
+    }>;
+    editAs?: "twoCell" | "oneCell" | "absolute";
+} | {
+    anchor: Exclude<XlsxImageAnchor, {
+        kind: "two-cell";
+    }>;
+    editAs?: never;
+});
+type XlsxFormControlPatch = Partial<Omit<XlsxFormControlMetadataInput, "kind">> & {
+    anchor?: XlsxImageAnchor;
+    editAs?: "twoCell" | "oneCell" | "absolute";
     kind?: XlsxFormControlKindInput;
 };
 interface XlsxFormControl {
     anchor: XlsxImageAnchor;
-    /** Original Excel caption reported by Duke Sheets. */
-    caption?: string;
+    altText?: string;
+    /** Original rich caption reported by Duke Sheets. */
+    caption?: XlsxFormControlCaption;
     checked?: boolean;
     /** Duke Sheets' stable zero-based index for this worksheet load. */
     controlIndex?: number;
-    /** Original anchor behavior when Duke has flattened the anchor to two-cell coordinates. */
+    /** Original two-cell anchor behavior. */
     editAs?: "twoCell" | "oneCell" | "absolute";
-    /** Exact Duke Sheets anchor. Use this when cloning or updating the control through the controller. */
-    dukeAnchor?: XlsxFormControlAnchor;
     firstInGroup?: boolean;
     fontFamily?: string;
     fontSizePt?: number;
@@ -546,12 +569,18 @@ interface XlsxFormControl {
     lines?: number;
     linkedCell?: string;
     locked?: boolean;
+    macroName?: string;
     max?: number;
     min?: number;
     name?: string;
     no3D?: boolean;
     page?: number;
     printable?: boolean;
+    objectType?: string;
+    legacyObjectType?: number;
+    rawClientData?: number[][];
+    rawObj?: number[];
+    rawProperties?: Array<[string, string]>;
     /** Zero-based selected item index or indexes, matching Duke Sheets. */
     selected?: number | number[];
     selection?: XlsxFormControlSelectionMode;
@@ -559,6 +588,7 @@ interface XlsxFormControl {
     state?: XlsxFormControlState;
     textAlign?: "center" | "left" | "right";
     textColor?: string;
+    title?: string;
     value?: number;
     workbookSheetIndex: number;
     zIndex: number;
@@ -1600,4 +1630,4 @@ declare function useXlsxViewerThumbnails(options?: UseXlsxViewerThumbnailsOption
 declare function XlsxViewer(props: XlsxViewerProps): react_jsx_runtime.JSX.Element;
 declare function DefaultXlsxToolbar(): react_jsx_runtime.JSX.Element;
 
-export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, 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, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlAnchor, 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 };
+export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, 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, 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 };

package/dist/index.d.ts

@@ -441,56 +441,58 @@ interface XlsxShape {
 type XlsxFormControlKind = "button" | "checkbox" | "dropdown" | "editbox" | "group-box" | "label" | "listbox" | "radio" | "scrollbar" | "spinner" | "unknown";
 type XlsxFormControlState = "unchecked" | "checked" | "mixed";
 type XlsxFormControlSelectionMode = "single" | "multi" | "extend";
-/** Duke Sheets' flat worksheet anchor used when creating or updating form controls. */
-interface XlsxFormControlAnchor {
-    editAs: "twoCell" | "oneCell" | "absolute";
-    fromCol: number;
-    fromColOffset: number;
-    fromRow: number;
-    fromRowOffset: number;
-    toCol: number;
-    toColOffset: number;
-    toRow: number;
-    toRowOffset: number;
-}
-/** Kind-specific input accepted by Duke Sheets for form-control mutations. */
+interface XlsxFormControlCaptionRun {
+    font?: XlsxCellFontStyleInput;
+    text: string;
+}
+interface XlsxFormControlCaption {
+    horizontalAlignment?: "general" | "left" | "center" | "right" | "fill" | "justify" | "centerContinuous" | "distributed";
+    runs: XlsxFormControlCaptionRun[];
+    verticalAlignment?: "top" | "center" | "bottom" | "justify" | "distributed";
+}
+type XlsxFormControlCaptionInput = string | XlsxFormControlCaption;
 type XlsxFormControlKindInput = {
     kind: "button";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
 } | {
     kind: "checkbox";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
     state: XlsxFormControlState;
     cellLink?: string;
-    no3D: boolean;
+    no3D?: boolean;
 } | {
     kind: "optionButton";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
     state: Exclude<XlsxFormControlState, "mixed">;
     cellLink?: string;
-    firstInGroup?: boolean;
-    no3D: boolean;
+    no3D?: boolean;
 } | {
     kind: "label";
-    caption: string;
+    caption: XlsxFormControlCaptionInput;
 } | {
     kind: "groupBox";
-    caption: string;
-    no3D: boolean;
+    caption: XlsxFormControlCaptionInput;
+    no3D?: boolean;
 } | {
     kind: "listBox";
     inputRange?: string;
     cellLink?: string;
     selection: XlsxFormControlSelectionMode;
-    selected: number[];
-    no3D: boolean;
+    selected?: number[];
+    no3D?: boolean;
 } | {
     kind: "dropdown";
     inputRange?: string;
     cellLink?: string;
     selected?: number;
     lines: number;
-    no3D: boolean;
+    no3D?: boolean;
+} | {
+    kind: "editbox";
+    caption: XlsxFormControlCaptionInput;
+    legacyObjectType?: number;
+    rawObj?: Uint8Array | number[];
+    rawProperties?: Array<[string, string]>;
 } | {
     kind: "scrollbar";
     value: number;
@@ -498,7 +500,7 @@ type XlsxFormControlKindInput = {
     max: number;
     increment: number;
     page: number;
-    horizontal: boolean;
+    horizontal?: boolean;
     cellLink?: string;
 } | {
     kind: "spinner";
@@ -507,30 +509,51 @@ type XlsxFormControlKindInput = {
     max: number;
     increment: number;
     cellLink?: string;
+} | {
+    kind: "unknown";
+    objectType: string;
+    legacyObjectType?: number;
+    caption?: XlsxFormControlCaptionInput;
+    rawObj?: Uint8Array | number[];
+    rawProperties?: Array<[string, string]>;
 };
-/** Complete Duke Sheets input for adding a worksheet form control. */
-interface XlsxFormControlInput {
-    anchor: XlsxFormControlAnchor;
+interface XlsxFormControlMetadataInput {
+    altText?: string;
+    hidden?: boolean;
     kind: XlsxFormControlKindInput;
     locked?: boolean;
+    macroName?: string;
     name?: string;
     printable?: boolean;
+    rawClientData?: Array<Uint8Array | number[]>;
+    title?: string;
 }
-/** Partial Duke Sheets input for changing an existing worksheet form control. */
-type XlsxFormControlPatch = Partial<Omit<XlsxFormControlInput, "kind">> & {
+type XlsxFormControlInput = XlsxFormControlMetadataInput & ({
+    anchor: Extract<XlsxImageAnchor, {
+        kind: "two-cell";
+    }>;
+    editAs?: "twoCell" | "oneCell" | "absolute";
+} | {
+    anchor: Exclude<XlsxImageAnchor, {
+        kind: "two-cell";
+    }>;
+    editAs?: never;
+});
+type XlsxFormControlPatch = Partial<Omit<XlsxFormControlMetadataInput, "kind">> & {
+    anchor?: XlsxImageAnchor;
+    editAs?: "twoCell" | "oneCell" | "absolute";
     kind?: XlsxFormControlKindInput;
 };
 interface XlsxFormControl {
     anchor: XlsxImageAnchor;
-    /** Original Excel caption reported by Duke Sheets. */
-    caption?: string;
+    altText?: string;
+    /** Original rich caption reported by Duke Sheets. */
+    caption?: XlsxFormControlCaption;
     checked?: boolean;
     /** Duke Sheets' stable zero-based index for this worksheet load. */
     controlIndex?: number;
-    /** Original anchor behavior when Duke has flattened the anchor to two-cell coordinates. */
+    /** Original two-cell anchor behavior. */
     editAs?: "twoCell" | "oneCell" | "absolute";
-    /** Exact Duke Sheets anchor. Use this when cloning or updating the control through the controller. */
-    dukeAnchor?: XlsxFormControlAnchor;
     firstInGroup?: boolean;
     fontFamily?: string;
     fontSizePt?: number;
@@ -546,12 +569,18 @@ interface XlsxFormControl {
     lines?: number;
     linkedCell?: string;
     locked?: boolean;
+    macroName?: string;
     max?: number;
     min?: number;
     name?: string;
     no3D?: boolean;
     page?: number;
     printable?: boolean;
+    objectType?: string;
+    legacyObjectType?: number;
+    rawClientData?: number[][];
+    rawObj?: number[];
+    rawProperties?: Array<[string, string]>;
     /** Zero-based selected item index or indexes, matching Duke Sheets. */
     selected?: number | number[];
     selection?: XlsxFormControlSelectionMode;
@@ -559,6 +588,7 @@ interface XlsxFormControl {
     state?: XlsxFormControlState;
     textAlign?: "center" | "left" | "right";
     textColor?: string;
+    title?: string;
     value?: number;
     workbookSheetIndex: number;
     zIndex: number;
@@ -1600,4 +1630,4 @@ declare function useXlsxViewerThumbnails(options?: UseXlsxViewerThumbnailsOption
 declare function XlsxViewer(props: XlsxViewerProps): react_jsx_runtime.JSX.Element;
 declare function DefaultXlsxToolbar(): react_jsx_runtime.JSX.Element;
 
-export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, 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, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlAnchor, 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 };
+export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, 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, 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 };