@a3s-lab/office 0.13.1 → 0.15.0

package/dist/internal/features/work/editors/spreadsheet-paste-special-types.d.ts

@@ -0,0 +1,127 @@
+import type { Cell } from '@fortune-sheet/core';
+import type { SpreadsheetResolvedCellBorders } from './spreadsheet-cell-border';
+import type { SpreadsheetCellRange, SpreadsheetCellRangeInput } from './spreadsheet-cell-range';
+import type { WorkSpreadsheetContent, WorkSpreadsheetDataValidationItem, WorkSpreadsheetSheet } from '../work-types';
+export declare const MAX_SPREADSHEET_PASTE_SPECIAL_CELLS = 50000;
+export declare const MAX_SPREADSHEET_ROWS = 1048576;
+export declare const MAX_SPREADSHEET_COLUMNS = 16384;
+export declare const spreadsheetPasteContentOptions: readonly [{
+    readonly value: "all";
+    readonly label: "全部";
+    readonly richOnly: false;
+}, {
+    readonly value: "formulas";
+    readonly label: "公式";
+    readonly richOnly: false;
+}, {
+    readonly value: "values";
+    readonly label: "值";
+    readonly richOnly: false;
+}, {
+    readonly value: "formats";
+    readonly label: "格式";
+    readonly richOnly: true;
+}, {
+    readonly value: "comments";
+    readonly label: "批注";
+    readonly richOnly: true;
+}, {
+    readonly value: "validation";
+    readonly label: "数据验证";
+    readonly richOnly: true;
+}, {
+    readonly value: "all-except-borders";
+    readonly label: "边框除外的全部";
+    readonly richOnly: true;
+}, {
+    readonly value: "formulas-and-number-formats";
+    readonly label: "公式和数字格式";
+    readonly richOnly: true;
+}, {
+    readonly value: "values-and-number-formats";
+    readonly label: "值和数字格式";
+    readonly richOnly: true;
+}, {
+    readonly value: "column-widths";
+    readonly label: "列宽";
+    readonly richOnly: true;
+}];
+export type SpreadsheetPasteContent = (typeof spreadsheetPasteContentOptions)[number]['value'];
+export declare const spreadsheetPasteOperationOptions: readonly [{
+    readonly value: "none";
+    readonly label: "无";
+}, {
+    readonly value: "add";
+    readonly label: "加";
+}, {
+    readonly value: "subtract";
+    readonly label: "减";
+}, {
+    readonly value: "multiply";
+    readonly label: "乘";
+}, {
+    readonly value: "divide";
+    readonly label: "除";
+}];
+export type SpreadsheetPasteOperation = (typeof spreadsheetPasteOperationOptions)[number]['value'];
+export interface SpreadsheetPasteSpecialOptions {
+    content: SpreadsheetPasteContent;
+    operation: SpreadsheetPasteOperation;
+    skipBlanks: boolean;
+    transpose: boolean;
+}
+export interface SpreadsheetClipboardCell {
+    cell: Cell | null;
+    borders: SpreadsheetResolvedCellBorders;
+    validation?: WorkSpreadsheetDataValidationItem;
+    protection?: {
+        locked: boolean;
+        hidden: boolean;
+    };
+    hyperlink?: NonNullable<WorkSpreadsheetSheet['hyperlink']>[string];
+}
+export interface SpreadsheetClipboardMerge {
+    row: number;
+    column: number;
+    rowSpan: number;
+    columnSpan: number;
+}
+export interface SpreadsheetClipboardSnapshot {
+    version: 1;
+    kind: 'rich' | 'text';
+    plainText: string;
+    sourceSheetId?: string;
+    sourceRange: SpreadsheetCellRange;
+    rowCount: number;
+    columnCount: number;
+    cells: SpreadsheetClipboardCell[][];
+    columnWidths?: number[];
+    merges: SpreadsheetClipboardMerge[];
+    containsUnsupportedFormulaState: boolean;
+}
+export interface SpreadsheetPasteSpecialRequest {
+    snapshot: SpreadsheetClipboardSnapshot;
+    targetSheetId: string;
+    targetSelection: SpreadsheetCellRangeInput;
+    options: SpreadsheetPasteSpecialOptions;
+}
+export interface SpreadsheetPasteSpecialResult {
+    content: WorkSpreadsheetContent;
+    targetRange: SpreadsheetCellRange;
+    firstCellValue: unknown;
+}
+export interface SpreadsheetPastePlan {
+    targetRange: SpreadsheetCellRange;
+    rowCount: number;
+    columnCount: number;
+}
+export interface SpreadsheetCellWriter {
+    get(row: number, column: number): Cell | null | undefined;
+    set(row: number, column: number, cell: Cell | null): void;
+    finish(sheet: WorkSpreadsheetSheet): WorkSpreadsheetSheet;
+}
+export interface SpreadsheetPasteSource {
+    cell: SpreadsheetClipboardCell;
+    sourceRow: number;
+    sourceColumn: number;
+}

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

@@ -0,0 +1,7 @@
+import type { WorkSpreadsheetContent } from '../work-types';
+import { type SpreadsheetPasteSpecialRequest, type SpreadsheetPasteSpecialResult } from './spreadsheet-paste-special-types';
+export { captureSpreadsheetClipboardSnapshot, createSpreadsheetTextClipboardSnapshot, normalizeSpreadsheetClipboardText, spreadsheetPasteSpecialModeAvailable, } from './spreadsheet-paste-special-snapshot';
+export { MAX_SPREADSHEET_COLUMNS, MAX_SPREADSHEET_PASTE_SPECIAL_CELLS, MAX_SPREADSHEET_ROWS, spreadsheetPasteContentOptions, spreadsheetPasteOperationOptions, } from './spreadsheet-paste-special-types';
+export type { SpreadsheetClipboardCell, SpreadsheetClipboardMerge, SpreadsheetClipboardSnapshot, SpreadsheetPasteContent, SpreadsheetPasteOperation, SpreadsheetPasteSpecialOptions, SpreadsheetPasteSpecialRequest, SpreadsheetPasteSpecialResult, } from './spreadsheet-paste-special-types';
+export declare function spreadsheetPasteSpecialValidationError(content: WorkSpreadsheetContent, request: SpreadsheetPasteSpecialRequest): string | null;
+export declare function applySpreadsheetPasteSpecial(content: WorkSpreadsheetContent, request: SpreadsheetPasteSpecialRequest): SpreadsheetPasteSpecialResult | null;

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

@@ -0,0 +1,36 @@
+import type { MutableRefObject } from 'react';
+import type { WorkSpreadsheetContent } from '../work-types';
+import { type SpreadsheetClipboardPort } from './spreadsheet-clipboard';
+import type { SpreadsheetClipboardCommandPort } from './spreadsheet-command-controller';
+import type { SpreadsheetCellRange } from './spreadsheet-cell-range';
+import { type SpreadsheetClipboardSnapshot, type SpreadsheetPasteContent, type SpreadsheetPasteSpecialOptions } from './spreadsheet-paste-special';
+export interface SpreadsheetClipboardSelectionSource {
+    sheetId: string;
+    range: SpreadsheetCellRange;
+    plainText: string;
+}
+export interface SpreadsheetPasteSpecialDialogSource {
+    snapshot: SpreadsheetClipboardSnapshot;
+    targetSheetId: string;
+    targetRange: SpreadsheetCellRange;
+    invoker: HTMLElement | null;
+}
+export declare function useSpreadsheetClipboard({ clipboard, canAccessSelection, clearSelection, commit, contentRef, editable, fallbackFocusTarget, getSelection, }: {
+    clipboard?: SpreadsheetClipboardPort;
+    canAccessSelection: boolean;
+    clearSelection: () => boolean;
+    commit: (content: WorkSpreadsheetContent) => boolean;
+    contentRef: MutableRefObject<WorkSpreadsheetContent>;
+    editable: boolean;
+    fallbackFocusTarget: () => HTMLElement | null;
+    getSelection: () => SpreadsheetClipboardSelectionSource | null;
+}): {
+    applyDialog: (options: SpreadsheetPasteSpecialOptions) => boolean;
+    closeDialog: () => void;
+    commandPort: SpreadsheetClipboardCommandPort;
+    copyToDataTransfer: (data: DataTransfer, cut: boolean) => boolean;
+    dialogSource: SpreadsheetPasteSpecialDialogSource | null;
+    pasteText: (plainText: string, content?: SpreadsheetPasteContent, notify?: boolean) => boolean;
+    restoreDialogFocusTarget: () => HTMLElement | null;
+    validateDialog: (options: SpreadsheetPasteSpecialOptions) => 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/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;