@office-kit/xlsx 0.8.0

package/dist/worksheet/conditional-formatting.d.ts

@@ -0,0 +1,150 @@
+import { type MultiCellRange } from './cell-range';
+export type ConditionalFormattingRuleType = 'expression' | 'cellIs' | 'colorScale' | 'dataBar' | 'iconSet' | 'top10' | 'aboveAverage' | 'uniqueValues' | 'duplicateValues' | 'containsText' | 'notContainsText' | 'beginsWith' | 'endsWith' | 'containsBlanks' | 'notContainsBlanks' | 'containsErrors' | 'notContainsErrors' | 'timePeriod';
+export type CellIsOperator = 'lessThan' | 'lessThanOrEqual' | 'equal' | 'notEqual' | 'greaterThanOrEqual' | 'greaterThan' | 'between' | 'notBetween';
+export type TextOperator = 'containsText' | 'notContains' | 'beginsWith' | 'endsWith';
+export type TimePeriod = 'today' | 'yesterday' | 'tomorrow' | 'last7Days' | 'thisMonth' | 'lastMonth' | 'nextMonth' | 'thisWeek' | 'lastWeek' | 'nextWeek';
+export interface ConditionalFormattingRule {
+    /** Wire-level rule kind. */
+    type: ConditionalFormattingRuleType;
+    /** 1-based priority — Excel evaluates lower priority first. */
+    priority: number;
+    /** Index into Stylesheet.dxfs for the cell-format applied when the rule fires. */
+    dxfId?: number;
+    /** Stop evaluating subsequent rules on the same cell when this rule matches. */
+    stopIfTrue?: boolean;
+    /** cellIs operator. */
+    operator?: CellIsOperator | TextOperator | string;
+    /** Comparison string for the contains-text family. */
+    text?: string;
+    /** top10: rank percentage flag. */
+    percent?: boolean;
+    /** top10: bottom-N flag (false = top-N, true = bottom-N). */
+    bottom?: boolean;
+    /** top10: rank value (defaults to 10). */
+    rank?: number;
+    /** aboveAverage: aboveAverage="0" → below average. */
+    aboveAverage?: boolean;
+    /** aboveAverage: equalAverage flag. */
+    equalAverage?: boolean;
+    /** aboveAverage: stdDev. */
+    stdDev?: number;
+    /** timePeriod token. */
+    timePeriod?: TimePeriod;
+    /** 0..3 formula strings — varies by rule type. */
+    formulas: string[];
+    /**
+     * Raw inner XML for colorScale / dataBar / iconSet rules. Stage-1 stores the
+     * verbatim child markup so saves round-trip without our needing to model cfvo
+     * / colors / iconSets fully.
+     */
+    innerXml?: string;
+}
+export interface ConditionalFormatting {
+    sqref: MultiCellRange;
+    rules: ConditionalFormattingRule[];
+    pivot?: boolean;
+}
+export declare function makeConditionalFormatting(opts: {
+    sqref: MultiCellRange | string;
+    rules?: ConditionalFormattingRule[];
+    pivot?: boolean;
+}): ConditionalFormatting;
+export declare function makeCfRule(opts: Partial<ConditionalFormattingRule> & {
+    type: ConditionalFormattingRuleType;
+    priority: number;
+}): ConditionalFormattingRule;
+import type { Worksheet } from './worksheet';
+/**
+ * "If cell value [op] formula → apply dxf". Mirrors Excel's "Highlight Cell
+ * Rules → ..." UI.
+ */
+export declare const addCellIsRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    operator: CellIsOperator;
+    formula1: string;
+    formula2?: string;
+    dxfId?: number;
+    stopIfTrue?: boolean;
+    priority?: number;
+}) => ConditionalFormattingRule;
+/** Top-N or bottom-N rule. `bottom: true` → bottom-N. `percent: true` → percentile. */
+export declare const addTopNRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    rank?: number;
+    bottom?: boolean;
+    percent?: boolean;
+    dxfId?: number;
+    priority?: number;
+}) => ConditionalFormattingRule;
+/** Above/below-average rule. `aboveAverage: false` → below-average; provide `stdDev` for ±N stddev. */
+export declare const addAverageRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    aboveAverage?: boolean;
+    equalAverage?: boolean;
+    stdDev?: number;
+    dxfId?: number;
+    priority?: number;
+}) => ConditionalFormattingRule;
+/** Duplicate-values rule (each cell whose value appears more than once gets the dxf). */
+export declare const addDuplicateValuesRule: (ws: Worksheet, sqref: MultiCellRange | string, opts?: {
+    dxfId?: number;
+    priority?: number;
+    unique?: boolean;
+}) => ConditionalFormattingRule;
+/** Free-form formula rule — any `=ISNUMBER(A1)`-style boolean expression. */
+export declare const addFormulaRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    formula: string;
+    dxfId?: number;
+    stopIfTrue?: boolean;
+    priority?: number;
+}) => ConditionalFormattingRule;
+/** Text-based rule (containsText / notContains / beginsWith / endsWith). */
+export declare const addTextRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    operator: TextOperator;
+    text: string;
+    dxfId?: number;
+    priority?: number;
+}) => ConditionalFormattingRule;
+export type CfvoType = 'min' | 'max' | 'num' | 'percent' | 'percentile' | 'formula';
+export interface Cfvo {
+    type: CfvoType;
+    /** Required for num / percent / percentile / formula; ignored for min / max. */
+    val?: string;
+}
+export type IconSetStyle = '3Arrows' | '3ArrowsGray' | '3Flags' | '3Signs' | '3Symbols' | '3Symbols2' | '3TrafficLights1' | '3TrafficLights2' | '4Arrows' | '4ArrowsGray' | '4Rating' | '4RedToBlack' | '4TrafficLights' | '5Arrows' | '5ArrowsGray' | '5Quarters' | '5Rating';
+/**
+ * Color-scale rule — gradient between 2 or 3 reference points. Each cfvo pairs
+ * with one color.
+ */
+export declare const addColorScaleRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    cfvos: ReadonlyArray<Cfvo>;
+    /** Hex strings, e.g. `'FFFF0000'`; one per cfvo. */
+    colors: ReadonlyArray<string>;
+    priority?: number;
+    stopIfTrue?: boolean;
+}) => ConditionalFormattingRule;
+/**
+ * Data-bar rule — a gradient bar inside each cell sized to the value. Defaults
+ * to `min`/`max` cfvos so the bar spans the visible range.
+ */
+export declare const addDataBarRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    color: string;
+    minCfvo?: Cfvo;
+    maxCfvo?: Cfvo;
+    minLength?: number;
+    maxLength?: number;
+    showValue?: boolean;
+    priority?: number;
+    stopIfTrue?: boolean;
+}) => ConditionalFormattingRule;
+/**
+ * Icon-set rule — visual icons (arrows / lights / flags) drawn next to each
+ * cell value. The number of cfvos depends on the icon set (3 for `3Arrows`, 4
+ * for `4Arrows`, 5 for `5Arrows`, etc).
+ */
+export declare const addIconSetRule: (ws: Worksheet, sqref: MultiCellRange | string, opts: {
+    iconSet: IconSetStyle | string;
+    cfvos: ReadonlyArray<Cfvo>;
+    reverse?: boolean;
+    showValue?: boolean;
+    percent?: boolean;
+    priority?: number;
+    stopIfTrue?: boolean;
+}) => ConditionalFormattingRule;

package/dist/worksheet/custom-sheet-views.d.ts

@@ -0,0 +1,43 @@
+import type { HeaderFooter, PageBreak, PageMargins, PageSetup, PrintOptions } from './page-setup';
+import type { Pane, Selection, SheetViewMode } from './views';
+export type CustomSheetViewState = 'visible' | 'hidden' | 'veryHidden';
+export interface CustomSheetView {
+    guid: string;
+    scale?: number;
+    /** 0..64 (legacy palette index) */
+    colorId?: number;
+    showPageBreaks?: boolean;
+    showFormulas?: boolean;
+    showGridLines?: boolean;
+    showRowCol?: boolean;
+    outlineSymbols?: boolean;
+    zeroValues?: boolean;
+    fitToPage?: boolean;
+    /** Print only the print-area selection on this saved view. */
+    printArea?: boolean;
+    /** AutoFilter is active in this saved view. */
+    filter?: boolean;
+    showAutoFilter?: boolean;
+    /** Hidden rows persist for this saved view. */
+    hiddenRows?: boolean;
+    hiddenColumns?: boolean;
+    state?: CustomSheetViewState;
+    filterUnique?: boolean;
+    view?: SheetViewMode;
+    showRuler?: boolean;
+    /** Top-left cell ref shown when this view is restored. */
+    topLeftCell?: string;
+    /** Inner pane split / freeze. */
+    pane?: Pane;
+    /** Selection state for this view (one entry per pane). */
+    selections?: Selection[];
+    rowBreaks?: PageBreak[];
+    colBreaks?: PageBreak[];
+    pageMargins?: PageMargins;
+    printOptions?: PrintOptions;
+    pageSetup?: PageSetup;
+    headerFooter?: HeaderFooter;
+}
+export declare const makeCustomSheetView: (opts: Partial<CustomSheetView> & {
+    guid: string;
+}) => CustomSheetView;

package/dist/worksheet/data-consolidate.d.ts

@@ -0,0 +1,29 @@
+export type DataConsolidateFunction = 'average' | 'count' | 'countNums' | 'max' | 'min' | 'product' | 'stdDev' | 'stdDevp' | 'sum' | 'var' | 'varp';
+export interface DataReference {
+    /** Optional name of the source range (defined-name reference). */
+    name?: string;
+    /** External range ref like "Sheet1!$A$1:$B$10" — required when no `rId`. */
+    ref?: string;
+    /** Optional friendly sheet name for display. */
+    sheet?: string;
+    /** rels rId pointing at an external workbook part — round-tripped verbatim. */
+    rId?: string;
+}
+export interface DataConsolidate {
+    /** Aggregation function applied to overlapping cells. Default `sum`. */
+    function?: DataConsolidateFunction;
+    /** Use top-row labels as category keys. */
+    topLabels?: boolean;
+    /** Use left-column labels as category keys. */
+    leftLabels?: boolean;
+    /** "Create links to source data" (Excel's checkbox). */
+    link?: boolean;
+    /** Optional `<dataRefs>` list (one entry per source range). */
+    dataRefs?: DataReference[];
+    /**
+     * `startLabels` was added in a later schema revision — round-tripped
+     * verbatim when present.
+     */
+    startLabels?: string;
+}
+export declare const makeDataConsolidate: (opts?: DataConsolidate) => DataConsolidate;

package/dist/worksheet/data-validations.d.ts

@@ -0,0 +1,72 @@
+import { type MultiCellRange } from './cell-range';
+export type DataValidationType = 'whole' | 'decimal' | 'list' | 'date' | 'time' | 'textLength' | 'custom';
+export type DataValidationOperator = 'between' | 'notBetween' | 'equal' | 'notEqual' | 'greaterThan' | 'greaterThanOrEqual' | 'lessThan' | 'lessThanOrEqual';
+export type DataValidationErrorStyle = 'stop' | 'warning' | 'information';
+export interface DataValidation {
+    /** Constraint kind. `'list'` is the dropdown form (formula1 = comma list or range). */
+    type: DataValidationType;
+    /** Comparison operator — only meaningful for whole/decimal/date/time/textLength. */
+    operator?: DataValidationOperator;
+    /** Lower-bound formula or list source. Always required for list/whole/decimal/date/time. */
+    formula1?: string;
+    /** Upper-bound formula. Used by between / notBetween only. */
+    formula2?: string;
+    /** Allow empty cells. */
+    allowBlank?: boolean;
+    /** Show the input message popover when the cell is selected. */
+    showInputMessage?: boolean;
+    /** Show the error message popover on invalid entry. */
+    showErrorMessage?: boolean;
+    errorTitle?: string;
+    error?: string;
+    errorStyle?: DataValidationErrorStyle;
+    promptTitle?: string;
+    prompt?: string;
+    /** Excel inverts this attribute: `showDropDown="1"` actually *hides* the dropdown arrow on list-type validators. We mirror the wire form. */
+    showDropDown?: boolean;
+    /** Apply-to range (sqref). */
+    sqref: MultiCellRange;
+}
+export declare function makeDataValidation(opts: Omit<Partial<DataValidation>, 'sqref'> & {
+    type: DataValidationType;
+    sqref: MultiCellRange | string;
+}): DataValidation;
+import type { Worksheet } from './worksheet';
+export interface ValidationCommon {
+    /** Show the dropdown / input prompt when the cell is selected. */
+    prompt?: string;
+    promptTitle?: string;
+    /** Show an error dialog when the user types an invalid value. */
+    error?: string;
+    errorTitle?: string;
+    errorStyle?: DataValidationErrorStyle;
+    allowBlank?: boolean;
+}
+/**
+ * Add a list-type dropdown validation to a range. `values` may be an inline
+ * list (`['Red', 'Green', 'Blue']`) or a sheet reference
+ * (`'=Sheet1!$A$1:$A$10'`).
+ */
+export declare const addListValidation: (ws: Worksheet, sqref: MultiCellRange | string, values: ReadonlyArray<string> | string, opts?: ValidationCommon) => DataValidation;
+/**
+ * Add a number-range validation. `between(min, max)` matches Excel's "Whole
+ * Number" → "between" form by default. Use `kind: 'decimal'` for decimal
+ * (default 'whole').
+ */
+export declare const addNumberValidation: (ws: Worksheet, sqref: MultiCellRange | string, range: {
+    min: number;
+    max?: number;
+    operator?: DataValidationOperator;
+    kind?: "whole" | "decimal";
+}, opts?: ValidationCommon) => DataValidation;
+/**
+ * Add a date-range validation. Dates are passed as Excel serial numbers (use
+ * `dateToExcel` to convert from JS `Date`).
+ */
+export declare const addDateValidation: (ws: Worksheet, sqref: MultiCellRange | string, range: {
+    min: number;
+    max?: number;
+    operator?: DataValidationOperator;
+}, opts?: ValidationCommon) => DataValidation;
+/** Add a custom-formula validation (`formula1` evaluated for each cell). */
+export declare const addCustomValidation: (ws: Worksheet, sqref: MultiCellRange | string, formula: string, opts?: ValidationCommon) => DataValidation;

package/dist/worksheet/dimensions.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Single-column-or-range dimension entry. Mirrors the OOXML `<col>` element.
+ * The `min`/`max` pair always covers a contiguous run; the worksheet's
+ * `columnDimensions` Map keys by `min` so per-column edits stay O(log n).
+ */
+export interface ColumnDimension {
+    /** 1-based first column the entry covers (inclusive). */
+    min: number;
+    /** 1-based last column the entry covers (inclusive). */
+    max: number;
+    /** Width in Excel character units. */
+    width?: number;
+    /** Excel records `customWidth=1` whenever the user touched the slider. */
+    customWidth?: boolean;
+    /** Hidden columns get `hidden="1"`. */
+    hidden?: boolean;
+    /** "Best fit" auto-shrink semantics — Excel sets it for narrow columns. */
+    bestFit?: boolean;
+    /** Outline-level for grouping (0 = ungrouped). */
+    outlineLevel?: number;
+    /** Default cell xfId applied to empty cells in the column. */
+    style?: number;
+    /** Whether the column's outline is collapsed. */
+    collapsed?: boolean;
+}
+/** Per-row metadata. Mirrors the OOXML `<row>` element's attributes. */
+export interface RowDimension {
+    /** Row height in points. */
+    height?: number;
+    /** Mirrors Excel's `customHeight="1"` flag. */
+    customHeight?: boolean;
+    hidden?: boolean;
+    outlineLevel?: number;
+    collapsed?: boolean;
+    /** Default cell xfId applied to empty cells in the row. */
+    style?: number;
+}
+/** Build a single-column ColumnDimension entry covering `col`. */
+export declare function makeColumnDimension(col: number, opts?: Partial<Omit<ColumnDimension, 'min' | 'max'>>): ColumnDimension;
+export declare function makeRowDimension(opts?: Partial<RowDimension>): RowDimension;

package/dist/worksheet/errors.d.ts

@@ -0,0 +1,40 @@
+import type { MultiCellRange } from './cell-range';
+/**
+ * One Cell-Watch entry. The Watch Window in Excel (Formulas → Watch Window)
+ * shows live values for the cells listed here.
+ */
+export interface CellWatch {
+    /** Single-cell reference like "Sheet1!$A$1" — kept verbatim. */
+    ref: string;
+}
+/**
+ * One ignored-error entry. Each Boolean flag corresponds to a class of Excel's
+ * background validation; setting any of them to `true` suppresses the green
+ * triangle for cells in `sqref`.
+ */
+export interface IgnoredError {
+    /** Cells to which the suppressions apply. */
+    sqref: MultiCellRange;
+    /** "Formula evaluates to error" warning. */
+    evalError?: boolean;
+    /** "Date stored as 2-digit year" warning. */
+    twoDigitTextYear?: boolean;
+    /** "Number stored as text" warning. */
+    numberStoredAsText?: boolean;
+    /** "Inconsistent formula" warning. */
+    formula?: boolean;
+    /** "Formula omits cells" warning. */
+    formulaRange?: boolean;
+    /** "Unlocked cells containing formulas" warning. */
+    unlockedFormula?: boolean;
+    /** "Empty cells referenced" warning. */
+    emptyCellReference?: boolean;
+    /** "Data validation list error" warning. */
+    listDataValidation?: boolean;
+    /** "Inconsistent calculated column" warning (Excel Tables). */
+    calculatedColumn?: boolean;
+}
+export declare const makeCellWatch: (ref: string) => CellWatch;
+export declare function makeIgnoredError(opts: Partial<IgnoredError> & {
+    sqref: MultiCellRange;
+}): IgnoredError;

package/dist/worksheet/hyperlinks.d.ts

@@ -0,0 +1,42 @@
+export interface Hyperlink {
+    /** Cell or range the hyperlink covers — "A1" or "A1:B5". */
+    ref: string;
+    /** External URL or relative target path. Mutually exclusive with `location`-only links. */
+    target?: string;
+    /** Anchor inside the workbook (e.g. `'Sheet 2'!A1`). */
+    location?: string;
+    /** Tooltip shown on hover. */
+    tooltip?: string;
+    /** Visible link text — typically falls back to the referenced cell value. */
+    display?: string;
+    /** Worksheet-rels rId. Populated on read; assigned by the writer when missing. */
+    rId?: string;
+}
+export declare function makeHyperlink(opts: Partial<Hyperlink> & {
+    ref: string;
+}): Hyperlink;
+import type { Worksheet } from './worksheet';
+/**
+ * Add an external URL hyperlink to a cell or range. The URL goes into the
+ * worksheet rels as a hyperlink relationship; the writer generates an rId on
+ * save.
+ */
+export declare const addUrlHyperlink: (ws: Worksheet, ref: string, url: string, opts?: {
+    tooltip?: string;
+    display?: string;
+}) => Hyperlink;
+/**
+ * Add an in-workbook jump hyperlink (e.g. to `'Sheet2'!A1` or a defined-name).
+ * No rels entry is written — the location is inline in the `<hyperlink
+ * location="…"/>` attribute.
+ */
+export declare const addInternalHyperlink: (ws: Worksheet, ref: string, location: string, opts?: {
+    tooltip?: string;
+    display?: string;
+}) => Hyperlink;
+/** `mailto:` shortcut. */
+export declare const addMailtoHyperlink: (ws: Worksheet, ref: string, email: string, opts?: {
+    subject?: string;
+    tooltip?: string;
+    display?: string;
+}) => Hyperlink;

package/dist/worksheet/index.d.ts

@@ -0,0 +1,46 @@
+export type { CellsByKindCounts, IterRowsOptions, Worksheet, } from './worksheet';
+export { addCellWatch, addConditionalFormatting, addDataValidation, addIgnoredError, addTable, appendRow, appendRows, applyToRange, autofitColumns, clearAllCells, clearRange, collapseColumnGroup, collapseRowGroup, copyRange, countCells, countCellsByKind, deleteCell, expandColumnGroup, expandRowGroup, findCells, freezePanes, getAutoFilter, getCell, getCellByCoord, getCellsInColumn, getCellsInRange, getCellsInRow, getColumnDimension, getDataExtent, getFreezePanes, getMaxCol, getMaxRow, getMergedCells, getMergedRangeAt, getNonEmptyCellCount, getPopulatedColumnIndices, getPopulatedRowIndices, getRangeValues, getRowDimension, getTable, groupColumns, groupRows, hideColumn, hideColumns, hideRow, hideRows, isMergedCell, isWorksheetEmpty, iterCells, iterRows, iterValues, listComments, listDataValidations, listHyperlinks, listTables, makeWorksheet, mergeCells, moveRange, removeAllComments, removeAllConditionalFormatting, removeAllDataValidations, removeAllHyperlinks, removeAllMergedRanges, removeAllTables, removeCellWatches, removeDataValidations, removeHyperlink, removeIgnoredErrors, removeTable, setAutoFilter, setCell, setCellByCoord, setColumnDimension, setColumnWidth, setColumnWidths, setComment, setDefaultColumnWidth, setDefaultRowHeight, setFreezePanes, setHyperlink, setRangeValues, setRowDimension, setRowHeight, setRowHeights, setSheetTabColor, setSheetViewMode, setSheetZoom, ungroupColumns, ungroupRows, unhideColumn, unhideColumns, unhideRow, unhideRows, unmergeCells, unmergeCellsAt, writeRange, } from './worksheet';
+export type { MultiCellRange } from './cell-range';
+export { expandRangeStr, intersectionRange, isCellInRange, isRangeInRange, rangeArea, rangeContainsCell, rangeContainsRange, rangesOverlap, shiftRange, unionRange, } from './cell-range';
+export type { ColumnDimension, RowDimension } from './dimensions';
+export { makeColumnDimension, makeRowDimension } from './dimensions';
+export type { Pane, PaneState, PaneType, Selection, SheetView, SheetViewMode, } from './views';
+export { freezePaneRef, makeFreezePane, makeSheetView } from './views';
+export type { LegacyComment } from './comments';
+export { makeLegacyComment } from './comments';
+export type { DataValidation, DataValidationErrorStyle, DataValidationOperator, DataValidationType, ValidationCommon, } from './data-validations';
+export { makeDataValidation } from './data-validations';
+export type { CellIsOperator, Cfvo, CfvoType, ConditionalFormatting, ConditionalFormattingRule, ConditionalFormattingRuleType, IconSetStyle, TextOperator, TimePeriod, } from './conditional-formatting';
+export { makeCfRule, makeConditionalFormatting } from './conditional-formatting';
+export type { Hyperlink } from './hyperlinks';
+export { makeHyperlink } from './hyperlinks';
+export type { AutoFilter, FilterColumn } from './auto-filter';
+export { makeAutoFilter, makeFilterColumn } from './auto-filter';
+export type { TableColumn, TableDefinition, TableStyleInfo } from './table';
+export { addExcelTable, makeTableColumn, makeTableDefinition } from './table';
+export type { CellWatch, IgnoredError } from './errors';
+export { makeCellWatch, makeIgnoredError } from './errors';
+export type { OutlineProperties, PageSetupProperties, SheetProperties } from './properties';
+export { makeSheetProperties } from './properties';
+export type { SheetProtection } from './protection';
+export { makeSheetProtection } from './protection';
+export type { ProtectedRange } from './protected-ranges';
+export { makeProtectedRange } from './protected-ranges';
+export type { SortBy, SortCondition, SortIconSet, SortMethod, SortState, } from './sort-state';
+export { makeSortCondition, makeSortState } from './sort-state';
+export type { CellSmartTag, CellSmartTagProperty, CellSmartTags, } from './smart-tags';
+export { makeCellSmartTag, makeCellSmartTagProperty, makeCellSmartTags, } from './smart-tags';
+export type { FormControl, OleDvAspect, OleObject, OleUpdateMode, } from './ole-objects';
+export { makeFormControl, makeOleObject } from './ole-objects';
+export type { CustomSheetView, CustomSheetViewState } from './custom-sheet-views';
+export { makeCustomSheetView } from './custom-sheet-views';
+export type { CellCommentMode, HeaderFooter, HeaderFooterSection, PageBreak, PageMargins, PageOrder, PageOrientation, PageSetup, PrintErrorMode, PrintOptions, } from './page-setup';
+export { buildHeaderFooterText, HEADER_FOOTER_CODES, makeHeaderFooter, makePageBreak, makePageMargins, makePageSetup, makePrintOptions, } from './page-setup';
+export type { WebPublishItem, WorksheetCustomProperty } from './web-publish';
+export { makeWebPublishItem, makeWorksheetCustomProperty } from './web-publish';
+export type { PhoneticAlignment, PhoneticType, WorksheetPhoneticProperties, } from './phonetic';
+export { makeWorksheetPhoneticProperties } from './phonetic';
+export type { DataConsolidate, DataConsolidateFunction, DataReference, } from './data-consolidate';
+export { makeDataConsolidate } from './data-consolidate';
+export type { Scenario, ScenarioInputCell, ScenarioList } from './scenarios';
+export { makeScenario, makeScenarioInputCell, makeScenarioList } from './scenarios';

package/dist/worksheet/ole-objects.d.ts

@@ -0,0 +1,37 @@
+import type { XmlNode } from '../xml/tree';
+export type OleDvAspect = 'DVASPECT_CONTENT' | 'DVASPECT_ICON';
+export type OleUpdateMode = 'OLEUPDATE_ALWAYS' | 'OLEUPDATE_ONCALL';
+export interface OleObject {
+    /** Unique shape id assigned by Excel — required. */
+    shapeId: number;
+    /** rels link to the embedded OLE blob. */
+    rId?: string;
+    progId?: string;
+    dvAspect?: OleDvAspect;
+    link?: string;
+    oleUpdate?: OleUpdateMode;
+    autoLoad?: boolean;
+    /**
+     * Optional `<objectPr>` child preserved verbatim. Modeling its
+     * `<anchor>` schema in detail is deferred — this preserves the
+     * round-trip without re-deriving the anchor attrs.
+     */
+    objectPr?: XmlNode;
+}
+export interface FormControl {
+    shapeId: number;
+    rId?: string;
+    /** ECMA-376 §18.3.1.27 — name shown in the form-control name box. */
+    name?: string;
+    /**
+     * Optional `<controlPr>` child preserved verbatim (similar to
+     * `objectPr` for OLE objects).
+     */
+    controlPr?: XmlNode;
+}
+export declare const makeOleObject: (opts: Partial<OleObject> & {
+    shapeId: number;
+}) => OleObject;
+export declare const makeFormControl: (opts: Partial<FormControl> & {
+    shapeId: number;
+}) => FormControl;