@a3s-lab/office 0.14.0 → 0.16.0

package/dist/internal/features/work/editors/spreadsheet-hyperlink.d.ts

@@ -0,0 +1,44 @@
+import type { WorkSpreadsheetContent } from '../work-types';
+export type SpreadsheetHyperlinkType = 'webpage' | 'cellrange' | 'sheet';
+export interface SpreadsheetHyperlinkTarget {
+    linkType: SpreadsheetHyperlinkType;
+    linkAddress: string;
+}
+export interface SpreadsheetHyperlinkCell {
+    sheetId: string;
+    row: number;
+    column: number;
+}
+export interface SpreadsheetHyperlinkRequest extends SpreadsheetHyperlinkCell {
+    linkType: SpreadsheetHyperlinkType;
+    linkAddress: string;
+    displayText?: string;
+}
+export type SpreadsheetHyperlinkDialogValue = Pick<SpreadsheetHyperlinkRequest, 'linkType' | 'linkAddress' | 'displayText'>;
+export type SpreadsheetHyperlinkErrorCode = 'empty-address' | 'formula-display-text' | 'invalid-cell-range' | 'invalid-display-text' | 'invalid-web-address' | 'pivot-cell' | 'protected-cell' | 'source-out-of-bounds' | 'source-sheet-not-found' | 'target-out-of-bounds' | 'target-sheet-hidden' | 'target-sheet-not-found' | 'unsupported-link-type';
+export type SpreadsheetHyperlinkValidation = {
+    ok: true;
+    target: SpreadsheetHyperlinkTarget;
+    displayText?: string;
+} | {
+    ok: false;
+    code: SpreadsheetHyperlinkErrorCode;
+    message: string;
+};
+export interface SpreadsheetHyperlinkDialogSource extends SpreadsheetHyperlinkCell {
+    sheetName: string;
+    cellReference: string;
+    displayText: string;
+    displayTextEditable: boolean;
+    hasHyperlink: boolean;
+    link: SpreadsheetHyperlinkTarget | null;
+    sheetOptions: Array<{
+        id: string;
+        name: string;
+    }>;
+}
+export declare function validateSpreadsheetHyperlinkRequest(content: WorkSpreadsheetContent, request: SpreadsheetHyperlinkRequest): SpreadsheetHyperlinkValidation;
+export declare function applySpreadsheetHyperlink(content: WorkSpreadsheetContent, request: SpreadsheetHyperlinkRequest): WorkSpreadsheetContent | null;
+export declare function removeSpreadsheetHyperlink(content: WorkSpreadsheetContent, target: SpreadsheetHyperlinkCell): WorkSpreadsheetContent | null;
+export declare function canRemoveSpreadsheetHyperlink(content: WorkSpreadsheetContent, target: SpreadsheetHyperlinkCell): boolean;
+export declare function createSpreadsheetHyperlinkDialogSource(content: WorkSpreadsheetContent, target: SpreadsheetHyperlinkCell): SpreadsheetHyperlinkDialogSource | null;

package/dist/internal/features/work/editors/spreadsheet-table-command.d.ts

@@ -0,0 +1,3 @@
+import type { SpreadsheetCommandContext, SpreadsheetEditorCommands } from './spreadsheet-command-controller';
+import { type OfficeEditorExtension } from './office-editor-extension';
+export declare function createSpreadsheetTableExtension(): OfficeEditorExtension<SpreadsheetCommandContext, SpreadsheetEditorCommands>;

package/dist/internal/features/work/editors/spreadsheet-table-conversion.d.ts

@@ -0,0 +1,7 @@
+import type { WorkSpreadsheetContent, WorkSpreadsheetTable } from '../work-types';
+export declare function canMaterializeSpreadsheetTableAppearance(table: WorkSpreadsheetTable): boolean;
+/**
+ * Convert to Range removes ListObject semantics, so the render-only style must
+ * become native cell formatting to preserve the appearance users confirmed.
+ */
+export declare function materializeSpreadsheetTableAppearance(content: WorkSpreadsheetContent, sheetId: string, table: WorkSpreadsheetTable): WorkSpreadsheetContent | null;

package/dist/internal/features/work/editors/spreadsheet-table-dialog.d.ts

@@ -0,0 +1,8 @@
+import type { SpreadsheetTableDialogSource, SpreadsheetTableDialogValue } from './spreadsheet-table';
+export declare function SpreadsheetTableDialog({ source, restoreFocusTarget, onApply, onClose, onValidate, }: {
+    source: SpreadsheetTableDialogSource;
+    restoreFocusTarget: () => HTMLElement | null;
+    onApply: (value: SpreadsheetTableDialogValue) => boolean;
+    onClose: () => void;
+    onValidate: (value: SpreadsheetTableDialogValue) => string | null;
+}): import("react").JSX.Element;

package/dist/internal/features/work/editors/spreadsheet-table-limits.d.ts

@@ -0,0 +1 @@
+export declare const MAX_SPREADSHEET_TABLE_CELLS = 100000;

package/dist/internal/features/work/editors/spreadsheet-table-reconciliation.d.ts

@@ -0,0 +1,21 @@
+import type { Op } from '@fortune-sheet/core';
+import type { WorkSpreadsheetSheet } from '../work-types';
+export type SpreadsheetTableStructureChange = {
+    axis: 'column' | 'row';
+    count: number;
+    direction: 'lefttop' | 'rightbottom';
+    index: number;
+    kind: 'insert';
+} | {
+    axis: 'column' | 'row';
+    end: number;
+    kind: 'delete';
+    start: number;
+};
+export declare function canApplySpreadsheetTableStructureChange(sheet: WorkSpreadsheetSheet | undefined, change: SpreadsheetTableStructureChange): boolean;
+/**
+ * Reconciles Fortune's cell and whole-row/column operation stream with the
+ * browser-owned ListObject model. Fortune preserves unknown sheet metadata,
+ * but it cannot update table ranges, column identities, or filter offsets.
+ */
+export declare function reconcileSpreadsheetTablesAfterFortune(sheets: WorkSpreadsheetSheet[], sourceSheets: WorkSpreadsheetSheet[], operations?: readonly Op[]): WorkSpreadsheetSheet[];

package/dist/internal/features/work/editors/spreadsheet-table-render.d.ts

@@ -0,0 +1,16 @@
+import type { Cell } from '@fortune-sheet/core';
+import type { SpreadsheetTableCellRenderStyle } from './spreadsheet-table-style';
+export interface SpreadsheetTableRenderCellInfo {
+    column: number;
+    endX: number;
+    endY: number;
+    row: number;
+    startX: number;
+    startY: number;
+}
+export interface SpreadsheetTableConditionalStyle {
+    cellColor?: string;
+    textColor?: string;
+}
+export declare function beginSpreadsheetTableCellRender(_cell: Cell | null, tableStyle: SpreadsheetTableCellRenderStyle | null, conditionalStyle: SpreadsheetTableConditionalStyle | undefined, context: CanvasRenderingContext2D): void;
+export declare function finishSpreadsheetTableCellRender(_cell: Cell | null, cellInfo: SpreadsheetTableRenderCellInfo, tableStyle: SpreadsheetTableCellRenderStyle | null, context: CanvasRenderingContext2D): void;

package/dist/internal/features/work/editors/spreadsheet-table-ribbon.d.ts

@@ -0,0 +1,8 @@
+import type { WorkSpreadsheetTable } from '../work-types';
+import type { SpreadsheetEditorCanCommands, SpreadsheetEditorCommands } from './spreadsheet-command-controller';
+export declare function SpreadsheetTableDesignRibbon({ can, commands, sheetId, table, }: {
+    can: SpreadsheetEditorCanCommands;
+    commands: SpreadsheetEditorCommands;
+    sheetId: string;
+    table: WorkSpreadsheetTable;
+}): import("react").JSX.Element;

package/dist/internal/features/work/editors/spreadsheet-table-style.d.ts

@@ -0,0 +1,31 @@
+import type { WorkSpreadsheetTable, WorkSpreadsheetTableStyle } from '../work-types';
+export interface SpreadsheetTableStylePalette {
+    border: string;
+    header: string;
+    headerText: string;
+    primaryRow: string;
+    secondaryRow: string;
+    stripeColumn: string;
+    text: string;
+    total: string;
+    totalText: string;
+}
+export interface SpreadsheetTableStyleChoice {
+    label: string;
+    ooxmlName: string;
+    palette: SpreadsheetTableStylePalette;
+    style: Exclude<WorkSpreadsheetTableStyle, {
+        family: 'none';
+    }>;
+}
+export interface SpreadsheetTableCellRenderStyle {
+    background: string;
+    bold: boolean;
+    borderColor: string;
+    role: 'body' | 'header' | 'totals';
+    tableId: string;
+    textColor: string;
+}
+export declare function spreadsheetTableStyleChoices(): readonly SpreadsheetTableStyleChoice[];
+export declare function spreadsheetTableStylePalette(style: WorkSpreadsheetTableStyle): SpreadsheetTableStylePalette | null;
+export declare function createSpreadsheetTableRenderResolver(tables: readonly WorkSpreadsheetTable[]): (row: number, column: number) => SpreadsheetTableCellRenderStyle | null;

package/dist/internal/features/work/editors/spreadsheet-table.d.ts

@@ -0,0 +1,55 @@
+import type { Selection } from '@fortune-sheet/core';
+import type { WorkSpreadsheetContent, WorkSpreadsheetSheet, WorkSpreadsheetTable, WorkSpreadsheetTableStyle } from '../work-types';
+import { type SpreadsheetCellRange } from './spreadsheet-cell-range';
+export { MAX_SPREADSHEET_TABLE_CELLS } from './spreadsheet-table-limits';
+export interface SpreadsheetTableTarget {
+    sheetId: string;
+    selection: Selection;
+}
+export interface SpreadsheetTableDialogValue {
+    headerRow: boolean;
+    rangeReference: string;
+}
+export interface SpreadsheetTableDialogSource {
+    name: string;
+    range: SpreadsheetCellRange;
+    rangeReference: string;
+    sheetId: string;
+    sheetName: string;
+    value: SpreadsheetTableDialogValue;
+}
+export interface SpreadsheetTableRequest {
+    headerRow: boolean;
+    name: string;
+    range: SpreadsheetCellRange;
+    sheetId: string;
+    style?: WorkSpreadsheetTableStyle;
+}
+export type SpreadsheetTableValidation = {
+    columns: string[];
+    name: string;
+    ok: true;
+    range: SpreadsheetCellRange;
+    sheet: WorkSpreadsheetSheet;
+} | {
+    code: SpreadsheetTableErrorCode;
+    message: string;
+    ok: false;
+};
+export type SpreadsheetTableErrorCode = 'auto-filter-overlap' | 'invalid-column-name' | 'invalid-name' | 'invalid-range' | 'invalid-style' | 'merged-range' | 'name-conflict' | 'out-of-bounds' | 'protected-range' | 'pivot-table' | 'range-too-large' | 'sheet-not-found' | 'table-overlap';
+export interface SpreadsheetTableDesignPatch {
+    name?: string;
+    showColumnStripes?: boolean;
+    showFirstColumn?: boolean;
+    showLastColumn?: boolean;
+    showRowStripes?: boolean;
+    style?: WorkSpreadsheetTableStyle;
+}
+export declare function createSpreadsheetTableDialogSource(content: WorkSpreadsheetContent, target: SpreadsheetTableTarget): SpreadsheetTableDialogSource | null;
+export declare function spreadsheetTableRangeFromText(value: string): SpreadsheetCellRange | null;
+export declare function validateSpreadsheetTableRequest(content: WorkSpreadsheetContent, request: SpreadsheetTableRequest): SpreadsheetTableValidation;
+export declare function applySpreadsheetTable(content: WorkSpreadsheetContent, request: SpreadsheetTableRequest): WorkSpreadsheetContent | null;
+export declare function updateSpreadsheetTable(content: WorkSpreadsheetContent, sheetId: string, tableId: string, patch: SpreadsheetTableDesignPatch): WorkSpreadsheetContent | null;
+export declare function convertSpreadsheetTableToRange(content: WorkSpreadsheetContent, sheetId: string, tableId: string): WorkSpreadsheetContent | null;
+export declare function spreadsheetTableAtCell(sheet: WorkSpreadsheetSheet | undefined, row: number, column: number): WorkSpreadsheetTable | null;
+export declare function spreadsheetTableFailureMessage(content: WorkSpreadsheetContent, request: SpreadsheetTableRequest): string | null;

package/dist/internal/features/work/editors/use-spreadsheet-data-validation.d.ts

@@ -0,0 +1,23 @@
+import type { Selection } from '@fortune-sheet/core';
+import type { WorkSpreadsheetContent } from '../work-types';
+import type { SpreadsheetDataValidationCommandPort, SpreadsheetEditorCommands } from './spreadsheet-command-controller';
+export interface SpreadsheetDataValidationSelectionState {
+    selections: Selection[];
+    sheetId: string;
+}
+export declare function useSpreadsheetDataValidation({ commandsRef, contentRef, focusGrid, getGridFocusTarget, getLiveSelections, preview, }: {
+    commandsRef: {
+        current: SpreadsheetEditorCommands | null;
+    };
+    contentRef: {
+        current: WorkSpreadsheetContent;
+    };
+    focusGrid: (focusOrigin: Element | null) => void;
+    getGridFocusTarget: () => HTMLElement | null;
+    getLiveSelections: () => Selection[] | undefined;
+    preview: boolean;
+}): {
+    commandPort: SpreadsheetDataValidationCommandPort;
+    selectionForChange: () => SpreadsheetDataValidationSelectionState | null;
+    dialog: import("react").JSX.Element | null;
+};

package/dist/internal/features/work/editors/use-spreadsheet-hyperlink.d.ts

@@ -0,0 +1,24 @@
+import type { Selection } from '@fortune-sheet/core';
+import type { WorkSpreadsheetContent } from '../work-types';
+import type { SpreadsheetEditorCommands, SpreadsheetHyperlinkCommandPort } from './spreadsheet-command-controller';
+export interface SpreadsheetHyperlinkSelectionState {
+    sheetId: string;
+    selection: Selection;
+}
+export declare function useSpreadsheetHyperlink({ commandsRef, contentRef, focusGrid, getGridFocusTarget, getLiveSelection, preview, selectionState, }: {
+    commandsRef: {
+        current: SpreadsheetEditorCommands | null;
+    };
+    contentRef: {
+        current: WorkSpreadsheetContent;
+    };
+    focusGrid: (focusOrigin: Element | null) => void;
+    getGridFocusTarget: () => HTMLElement | null;
+    getLiveSelection: () => Selection | undefined;
+    preview: boolean;
+    selectionState: SpreadsheetHyperlinkSelectionState | null;
+}): {
+    commandPort: SpreadsheetHyperlinkCommandPort;
+    selectionForChange: () => SpreadsheetHyperlinkSelectionState | null;
+    dialog: import("react").JSX.Element | null;
+};

package/dist/internal/features/work/editors/use-spreadsheet-table.d.ts

@@ -0,0 +1,23 @@
+import type { Selection } from '@fortune-sheet/core';
+import type { WorkSpreadsheetContent } from '../work-types';
+import type { SpreadsheetEditorCommands, SpreadsheetTableCommandPort } from './spreadsheet-command-controller';
+export interface SpreadsheetTableSelectionState {
+    selection: Selection;
+    sheetId: string;
+}
+export declare function useSpreadsheetTable({ commandsRef, contentRef, focusGrid, getGridFocusTarget, getLiveSelection, preview, }: {
+    commandsRef: {
+        current: SpreadsheetEditorCommands | null;
+    };
+    contentRef: {
+        current: WorkSpreadsheetContent;
+    };
+    focusGrid: (focusOrigin: Element | null) => void;
+    getGridFocusTarget: () => HTMLElement | null;
+    getLiveSelection: () => Selection | undefined;
+    preview: boolean;
+}): {
+    commandPort: SpreadsheetTableCommandPort;
+    selectionForChange: () => SpreadsheetTableSelectionState | null;
+    dialog: import("react").JSX.Element | null;
+};

package/dist/internal/features/work/work-spreadsheet-data-validation.d.ts

@@ -0,0 +1,2 @@
+export declare function normalizeSpreadsheetDateValidationBoundary(value: string, uses1904DateSystem?: boolean): string | null;
+export declare function spreadsheetDateValidationFormula(value: string): string;

package/dist/internal/features/work/work-types.d.ts

@@ -213,12 +213,112 @@ export interface WorkSpreadsheetDataValidationRange {
     ranges: WorkSpreadsheetCellRange[];
     item: WorkSpreadsheetDataValidationItem;
 }
+export type WorkSpreadsheetTableStyle = {
+    family: 'none';
+} | {
+    family: 'light';
+    number: number;
+} | {
+    family: 'medium';
+    number: number;
+} | {
+    family: 'dark';
+    number: number;
+};
+export interface WorkSpreadsheetTableColumn {
+    name: string;
+}
+export type WorkSpreadsheetDynamicFilter = 'above-average' | 'below-average' | 'tomorrow' | 'today' | 'yesterday' | 'next-week' | 'this-week' | 'last-week' | 'next-month' | 'this-month' | 'last-month' | 'next-quarter' | 'this-quarter' | 'last-quarter' | 'next-year' | 'this-year' | 'last-year' | 'year-to-date' | 'quarter-1' | 'quarter-2' | 'quarter-3' | 'quarter-4' | 'month-1' | 'month-2' | 'month-3' | 'month-4' | 'month-5' | 'month-6' | 'month-7' | 'month-8' | 'month-9' | 'month-10' | 'month-11' | 'month-12';
+export type WorkSpreadsheetTableFilterCriteria = {
+    type: 'values';
+    values: string[];
+    includeBlanks: boolean;
+} | {
+    type: 'equals';
+    value: string;
+} | {
+    type: 'not-equals';
+    value: string;
+} | {
+    type: 'contains';
+    value: string;
+} | {
+    type: 'does-not-contain';
+    value: string;
+} | {
+    type: 'begins-with';
+    value: string;
+} | {
+    type: 'ends-with';
+    value: string;
+} | {
+    type: 'greater-than';
+    value: string;
+} | {
+    type: 'greater-than-or-equal';
+    value: string;
+} | {
+    type: 'less-than';
+    value: string;
+} | {
+    type: 'less-than-or-equal';
+    value: string;
+} | {
+    type: 'between';
+    lower: string;
+    upper: string;
+} | {
+    type: 'not-between';
+    lower: string;
+    upper: string;
+} | {
+    type: 'blanks';
+} | {
+    type: 'non-blanks';
+} | {
+    type: 'top';
+    count: number;
+} | {
+    type: 'top-percent';
+    percent: number;
+} | {
+    type: 'bottom';
+    count: number;
+} | {
+    type: 'bottom-percent';
+    percent: number;
+} | {
+    type: 'dynamic';
+    kind: WorkSpreadsheetDynamicFilter;
+};
+export interface WorkSpreadsheetTableFilter {
+    column: number;
+    criteria: WorkSpreadsheetTableFilterCriteria;
+}
+export interface WorkSpreadsheetTable {
+    /** Stable browser-model identity. OOXML numeric identity is kept separately. */
+    id: string;
+    ooxmlId?: number;
+    name: string;
+    displayName?: string;
+    range: WorkSpreadsheetCellRange;
+    columns: WorkSpreadsheetTableColumn[];
+    filters: WorkSpreadsheetTableFilter[];
+    headerRow: boolean;
+    totalsRow: boolean;
+    style: WorkSpreadsheetTableStyle;
+    showFirstColumn: boolean;
+    showLastColumn: boolean;
+    showRowStripes: boolean;
+    showColumnStripes: boolean;
+}
 export type WorkSpreadsheetSheet = Omit<Sheet, 'images'> & {
     images?: WorkSpreadsheetImage[];
     charts?: WorkSpreadsheetChart[];
     pivotTables?: WorkSpreadsheetPivotTable[];
     formulaMetadata?: WorkSpreadsheetFormulaMetadata;
     dataValidationRanges?: WorkSpreadsheetDataValidationRange[];
+    tables?: WorkSpreadsheetTable[];
 };
 export type WorkSpreadsheetPivotAggregation = 'sum' | 'count' | 'counta' | 'average' | 'max' | 'min' | 'product' | 'stdDev' | 'stdDevP' | 'var' | 'varP';
 export interface WorkSpreadsheetPivotValue {

package/dist/internal/features/work/work-xlsx-interop.d.ts

@@ -9,6 +9,7 @@ import { type XlsxManualPageBreaks } from './work-xlsx-page-breaks';
 import { type XlsxPageSetup } from './work-xlsx-page-setup';
 import { type XlsxProtectionFeatures } from './work-xlsx-protection';
 import { type XlsxWorksheetXmlScan } from './work-xlsx-worksheet-scan';
+import type { WorkSpreadsheetTable } from './work-types';
 type FrozenPane = NonNullable<Sheet['frozen']>;
 export interface XlsxDataValidation {
     references: string[];
@@ -24,6 +25,7 @@ export interface XlsxSheetFeatures {
     pageSetup?: XlsxPageSetup;
     images: XlsxWorksheetImage[];
     charts: XlsxWorksheetChart[];
+    tables: WorkSpreadsheetTable[];
 }
 export type FortuneDataValidationItem = WorkSpreadsheetDataValidationItem;
 export declare function readXlsxSheetFeatures(buffer: ArrayBuffer): Promise<Map<string, XlsxSheetFeatures>>;

package/dist/internal/features/work/work-xlsx-table-filters.d.ts

@@ -0,0 +1,3 @@
+import type { WorkSpreadsheetTableFilter } from './work-types';
+export declare function readXlsxTableFilters(table: Document, width: number): WorkSpreadsheetTableFilter[];
+export declare function xlsxTableAutoFilterXml(filters: readonly WorkSpreadsheetTableFilter[], rangeReference: string, totalsRow: boolean): string;

package/dist/internal/features/work/work-xlsx-tables.d.ts

@@ -0,0 +1,4 @@
+import { OoxmlPackage } from './work-ooxml-package';
+import type { WorkSpreadsheetContent, WorkSpreadsheetTable } from './work-types';
+export declare function readXlsxWorksheetTables(archive: OoxmlPackage, worksheetPart: string): Promise<WorkSpreadsheetTable[]>;
+export declare function patchXlsxSpreadsheetTables(buffer: ArrayBuffer, content: WorkSpreadsheetContent): Promise<ArrayBuffer>;