ooxml-ui 0.27.2 → 0.28.0

package/dist/xlsx/dialogs/go-to.d.ts

@@ -0,0 +1,12 @@
+import { type CellRange } from 'ooxml-core/xlsx';
+import { type SpecialKind } from 'ooxml-core/xlsx/ui';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+/** Selects a range on a sheet, switching sheets when needed. */
+export declare function selectOn(ctx: EditorContext, sheet: number, range: CellRange): void;
+/** Resolves `A1`, `A1:B2`, `Sheet!A1`, `'My Sheet'!$A$1` or a defined name to a sheet and range. */
+export declare function resolveReference(ctx: EditorContext, input: string, depth?: number): {
+    sheet: number;
+    range: CellRange;
+} | undefined;
+export declare function openGoTo(ctx: EditorContext): Promise<string | undefined>;
+export declare function openGoToSpecial(ctx: EditorContext): Promise<SpecialKind | undefined>;

package/dist/xlsx/dialogs/help-dialogs.d.ts

@@ -0,0 +1,5 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function openShortcutHelp(ctx: EditorContext): Promise<undefined>;
+export declare const SUPPORTED_FEATURES: readonly ['Cell editing with undo and redo', 'Formulas calculated by the built-in calculation engine', 'Number formats', 'Conditional formatting display', 'Tables', 'Charts (display and basic editing)', 'Comments and notes', 'Hyperlinks', 'Data validation', 'Sort and filter', 'Freeze panes'];
+export declare const UNSUPPORTED_FEATURES: readonly ['Pivot tables and sparklines (kept in the file but not shown)', 'Show Formulas', 'Manual calculation', 'Outline (grouping) for columns', 'Password protection hashes', 'Editing threaded comment replies', 'Macros (VBA is kept in the file but never run)', 'Changing the workbook theme', 'Page Layout view'];
+export declare function openFeatureStatus(ctx: EditorContext): Promise<undefined>;

package/dist/xlsx/dialogs/host.d.ts

@@ -0,0 +1,6 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+/**
+ * The dialog host: the element in the shadow root dialogs append their `office-ui-dialog` to, so
+ * dialog code does not need to know the shell layout.
+ */
+export declare function dialogHost(ctx: EditorContext): HTMLElement;

package/dist/xlsx/dialogs/hyperlink.d.ts

@@ -0,0 +1,16 @@
+import { type Hyperlink } from 'ooxml-core/xlsx';
+import { type HyperlinkRejection } from 'ooxml-core/opc';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+/** The English message shown when the policy refuses to store an address, by reason. */
+export declare const HYPERLINK_REJECTIONS: Readonly<Record<HyperlinkRejection, string>>;
+/**
+ * The address to store (`www.` gains `https://`), or the reason it may not be stored
+ * (javascript:, data:, a disguised scheme, ...).
+ */
+export declare function checkAddress(text: string): {
+    href: string;
+} | {
+    reason: HyperlinkRejection;
+};
+export declare function safeAddress(text: string): string | undefined;
+export declare function hyperlinkDialog(ctx: EditorContext): Promise<Omit<Hyperlink, 'range'> | null | undefined>;

package/dist/xlsx/dialogs/index.d.ts

@@ -0,0 +1,2 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function registerDialogs(ctx: EditorContext): void;

package/dist/xlsx/dialogs/insert-chart.d.ts

@@ -0,0 +1,7 @@
+import { type ChartObject, type ChartType } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface InsertChartProps {
+    type?: ChartType;
+    change?: boolean;
+}
+export declare function openInsertChart(ctx: EditorContext, props?: InsertChartProps): Promise<ChartObject | undefined>;

package/dist/xlsx/dialogs/insert-function.d.ts

@@ -0,0 +1,10 @@
+import { type FunctionInfo } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface InsertFunctionProps {
+    category?: string;
+    fn?: string;
+}
+export declare const FUNCTION_CATEGORIES: () => string[];
+/** Functions matching a search (name first, then description words), like Excel's Go. */
+export declare function searchFunctions(query: string): FunctionInfo[];
+export declare function openInsertFunction(ctx: EditorContext, props?: InsertFunctionProps): Promise<string | undefined>;

package/dist/xlsx/dialogs/move-copy-sheet.d.ts

@@ -0,0 +1,5 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare const END = "end";
+/** The index a sheet ends up at when moved before `before` (sheet count = move to end). */
+export declare function moveTarget(from: number, before: number): number;
+export declare function openMoveCopySheet(ctx: EditorContext): Promise<number | undefined>;

package/dist/xlsx/dialogs/name-manager.d.ts

@@ -0,0 +1,9 @@
+import { type DefinedName } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+/** A name's current value as the Name Manager shows it (errors as `#REF!` etc.). */
+export declare function nameValue(ctx: EditorContext, name: DefinedName): {
+    text: string;
+    error: boolean;
+};
+export declare const visibleNames: (names: readonly DefinedName[]) => DefinedName[];
+export declare function openNameManager(ctx: EditorContext): Promise<undefined>;

package/dist/xlsx/dialogs/package-password.d.ts

@@ -0,0 +1,3 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+/** Passwords stay in memory for the current workbook and are never persisted in settings. */
+export declare function packagePassword(ctx: EditorContext, saving?: boolean): Promise<string | undefined>;

package/dist/xlsx/dialogs/page-setup-tabs.d.ts

@@ -0,0 +1,23 @@
+import { type PageSetup, type Worksheet } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface SetupTab {
+    panel: HTMLElement;
+    read(): Partial<PageSetup> | string;
+}
+/** Header / footer text without SpreadsheetML section codes (`&L`, `&C`, `&R`). */
+export declare const plainHeader: (value: string | undefined) => string;
+export declare function pageTab(ctx: EditorContext, setup: PageSetup): SetupTab;
+export interface MarginsTab extends SetupTab {
+    /** Center on page: horizontally and vertically. */
+    centered(): {
+        horizontalCentered: boolean;
+        verticalCentered: boolean;
+    };
+}
+export declare function marginsTab(ctx: EditorContext, setup: PageSetup, ws: Worksheet): MarginsTab;
+export declare function headerTab(ctx: EditorContext, setup: PageSetup): SetupTab;
+export interface SheetTab extends SetupTab {
+    gridlines(): boolean;
+    headings(): boolean;
+}
+export declare function sheetTab(ctx: EditorContext, setup: PageSetup, ws: Worksheet): SheetTab;

package/dist/xlsx/dialogs/page-setup.d.ts

@@ -0,0 +1,6 @@
+import type { PageSetup } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface PageSetupProps {
+    tab?: 'page' | 'margins' | 'header' | 'sheet';
+}
+export declare function openPageSetup(ctx: EditorContext, props?: PageSetupProps): Promise<Partial<PageSetup> | undefined>;

package/dist/xlsx/dialogs/paste-special.d.ts

@@ -0,0 +1,3 @@
+import type { PasteMode } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function openPasteSpecial(ctx: EditorContext): Promise<PasteMode | undefined>;

package/dist/xlsx/dialogs/prompts.d.ts

@@ -0,0 +1,42 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface ConfirmProps {
+    heading: string;
+    message: string;
+    okLabel?: string;
+    vars?: Record<string, string | number>;
+}
+/** Resolves true when confirmed. */
+export declare function confirmDialog(ctx: EditorContext, props: ConfirmProps): Promise<boolean | undefined>;
+export interface TextPromptProps {
+    name: string;
+    heading: string;
+    label: string;
+    value: string;
+    note?: string;
+    multiline?: boolean;
+    /** Returns an English error message, or undefined when the text is acceptable. */
+    validate?(value: string): string | undefined;
+    apply(value: string): void;
+}
+export declare function textPrompt(ctx: EditorContext, props: TextPromptProps): Promise<string | undefined>;
+export interface NumberPromptProps {
+    name: string;
+    heading: string;
+    label: string;
+    value: number;
+    min: number;
+    max: number;
+    step?: number;
+    apply(value: number): void;
+}
+export declare function numberPrompt(ctx: EditorContext, props: NumberPromptProps): Promise<number | undefined>;
+export interface PickProps {
+    name: string;
+    heading: string;
+    label: string;
+    items: ReadonlyArray<readonly [value: string, label: string]>;
+    okLabel?: string;
+    apply(value: string): void;
+}
+/** A list picker (Unhide sheet, Paste Name). */
+export declare function pickDialog(ctx: EditorContext, props: PickProps): Promise<string | undefined>;

package/dist/xlsx/dialogs/protect-sheet.d.ts

@@ -0,0 +1,8 @@
+import { type SheetProtection } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare const PROTECT_ACTIONS: ReadonlyArray<readonly [allow: string, label: string, on: boolean]>;
+export declare function openProtectSheet(ctx: EditorContext): Promise<SheetProtection | undefined>;
+/** Review > Unprotect Sheet: asks for the password when the sheet has one. */
+export declare function unprotectSheet(ctx: EditorContext): Promise<boolean>;
+/** Review > Protect Workbook: locks the structure with an optional password, or unlocks it. */
+export declare function toggleWorkbookProtection(ctx: EditorContext): Promise<boolean>;

package/dist/xlsx/dialogs/register-navigation.d.ts

@@ -0,0 +1,2 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function registerNavigationDialogs(ctx: EditorContext): void;

package/dist/xlsx/dialogs/register-rules.d.ts

@@ -0,0 +1,2 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function registerRuleDialogs(ctx: EditorContext): void;

package/dist/xlsx/dialogs/register-tools.d.ts

@@ -0,0 +1,2 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function registerToolDialogs(ctx: EditorContext): void;

package/dist/xlsx/dialogs/remove-duplicates.d.ts

@@ -0,0 +1,2 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function openRemoveDuplicates(ctx: EditorContext): Promise<number | undefined>;

package/dist/xlsx/dialogs/simple.d.ts

@@ -0,0 +1,2 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function registerSimpleDialogs(ctx: EditorContext): void;

package/dist/xlsx/dialogs/sort-dialog.d.ts

@@ -0,0 +1,6 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface SortKeySpec {
+    col: number;
+    descending: boolean;
+}
+export declare function sortDialog(ctx: EditorContext): Promise<SortKeySpec[] | undefined>;

package/dist/xlsx/dialogs/statistics.d.ts

@@ -0,0 +1,12 @@
+import { type Worksheet } from 'ooxml-core/xlsx';
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface SheetStats {
+    cells: number;
+    formulas: number;
+    tables: number;
+    charts: number;
+    images: number;
+    comments: number;
+}
+export declare function sheetStats(ws: Worksheet): SheetStats;
+export declare function openStatistics(ctx: EditorContext): Promise<undefined>;

package/dist/xlsx/dialogs/styles.d.ts

@@ -0,0 +1 @@
+export declare const DIALOG_CSS = "\n.xve-cmd-dialog { --office-background: var(--xve-popover, var(--xve-background, #fff));\n\t--office-foreground: var(--xve-popover-foreground, var(--xve-foreground, #1f2937));\n\t--office-border: var(--xve-border, #d1d5db); --office-ring: var(--xve-ring, #217346); }\n.xve-dialog-body { display: flex; flex-direction: column; gap: 10px; min-width: min(360px, 86vw);\n\tfont: 13px/1.4 var(--xve-font, system-ui, \"Segoe UI\", sans-serif); color: var(--office-foreground); }\n.xve-cmd-dialog-wide .xve-dialog-body { min-width: min(560px, 90vw); }\n.xve-dialog-footer { display: flex; gap: 8px; justify-content: flex-end; flex-wrap: wrap; }\n.xve-btn { min-height: 28px; padding: 3px 14px; border-radius: var(--xve-radius, 4px); cursor: pointer;\n\tborder: 1px solid var(--xve-border, #c8c6c4); background: var(--xve-secondary, #fff); color: inherit; font: inherit; }\n.xve-btn:hover:not(:disabled) { background: var(--xve-accent, #f3f2f1); }\n.xve-btn:focus-visible, .xve-input:focus-visible, .xve-tab:focus-visible, .xve-listbox:focus-visible,\n\t.xve-swatch:focus-visible, .xve-tile:focus-visible { outline: 2px solid var(--xve-ring, #217346); outline-offset: 1px; }\n.xve-btn-primary { background: var(--xve-primary, #217346); color: var(--xve-primary-foreground, #fff);\n\tborder-color: var(--xve-primary, #217346); }\n.xve-btn-primary:hover:not(:disabled) { background: var(--xve-primary, #1b5e38); filter: brightness(.95); }\n.xve-btn:disabled { opacity: .5; cursor: default; }\n.xve-field { display: grid; grid-template-columns: minmax(110px, auto) 1fr; align-items: center; gap: 8px; }\n.xve-field-label { color: var(--xve-muted-foreground, #605e5c); }\n.xve-input { box-sizing: border-box; min-height: 28px; padding: 3px 6px; border-radius: var(--xve-radius, 4px);\n\tborder: 1px solid var(--xve-input, #c8c6c4); background: var(--xve-background, #fff); color: inherit; font: inherit; min-width: 0; }\ntextarea.xve-input { resize: vertical; }\n.xve-input[aria-invalid=\"true\"] { border-color: var(--xve-destructive, #c50f1f); }\n.xve-check { display: flex; align-items: center; gap: 6px; }\n.xve-fieldset { border: 1px solid var(--xve-border, #e1dfdd); border-radius: var(--xve-radius, 4px);\n\tpadding: 8px 10px; margin: 0; display: flex; flex-direction: column; gap: 6px; min-width: 0; }\n.xve-fieldset legend { padding: 0 4px; font-weight: 600; }\n.xve-row { display: flex; gap: 10px; align-items: flex-start; flex-wrap: wrap; }\n.xve-row > * { flex: 1 1 160px; }\n.xve-note { margin: 0; color: var(--xve-muted-foreground, #605e5c); font-size: 12px; }\n.xve-tablist { display: flex; gap: 2px; border-bottom: 1px solid var(--xve-border, #e1dfdd); flex-wrap: wrap; }\n.xve-tab { border: 0; background: transparent; color: inherit; font: inherit; padding: 6px 10px; cursor: pointer;\n\tborder-bottom: 2px solid transparent; }\n.xve-tab[aria-selected=\"true\"] { border-bottom-color: var(--xve-primary, #217346); font-weight: 600; }\n.xve-tabpanel { padding-top: 10px; display: flex; flex-direction: column; gap: 10px; }\n.xve-tabpanel[hidden] { display: none; }\n.xve-listbox { border: 1px solid var(--xve-input, #c8c6c4); border-radius: var(--xve-radius, 4px);\n\tmin-height: 120px; max-height: 220px; overflow: auto; background: var(--xve-background, #fff); }\n.xve-option { padding: 3px 8px; cursor: default; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }\n.xve-option[aria-selected=\"true\"] { background: var(--xve-selection, #cce8d6); color: inherit; }\n.xve-sample { min-height: 40px; display: flex; align-items: center; justify-content: center; padding: 6px;\n\tborder: 1px solid var(--xve-border, #e1dfdd); background: var(--xve-sheet-bg, #fff); color: #000; overflow: hidden; }\n.xve-swatches { display: grid; grid-template-columns: repeat(10, 18px); gap: 3px; }\n.xve-swatch { width: 18px; height: 18px; border: 1px solid #c8c6c4; padding: 0; cursor: pointer; border-radius: 2px; }\n.xve-swatch[aria-pressed=\"true\"] { outline: 2px solid var(--xve-primary, #217346); outline-offset: 1px; }\n.xve-tiles { display: grid; grid-template-columns: repeat(auto-fill, minmax(84px, 1fr)); gap: 6px; }\n.xve-tile { display: flex; flex-direction: column; align-items: center; gap: 4px; padding: 6px; cursor: pointer;\n\tborder: 1px solid var(--xve-border, #e1dfdd); border-radius: var(--xve-radius, 4px); background: transparent; color: inherit; font: inherit; }\n.xve-tile[aria-pressed=\"true\"] { border-color: var(--xve-primary, #217346); background: var(--xve-selection, #e6f2ea); }\n.xve-symbols { display: grid; grid-template-columns: repeat(16, 28px); gap: 2px; max-height: 240px; overflow: auto; }\n.xve-symbols button { width: 28px; height: 28px; padding: 0; font-size: 16px; }\n.xve-preview { border: 1px solid var(--xve-border, #e1dfdd); background: #fff; min-height: 160px; display: flex;\n\talign-items: center; justify-content: center; }\n.xve-preview svg { max-width: 100%; height: auto; }\n.xve-results { max-height: 160px; overflow: auto; border: 1px solid var(--xve-border, #e1dfdd); }\n.xve-results table { border-collapse: collapse; width: 100%; font-size: 12px; }\n.xve-results th, .xve-results td { text-align: left; padding: 2px 6px; border-bottom: 1px solid var(--xve-border, #f3f2f1); }\n.xve-results tr[aria-selected=\"true\"] td { background: var(--xve-selection, #cce8d6); }\n.xve-border-box { display: grid; grid-template-columns: 1fr 1fr; gap: 10px; }\n.xve-border-preview { width: 120px; height: 80px; position: relative; background: #fff; border: 1px dashed #c8c6c4; }\n@media (max-width: 600px) { .xve-field { grid-template-columns: 1fr; } .xve-symbols { grid-template-columns: repeat(8, 28px); } }\n";

package/dist/xlsx/dialogs/symbol.d.ts

@@ -0,0 +1,6 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare const SYMBOL_SUBSETS: ReadonlyArray<readonly [id: string, label: string, chars: string[]]>;
+export declare const codeOf: (ch: string) => string;
+/** Inserts `symbol` into the active cell. */
+export declare function insertSymbol(ctx: EditorContext, symbol: string): void;
+export declare function openSymbol(ctx: EditorContext): Promise<string | undefined>;

package/dist/xlsx/dialogs/text-to-columns.d.ts

@@ -0,0 +1,9 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface SplitOptions {
+    delimiters: string[];
+    consecutive: boolean;
+    qualifier: string;
+}
+/** Splits one line at any of the delimiters, honouring a text qualifier (`"a,b",c`). */
+export declare function splitLine(line: string, options: SplitOptions): string[];
+export declare function openTextToColumns(ctx: EditorContext): Promise<number | undefined>;

package/dist/xlsx/dialogs/zoom.d.ts

@@ -0,0 +1,2 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export declare function openZoom(ctx: EditorContext): Promise<number | undefined>;

package/dist/xlsx/editor-attributes.d.ts

@@ -0,0 +1,26 @@
+import { type EditorThemeMode } from './theme';
+/**
+ * Attribute <-> property mapping for `<xlsx-editor>`. Properties are the source of truth: an
+ * attribute change goes through the property setter only when it would change the value, and a
+ * property change is written back only when the attribute would differ, so the two directions
+ * cannot ping-pong (the docx editor's scheme).
+ */
+export declare const XLSX_EDITOR_ATTRIBUTES: readonly ['locale', 'read-only', 'file-name', 'author-name', 'theme', 'show-toolbar', 'show-formula-bar'];
+export type XlsxEditorAttribute = (typeof XLSX_EDITOR_ATTRIBUTES)[number];
+export declare const DEFAULT_FILE_NAME = "Book1.xlsx";
+export declare const DEFAULT_AUTHOR_NAME = "Author";
+/** The element properties the attributes drive. */
+export interface AttributeProperties {
+    locale: string;
+    readOnly: boolean;
+    fileName: string;
+    authorName: string;
+    theme: EditorThemeMode;
+    showToolbar: boolean;
+    showFormulaBar: boolean;
+}
+export declare function isXlsxEditorAttribute(name: string): name is XlsxEditorAttribute;
+/** attributeChangedCallback body: attribute -> property. */
+export declare function applyAttribute(target: AttributeProperties, name: XlsxEditorAttribute, value: string | null): void;
+/** Property setter tail: property -> attribute. A no-op where the element has no DOM (SSR). */
+export declare function reflectAttribute(element: Element, name: XlsxEditorAttribute, value: string | boolean): void;

package/dist/xlsx/editor-core.d.ts

@@ -0,0 +1,91 @@
+/**
+ * The editor's state and the `EditorContext` every UI module receives: the workbook and its edit
+ * session, the active sheet and selection, the command and dialog registries, and the public
+ * event plumbing. The element (component.ts) owns one EditorCore; the shell (editor-shell.ts)
+ * builds the DOM around it.
+ */
+import { type EditSession, type Workbook } from 'ooxml-core/xlsx';
+import { type CommandRegistry } from 'ooxml-core/xlsx/ui';
+import type { EditorContext, SelectionModel } from 'ooxml-core/xlsx/ui';
+import { type DialogRegistry } from 'ooxml-core/xlsx/ui';
+import { DirtyState } from 'ooxml-core/xlsx/ui';
+import { type EditorLocale } from 'ooxml-core/xlsx/ui';
+import type { CalculationMode } from './backstage';
+import type { EditorThemeMode, XlsxTheme } from './theme';
+/** What the shell exposes back to the core (filled in when the element connects). */
+export interface ShellHooks {
+    render(): void;
+    toast(message: string, kind?: 'info' | 'warning' | 'error'): void;
+    relocalize(): void;
+}
+export declare class EditorCore {
+    readonly host: HTMLElement;
+    workbook: Workbook | undefined;
+    session: EditSession | undefined;
+    activeSheet: number;
+    readOnly: boolean;
+    locale: EditorLocale;
+    authorName: string;
+    fileName: string;
+    theme: EditorThemeMode;
+    showToolbar: boolean;
+    showFormulaBar: boolean;
+    themeColors: Partial<XlsxTheme>;
+    appliedThemeVars: string[];
+    hiddenActions: string[];
+    loadGeneration: number;
+    savePassword: string | undefined;
+    shell: ShellHooks | undefined;
+    readonly selection: SelectionModel;
+    readonly commands: CommandRegistry;
+    readonly dialogs: DialogRegistry;
+    readonly dirty: DirtyState;
+    readonly ctx: EditorContext;
+    private gridController;
+    private readonly modelListeners;
+    private stopSession;
+    private renderQueued;
+    private lastSelection;
+    private readonly sheetSelections;
+    /** The worksheet object on screen, to notice sheets inserted, moved or deleted around it. */
+    private shownSheet;
+    /** Automatic or manual calculation: the workbook's own mode (`calcPr calcMode`). */
+    get calculation(): CalculationMode;
+    constructor(host: HTMLElement);
+    private createContext;
+    /** Debounced refresh of the ribbon, title bar and status bar. */
+    requestRender(): void;
+    notifyModel(change: unknown): void;
+    /** Replaces the workbook (load, new, template, property), with a fresh edit session. */
+    setWorkbook(workbook: Workbook | undefined): void;
+    private createSession;
+    private onSessionChange;
+    setActiveSheet(index: number, force?: boolean): void;
+    /**
+     * After an edit that inserted, moved or deleted sheets: keep showing the same worksheet at its
+     * new index, or, when it was deleted, switch to the nearest visible sheet (always announcing
+     * `sheet-change` and restoring that sheet's selection, even when the index is unchanged).
+     */
+    private followShownSheet;
+    /** Text width for the core's automatic row heights, from the grid's canvas measurer. */
+    private measureText;
+    /** Iterative calculation as the workbook stores it (`calcPr iterate`); undefined when off. */
+    get iteration(): {
+        count: number;
+        delta: number;
+    } | undefined;
+    /**
+     * Turns iterative calculation on (with its maximum iterations and maximum change) or off
+     * (`undefined`) and recalculates, so circular references settle or are reported again. The core
+     * session has no undoable setter for this yet, so it is not an undo step; it marks the workbook
+     * as changed so it is saved.
+     */
+    setIterativeCalculation(next: {
+        count: number;
+        delta: number;
+    } | undefined): void;
+    /** Switches automatic or manual calculation on the live session (one undo step, saved). */
+    setCalculation(mode: CalculationMode): void;
+    setLocale(value: string): void;
+    setReadOnly(readOnly: boolean): boolean;
+}

package/dist/xlsx/editor-files.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Workbook I/O for the element: load (xlsx, xlsm, xls, csv through the core's `loadWorkbook`),
+ * new, save, download, and the default handlers of the File commands.
+ */
+import { type Workbook } from 'ooxml-core/xlsx';
+import { type TemplateId } from './backstage';
+import type { EditorCore } from './editor-core';
+import { type FileCommand } from './events';
+import type { SaveState } from './title-bar';
+/** Chrome callbacks the file actions report to (title bar save state, backstage). */
+export interface FileChrome {
+    setSaveState(state: SaveState): void;
+    fileNameChanged(): void;
+}
+export declare function reportError(core: EditorCore, cause: unknown): Error;
+/** Shows a new workbook model: fresh session, clean state, `workbook-change`. */
+export declare function showWorkbook(core: EditorCore, workbook: Workbook, fileName: string, chrome?: FileChrome): void;
+export declare function loadInto(core: EditorCore, bytes: Uint8Array | ArrayBuffer, fileName: string | undefined, chrome?: FileChrome): Promise<void>;
+export declare function newInto(core: EditorCore, chrome?: FileChrome): void;
+export declare function templateInto(core: EditorCore, id: TemplateId, chrome?: FileChrome): void;
+export declare function saveBytes(core: EditorCore, format?: 'xlsx' | 'csv'): Promise<Uint8Array>;
+export declare function saveBlob(core: EditorCore): Promise<Blob>;
+export interface FileCommandOptions {
+    chrome?: FileChrome;
+    openBackstage?(page: 'saveAs'): void;
+}
+/** Runs a File command unless a host cancels the `file-command` event to handle it itself. */
+export declare function runFileCommand(core: EditorCore, command: FileCommand, fileName: string | undefined, options?: FileCommandOptions): Promise<void>;

package/dist/xlsx/editor-shell.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Builds the shadow-DOM shell once: title bar, ribbon, formula bar row, grid, sheet tabs, status
+ * bar, backstage, shortcut help and toasts; installs the commands and mounts the grid modules.
+ * Mirrors docx-viewer's editor-shell.ts.
+ */
+import { type Backstage } from './backstage';
+import type { EditorCore } from './editor-core';
+import { type FileChrome } from './editor-files';
+import { type FileCommand } from './events';
+import { type Ribbon } from './ribbon/ribbon';
+import { type SaveState, type TitleBar } from './title-bar';
+/** Element properties the shell's options and customize pages change. */
+export interface ShellElement extends HTMLElement {
+    locale: string;
+    theme: 'light' | 'dark' | 'auto';
+    authorName: string;
+    readOnly: boolean;
+    showFormulaBar: boolean;
+    hiddenActions: string[];
+}
+export interface Shell {
+    readonly ribbon: Ribbon;
+    readonly titleBar: TitleBar;
+    readonly backstage: Backstage;
+    readonly chrome: FileChrome;
+    saveState(): SaveState;
+    fileCommand(command: FileCommand, fileName?: string): Promise<void>;
+}
+export declare function buildShell(core: EditorCore): Shell;

package/dist/xlsx/element-api.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The public methods of `<xlsx-editor>` (load, newWorkbook, save, saveBytes, download, markClean,
+ * select, getSelection, setActiveSheet, undo, redo, focusGrid). The properties and lifecycle are
+ * in component.ts; the state is the EditorCore.
+ */
+import { EditorCore } from './editor-core';
+import { type FileChrome } from './editor-files';
+/** Server rendering has no HTMLElement; the class still has to be definable there. */
+export declare const HTMLElementBase: typeof HTMLElement;
+export declare class XlsxEditorApi extends HTMLElementBase {
+    protected readonly core: EditorCore;
+    /** Set by the shell once connected. */
+    protected chrome: FileChrome | undefined;
+    /** Opens .xlsx, .xlsm, .xltx, .xls or .csv bytes; `fileName` helps detection and names the file. */
+    load(bytes: Uint8Array | ArrayBuffer, fileName?: string): Promise<void>;
+    /** Starts a blank workbook named Book1.xlsx. */
+    newWorkbook(): void;
+    /** The workbook as .xlsx bytes (or the active sheet as CSV). Does not clear `dirty`. */
+    saveBytes(format?: 'xlsx' | 'csv'): Promise<Uint8Array>;
+    /** The workbook as an .xlsx Blob. Does not clear `dirty`; call `markClean()` after persisting. */
+    save(): Promise<Blob>;
+    /** Saves and downloads in the browser, then marks the workbook clean. */
+    download(name?: string): Promise<void>;
+    /** Clears the unsaved-changes flag (after the host persisted the bytes). */
+    markClean(): void;
+    /** Selects `B2`, `B2:C5`, `A:A`, `B2:C5,E1` or `'Sheet 2'!A1` and scrolls it into view. */
+    select(ref: string): void;
+    /** The selection as A1 text (`B2:C5`, several ranges joined by commas). */
+    getSelection(): string;
+    setActiveSheet(index: number): void;
+    undo(): void;
+    redo(): void;
+    focusGrid(): void;
+}

package/dist/xlsx/events.d.ts

@@ -0,0 +1,64 @@
+import type { Workbook } from 'ooxml-core/xlsx';
+export type FileCommand = 'new' | 'open' | 'save' | 'saveAs' | 'export' | 'exportCsv' | 'print';
+export interface FileCommandDetail {
+    command: FileCommand;
+    /** Save As: the name the user chose. */
+    fileName?: string;
+}
+export interface SelectionChangeDetail {
+    sheet: number;
+    /** The selection as A1 text (`B2:C5`, or `A1:B2,D4` for several ranges). */
+    ref: string;
+    /** The active cell (`B2`). */
+    active: string;
+}
+/** Every public event of `<xlsx-editor>` and its detail. All bubble and are composed. */
+export interface XlsxEditorEventMap {
+    /** The workbook was loaded, created or edited. */
+    'workbook-change': {
+        workbook: Workbook;
+    };
+    /** Loading, saving, printing or a command failed. */
+    'workbook-error': {
+        error: Error;
+        message: string;
+    };
+    /** Non-fatal notes from the loader (unsupported features, compatibility). */
+    'workbook-warning': {
+        warnings: string[];
+    };
+    /** The user toggled Editing / Viewing, or the host changed `readOnly`. */
+    'readonly-change': {
+        readOnly: boolean;
+    };
+    /** A command ran from the ribbon, a menu, Tell me or a shortcut. */
+    'ribbon-action': {
+        id: string;
+    };
+    /** The user changed which ribbon commands are shown (File > Options > Customize Ribbon). */
+    'ribbon-customize': {
+        hiddenActions: string[];
+    };
+    /** Cancelable: call `preventDefault()` to handle a File command yourself. */
+    'file-command': FileCommandDetail;
+    'selection-change': SelectionChangeDetail;
+    'sheet-change': {
+        index: number;
+        name: string;
+    };
+    /** Unsaved-changes state flipped: true after an edit, false after save, load or `markClean()`. */
+    'dirty-change': {
+        dirty: boolean;
+    };
+}
+export type XlsxEditorEventName = keyof XlsxEditorEventMap;
+export type XlsxEditorEventDetail<K extends XlsxEditorEventName> = XlsxEditorEventMap[K];
+/** Runtime list of every event name; the `satisfies` check keeps it a subset of the map. */
+export declare const XLSX_EDITOR_EVENTS: readonly ["workbook-change", "workbook-error", "workbook-warning", "readonly-change", "ribbon-action", "ribbon-customize", "file-command", "selection-change", "sheet-change", "dirty-change"];
+/**
+ * Dispatches a bubbling, composed CustomEvent. Returns false when a cancelable event was canceled
+ * (the `EventTarget.dispatchEvent` contract).
+ */
+export declare function emitEvent(target: EventTarget, type: string, detail: unknown): boolean;
+/** Typed form of `emitEvent` for the public events. */
+export declare function emit<K extends XlsxEditorEventName>(target: EventTarget, type: K, detail: XlsxEditorEventDetail<K>): boolean;

package/dist/xlsx/file-commands.d.ts

@@ -0,0 +1,24 @@
+/**
+ * File commands raised by the title bar, the File backstage and shortcuts. Each is first announced
+ * as a cancelable `file-command` event so hosts can take over file I/O; when no host cancels it the
+ * editor runs a browser-only default (file picker, download, print).
+ */
+import { type FileCommand } from './events';
+export declare const XLSX_TYPE = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+/** File types the Open picker accepts. */
+export declare const OPEN_ACCEPT = ".xlsx,.xlsm,.xltx,.xls,.csv,.tsv,.txt";
+/** Dispatches `file-command`; false when a host canceled it. */
+export declare function announceFileCommand(host: HTMLElement, command: FileCommand, fileName?: string): boolean;
+export declare const extensionOf: (fileName: string) => string;
+/** Replaces the extension of `fileName` (or appends one). */
+export declare function withExtension(fileName: string, extension: string): string;
+/** The extension a save writes: macro workbooks keep .xlsm, everything else (.xls, .csv) is .xlsx. */
+export declare function saveExtension(fileName: string): 'xlsx' | 'xlsm';
+export declare function blobFor(bytes: Uint8Array, fileName: string): Blob;
+/** Starts a browser download of `bytes` named `fileName`. */
+export declare function downloadBytes(doc: Document, bytes: Uint8Array, fileName: string): void;
+/** Opens the browser file picker; resolves with the chosen file's bytes and name. */
+export declare function pickFile(root: ShadowRoot | HTMLElement, accept?: string): Promise<{
+    bytes: Uint8Array;
+    name: string;
+} | undefined>;

package/dist/xlsx/formula-bar/formula-input.d.ts

@@ -0,0 +1,11 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+import { type FormulaField } from '../grid/formula-field.js';
+import { type FunctionAssist } from '../grid/function-assist.js';
+export interface FormulaInput {
+    readonly field: FormulaField;
+    readonly assist: FunctionAssist;
+    /** Shows the active cell's content (when not editing). */
+    refresh(): void;
+    destroy(): void;
+}
+export declare function createFormulaInput(ctx: EditorContext, doc: Document, bar: HTMLElement): FormulaInput;

package/dist/xlsx/formula-bar/index.d.ts

@@ -0,0 +1,3 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export { absoluteReference, nameForRange, parseSheetReference, resolveNameBox, } from 'ooxml-core/xlsx/ui';
+export declare function mountFormulaBar(ctx: EditorContext, container: HTMLElement): () => void;

package/dist/xlsx/formula-bar/name-box.d.ts

@@ -0,0 +1,10 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export interface NameBox {
+    readonly root: HTMLElement;
+    readonly input: HTMLInputElement;
+    refresh(): void;
+    destroy(): void;
+}
+/** Focus check that also works inside a shadow root. */
+export declare const isFocused: (node: HTMLElement) => boolean;
+export declare function createNameBox(ctx: EditorContext, doc: Document): NameBox;

package/dist/xlsx/formula-bar/styles.d.ts

@@ -0,0 +1 @@
+export declare const FORMULA_BAR_CSS = "\n.xfb{position:relative;display:flex;align-items:stretch;gap:0;min-height:26px;padding:3px 6px;box-sizing:border-box;background:var(--xve-background,#fff);border-bottom:1px solid var(--xve-border,#e1dfdd);font:12px/1.4 'Segoe UI',system-ui,sans-serif;color:var(--xve-foreground,#252423)}\n.xfb-namebox{position:relative;display:flex;align-items:center;width:110px;flex:none;border:1px solid var(--xve-input,#c8c6c4);border-radius:var(--xve-radius,2px);background:var(--xve-background,#fff)}\n.xfb-name{flex:1;min-width:0;border:0;outline:0;background:transparent;color:inherit;font:inherit;padding:0 4px;height:20px}\n.xfb-namebox:focus-within{border-color:var(--xve-ring,#217346)}\n.xfb-name-toggle{border:0;background:transparent;color:inherit;width:16px;height:20px;padding:0;display:flex;align-items:center;justify-content:center;cursor:pointer}\n.xfb-name-list{position:absolute;left:-1px;top:100%;z-index:50;min-width:100%;max-height:240px;overflow:auto;margin:2px 0 0;padding:2px 0;list-style:none;background:var(--xve-popover,#fff);border:1px solid var(--xve-border,#c8c6c4);box-shadow:0 4px 12px rgba(0,0,0,.16)}\n.xfb-name-item{padding:3px 8px;cursor:default;white-space:nowrap}\n.xfb-name-item:hover{background:var(--xve-accent,#e1dfdd)}\n.xfb-name-empty{padding:3px 8px;color:var(--xve-muted-foreground,#605e5c)}\n.xfb-actions{display:flex;align-items:center;flex:none;padding:0 4px;margin-left:4px;border-left:1px solid var(--xve-border,#e1dfdd)}\n.xfb-btn{border:0;background:transparent;color:inherit;width:24px;height:22px;padding:0;display:flex;align-items:center;justify-content:center;border-radius:var(--xve-radius,2px);cursor:pointer}\n.xfb-btn:hover:not(:disabled){background:var(--xve-accent,#edebe9)}\n.xfb-btn:disabled{opacity:.45;cursor:default}\n.xfb-cancel,.xfb-enter{display:none}\n.xfb-editing .xfb-cancel,.xfb-editing .xfb-enter{display:flex}\n.xfb-fx i{font-family:Cambria,'Times New Roman',serif;font-size:13px}\n.xfb-input{flex:1;min-width:0;height:20px;border:1px solid transparent;border-radius:var(--xve-radius,2px)}\n.xfb-input:focus-within{border-color:var(--xve-input,#c8c6c4)}\n.xfb-expanded .xfb-input{height:76px}\n.xfb-expand{align-self:flex-start;flex:none;margin-left:2px}\n.xfb-expanded .xfb-expand svg{transform:rotate(180deg)}\n.xfb .xg-field{position:relative;overflow:hidden}\n.xfb .xg-field-backdrop,.xfb .xg-field-input{position:absolute;inset:0;box-sizing:border-box;margin:0;border:0;padding:1px 4px;font:13px/18px Calibri,Carlito,'Segoe UI',sans-serif;white-space:pre-wrap;word-wrap:break-word;overflow:hidden}\n.xfb .xg-field-backdrop{color:var(--xve-foreground,#252423);pointer-events:none;visibility:hidden}\n.xfb .xg-field-input{resize:none;outline:0;background:transparent;color:inherit}\n.xfb-expanded .xg-field-input{overflow:auto}\n.xfb .xg-formula .xg-field-backdrop{visibility:visible}\n.xfb .xg-formula .xg-field-input{color:transparent;caret-color:var(--xve-foreground,#252423)}\n.xfb .xg-assist{top:100%}\n";

package/dist/xlsx/grid/alert.d.ts

@@ -0,0 +1,4 @@
+import type { EditorContext } from 'ooxml-core/xlsx/ui';
+export type AlertStyle = 'stop' | 'warning' | 'information';
+export type AlertAnswer = 'retry' | 'cancel' | 'yes' | 'no' | 'ok';
+export declare function showValidationAlert(ctx: EditorContext, style: AlertStyle, message: string, title?: string): Promise<AlertAnswer>;