@odoo/o-spreadsheet 16.3.22 → 16.3.25

package/dist/o-spreadsheet.d.ts

@@ -1519,7 +1519,7 @@ declare class EditionPlugin extends UIPlugin {
     getEditionMode(): EditionMode;
     getCurrentContent(): string;
     getComposerSelection(): ComposerSelection;
-    getCurrentEditedCell(): CellPosition;
+    getCurrentEditedCell(): CellPosition | undefined;
     isSelectingForComposer(): boolean;
     showSelectionIndicator(): boolean;
     getCurrentTokens(): EnrichedToken[];
@@ -2326,69 +2326,70 @@ declare const enum CommandResult {
     InvalidFigureId = 28,
     InputAlreadyFocused = 29,
     MaximumRangesReached = 30,
-    InvalidChartDefinition = 31,
-    InvalidDataSet = 32,
-    InvalidLabelRange = 33,
-    InvalidScorecardKeyValue = 34,
-    InvalidScorecardBaseline = 35,
-    InvalidGaugeDataRange = 36,
-    EmptyGaugeRangeMin = 37,
-    GaugeRangeMinNaN = 38,
-    EmptyGaugeRangeMax = 39,
-    GaugeRangeMaxNaN = 40,
-    GaugeRangeMinBiggerThanRangeMax = 41,
-    GaugeLowerInflectionPointNaN = 42,
-    GaugeUpperInflectionPointNaN = 43,
-    GaugeLowerBiggerThanUpper = 44,
-    InvalidAutofillSelection = 45,
-    WrongComposerSelection = 46,
-    MinBiggerThanMax = 47,
-    LowerBiggerThanUpper = 48,
-    MidBiggerThanMax = 49,
-    MinBiggerThanMid = 50,
-    FirstArgMissing = 51,
-    SecondArgMissing = 52,
-    MinNaN = 53,
-    MidNaN = 54,
-    MaxNaN = 55,
-    ValueUpperInflectionNaN = 56,
-    ValueLowerInflectionNaN = 57,
-    MinInvalidFormula = 58,
-    MidInvalidFormula = 59,
-    MaxInvalidFormula = 60,
-    ValueUpperInvalidFormula = 61,
-    ValueLowerInvalidFormula = 62,
-    InvalidSortZone = 63,
-    WaitingSessionConfirmation = 64,
-    MergeOverlap = 65,
-    TooManyHiddenElements = 66,
-    Readonly = 67,
-    InvalidViewportSize = 68,
-    InvalidScrollingDirection = 69,
-    FigureDoesNotExist = 70,
-    InvalidConditionalFormatId = 71,
-    InvalidCellPopover = 72,
-    EmptyTarget = 73,
-    InvalidFreezeQuantity = 74,
-    FrozenPaneOverlap = 75,
-    ValuesNotChanged = 76,
-    InvalidFilterZone = 77,
-    FilterOverlap = 78,
-    FilterNotFound = 79,
-    MergeInFilter = 80,
-    NonContinuousTargets = 81,
-    DuplicatedFigureId = 82,
-    InvalidSelectionStep = 83,
-    DuplicatedChartId = 84,
-    ChartDoesNotExist = 85,
-    InvalidHeaderIndex = 86,
-    InvalidQuantity = 87,
-    MoreThanOneColumnSelected = 88,
-    EmptySplitSeparator = 89,
-    SplitWillOverwriteContent = 90,
-    NoSplitSeparatorInSelection = 91,
-    NoActiveSheet = 92,
-    NoChanges = 93
+    InvalidInputId = 31,
+    InvalidChartDefinition = 32,
+    InvalidDataSet = 33,
+    InvalidLabelRange = 34,
+    InvalidScorecardKeyValue = 35,
+    InvalidScorecardBaseline = 36,
+    InvalidGaugeDataRange = 37,
+    EmptyGaugeRangeMin = 38,
+    GaugeRangeMinNaN = 39,
+    EmptyGaugeRangeMax = 40,
+    GaugeRangeMaxNaN = 41,
+    GaugeRangeMinBiggerThanRangeMax = 42,
+    GaugeLowerInflectionPointNaN = 43,
+    GaugeUpperInflectionPointNaN = 44,
+    GaugeLowerBiggerThanUpper = 45,
+    InvalidAutofillSelection = 46,
+    WrongComposerSelection = 47,
+    MinBiggerThanMax = 48,
+    LowerBiggerThanUpper = 49,
+    MidBiggerThanMax = 50,
+    MinBiggerThanMid = 51,
+    FirstArgMissing = 52,
+    SecondArgMissing = 53,
+    MinNaN = 54,
+    MidNaN = 55,
+    MaxNaN = 56,
+    ValueUpperInflectionNaN = 57,
+    ValueLowerInflectionNaN = 58,
+    MinInvalidFormula = 59,
+    MidInvalidFormula = 60,
+    MaxInvalidFormula = 61,
+    ValueUpperInvalidFormula = 62,
+    ValueLowerInvalidFormula = 63,
+    InvalidSortZone = 64,
+    WaitingSessionConfirmation = 65,
+    MergeOverlap = 66,
+    TooManyHiddenElements = 67,
+    Readonly = 68,
+    InvalidViewportSize = 69,
+    InvalidScrollingDirection = 70,
+    FigureDoesNotExist = 71,
+    InvalidConditionalFormatId = 72,
+    InvalidCellPopover = 73,
+    EmptyTarget = 74,
+    InvalidFreezeQuantity = 75,
+    FrozenPaneOverlap = 76,
+    ValuesNotChanged = 77,
+    InvalidFilterZone = 78,
+    FilterOverlap = 79,
+    FilterNotFound = 80,
+    MergeInFilter = 81,
+    NonContinuousTargets = 82,
+    DuplicatedFigureId = 83,
+    InvalidSelectionStep = 84,
+    DuplicatedChartId = 85,
+    ChartDoesNotExist = 86,
+    InvalidHeaderIndex = 87,
+    InvalidQuantity = 88,
+    MoreThanOneColumnSelected = 89,
+    EmptySplitSeparator = 90,
+    SplitWillOverwriteContent = 91,
+    NoSplitSeparatorInSelection = 92,
+    NoActiveSheet = 93,
+    NoChanges = 94
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -2807,6 +2808,12 @@ interface ClipboardInterface {
     readText(): Promise<ClipboardReadResult>;
 }
 
+declare class FocusableElement {
+    private focusableElement;
+    setFocusableElement(element: HTMLElement): void;
+    focus(): void;
+}
+
 type TranslationFunction = (string: string, ...values: string[] | [{
     [key: string]: string;
 }]) => string;
@@ -2840,6 +2847,7 @@ interface SpreadsheetChildEnv extends SpreadsheetEnv {
     _t: TranslationFunction;
     startCellEdition: (content: string) => void;
     loadCurrencies?: () => Promise<Currency[]>;
+    focusableElement: FocusableElement;
 }
 
 type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "META";
@@ -2922,8 +2930,9 @@ declare class RangeAdapter implements CommandHandler<CoreCommand> {
      *
      * @param range the range (received from getRangeFromXC or getRangeFromZone)
      * @param forSheetId the id of the sheet where the range string is supposed to be used.
+     * @param [useFixedZone=false] if true, the range will be returned with fixed row and column
      */
-    getRangeString(range: Range, forSheetId: UID): string;
+    getRangeString(range: Range, forSheetId: UID, useFixedZone?: boolean): string;
     getRangeDataFromXc(sheetId: UID, xc: string): RangeData;
     getRangeDataFromZone(sheetId: UID, zone: Zone): RangeData;
     getRangeFromRangeData(data: RangeData): Range;
@@ -3142,7 +3151,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
      * starting an async evaluation even if it has been moved or re-allocated
      */
     getCellById(cellId: UID): Cell | undefined;
-    buildFormulaContent(sheetId: UID, cell: Pick<FormulaCell, "dependencies" | "compiledFormula">, dependencies?: Range[]): string;
+    buildFormulaContent(sheetId: UID, cell: Pick<FormulaCell, "dependencies" | "compiledFormula">, dependencies?: Range[], useFixedZone?: boolean): string;
     getFormulaCellContent(sheetId: UID, cell: FormulaCell): string;
     getCellStyle(position: CellPosition): Style;
     /**
@@ -4413,7 +4422,7 @@ interface RangeInputValue {
  * This plugin handles this internal state.
  */
 declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<SelectionEvent> {
-    private readonly inputHasSingleRange;
+    readonly inputHasSingleRange: boolean;
     static layers: LAYERS[];
     static getters: never[];
     ranges: RangeInputValue[];
@@ -4421,7 +4430,6 @@ declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<S
     private activeSheet;
     private willAddNewRange;
     constructor(config: UIPluginConfig, initialRanges: string[], inputHasSingleRange: boolean);
-    allowDispatch(cmd: LocalCommand): CommandResult;
     handleEvent(event: SelectionEvent): void;
     handle(cmd: Command): void;
     getSelectionInputValue(): string[];
@@ -6555,11 +6563,12 @@ interface AutocompleteValue {
 }
 interface ComposerProps {
     focus: ComposerFocusType;
-    onComposerContentFocused: (selection: ComposerSelection) => void;
     inputStyle?: string;
     rect?: Rect;
     delimitation?: DOMDimension;
-    onComposerUnmounted?: () => void;
+    onComposerContentFocused: () => void;
+    onComposerCellFocused?: (content: String) => void;
+    isDefaultFocus?: boolean;
 }
 interface ComposerState$1 {
     positionStart: number;
@@ -6584,6 +6593,7 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     };
     static defaultProps: {
         inputStyle: string;
+        isDefaultFocus: boolean;
     };
     composerRef: {
         el: HTMLElement | null;
@@ -6611,7 +6621,8 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     onCompositionEnd(): void;
     onKeydown(ev: KeyboardEvent): void;
     private updateCursorIfNeeded;
-    onInput(): void;
+    onPaste(ev: ClipboardEvent): void;
+    onInput(ev: InputEvent): void;
     onKeyup(ev: KeyboardEvent): void;
     showAutocomplete(searchTerm: string): void;
     onMousedown(ev: MouseEvent): void;
@@ -6770,7 +6781,7 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
     focusGrid(): void;
     onKeydown(ev: KeyboardEvent): void;
     onTopBarComposerFocused(selection: ComposerSelection): void;
-    onGridComposerContentFocused(): void;
+    onGridComposerContentFocused(selection: ComposerSelection): void;
     onGridComposerCellFocused(content?: string, selection?: ComposerSelection): void;
     /**
      * Start the edition or update the content if it's already started.
@@ -6781,8 +6792,8 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
 
 interface Props$5 {
     focus: ComposerFocusType;
-    onComposerUnmounted: () => void;
-    onComposerContentFocused: (selection: ComposerSelection) => void;
+    onComposerContentFocused: () => void;
+    onComposerCellFocused: () => void;
     gridDims: DOMDimension;
 }
 /**
@@ -6794,17 +6805,23 @@ declare class GridComposer extends Component<Props$5, SpreadsheetChildEnv> {
     static components: {
         Composer: typeof Composer;
     };
-    private gridComposerRef;
-    private zone;
     private rect;
+    private isEditing;
     private isCellReferenceVisible;
-    private composerState;
+    get defaultRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
     setup(): void;
     get shouldDisplayCellReference(): boolean;
     get cellReference(): string;
     get cellReferenceStyle(): string;
+    get composerProps(): ComposerProps;
     get containerStyle(): string;
-    get composerStyle(): string;
+    private updateComponentPosition;
+    private updateCellReferenceVisibility;
 }
 
 interface ResizerState {
@@ -7004,7 +7021,6 @@ declare class Grid extends Component<Props$1, SpreadsheetChildEnv> {
     readonly HEADER_WIDTH = 48;
     private menuState;
     private gridRef;
-    private hiddenInput;
     onMouseWheel: (ev: WheelEvent) => void;
     canvasPosition: DOMCoordinates;
     hoveredCell: Partial<Position$1>;
@@ -7016,7 +7032,7 @@ declare class Grid extends Component<Props$1, SpreadsheetChildEnv> {
     get gridOverlayDimensions(): string;
     onClosePopover(): void;
     private keyDownMapping;
-    focus(): void;
+    focusDefaultElement(): void;
     get gridEl(): HTMLElement;
     getAutofillPosition(): {
         left: number;
@@ -7036,7 +7052,6 @@ declare class Grid extends Component<Props$1, SpreadsheetChildEnv> {
     closeOpenedPopover(): void;
     processArrows(ev: KeyboardEvent): void;
     onKeydown(ev: KeyboardEvent): void;
-    onInput(ev: InputEvent): void;
     onInputContextMenu(ev: MouseEvent): void;
     onCellRightClicked(col: HeaderIndex, row: HeaderIndex, { x, y }: DOMCoordinates): void;
     toggleContextMenu(type: ContextMenuType, x: Pixel, y: Pixel): void;