@odoo/o-spreadsheet 16.1.33 → 16.1.36

package/dist/o-spreadsheet.d.ts

@@ -341,6 +341,10 @@ type SelectionEvent = Readonly<ZonesSelected | HeadersSelected | AlterZoneCorner
 
 interface StreamCallbacks<Event> {
     handleEvent: (event: Event) => void;
+    /** this callback will only be called when another consumer captures the stream,
+     * not when the current consumer decides to release the stream itself as it could
+     * have react differently to both situations.
+     *  */
     release?: () => void;
 }
 
@@ -479,8 +483,13 @@ declare class SelectionStreamProcessor implements SelectionProcessor, StatefulSt
      */
     private getEndOfCluster;
     /**
-     * Check if a cell is empty or undefined in the model. If the cell is part of a merge,
-     * check if the merge containing the cell is empty.
+     * Check if a cell evaluated value is empty. If the cell is part of a merge,
+     * the check applies to the main cell of the merge.
+     */
+    private isEvaluatedCellEmpty;
+    /**
+     * Checks if a cell is empty (i.e. does not have a content). If the cell is part of a merge,
+     * the check applies to the main cell of the merge.
      */
     private isCellEmpty;
     /** Computes the next cell position in the given direction by crossing through merges and skipping hidden cells.
@@ -1426,7 +1435,6 @@ declare class EditionPlugin extends UIPlugin {
     allowDispatch(cmd: Command): CommandResult;
     private handleEvent;
     handle(cmd: Command): void;
-    unsubscribe(): void;
     getEditionMode(): EditionMode;
     getCurrentContent(): string;
     getEditionSheet(): string;
@@ -2679,6 +2687,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;
@@ -2711,6 +2725,7 @@ interface SpreadsheetChildEnv extends SpreadsheetEnv {
     clipboard: ClipboardInterface;
     _t: TranslationFunction;
     loadCurrencies?: () => Promise<Currency[]>;
+    focusableElement: FocusableElement;
 }
 
 type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "META";
@@ -3005,8 +3020,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;
@@ -3224,7 +3240,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;
     /**
@@ -3270,6 +3286,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
     private createErrorFormula;
     private checkCellOutOfSheet;
     private checkUselessClearCell;
+    private checkUselessUpdateCell;
 }
 
 /**
@@ -4435,7 +4452,6 @@ declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<S
     constructor(config: UIPluginConfig, initialRanges: string[], inputHasSingleRange: boolean);
     handleEvent(event: SelectionEvent): void;
     handle(cmd: Command): void;
-    unsubscribe(): void;
     getSelectionInputValue(): string[];
     getSelectionInputHighlights(): Highlight$1[];
     /**
@@ -4496,7 +4512,6 @@ declare class SelectionInputsManagerPlugin extends UIPlugin {
     constructor(config: UIPluginConfig);
     allowDispatch(cmd: Command): CommandResult;
     handle(cmd: Command): void;
-    unsubscribe(): void;
     /**
      * Return a list of all valid XCs.
      * e.g. ["A1", "Sheet2!B3", "E12"]
@@ -5006,7 +5021,7 @@ interface ChartBuilder {
     name: string;
 }
 
-interface Props$x {
+interface Props$w {
     ranges: string[];
     hasSingleRange?: boolean;
     required?: boolean;
@@ -5028,7 +5043,7 @@ interface SelectionRange extends Omit<RangeInputValue, "color"> {
  * onSelectionChanged is called every time the input value
  * changes.
  */
-declare class SelectionInput extends Component<Props$x, SpreadsheetChildEnv> {
+declare class SelectionInput extends Component<Props$w, SpreadsheetChildEnv> {
     static template: string;
     private id;
     private previousRanges;
@@ -5053,12 +5068,12 @@ declare class SelectionInput extends Component<Props$x, SpreadsheetChildEnv> {
     confirm(): void;
 }
 
-interface Props$w {
+interface Props$v {
     figureId: UID;
     definition: LineChartDefinition | BarChartDefinition | PieChartDefinition;
     updateChart: (figureId: UID, definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => DispatchResult;
 }
-declare class LineBarPieConfigPanel extends Component<Props$w, SpreadsheetChildEnv> {
+declare class LineBarPieConfigPanel extends Component<Props$v, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         SelectionInput: typeof SelectionInput;
@@ -5119,12 +5134,12 @@ declare class ColorPicker extends Component<ColorPickerProps, SpreadsheetChildEn
     isSameColor(color1: Color, color2: Color): boolean;
 }
 
-interface Props$v {
+interface Props$u {
     figureId: UID;
     definition: LineChartDefinition | BarChartDefinition | PieChartDefinition;
     updateChart: (figureId: UID, definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => CommandResult | CommandResult[];
 }
-declare class LineBarPieDesignPanel extends Component<Props$v, SpreadsheetChildEnv> {
+declare class LineBarPieDesignPanel extends Component<Props$u, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         ColorPicker: typeof ColorPicker;
@@ -5138,12 +5153,12 @@ declare class LineBarPieDesignPanel extends Component<Props$v, SpreadsheetChildE
     updateSelect(attr: string, ev: any): void;
 }
 
-interface Props$u {
+interface Props$t {
     figureId: UID;
     definition: GaugeChartDefinition;
     updateChart: (figureId: UID, definition: Partial<GaugeChartDefinition>) => DispatchResult;
 }
-declare class GaugeChartConfigPanel extends Component<Props$u, SpreadsheetChildEnv> {
+declare class GaugeChartConfigPanel extends Component<Props$t, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         SelectionInput: typeof SelectionInput;
@@ -5157,12 +5172,12 @@ declare class GaugeChartConfigPanel extends Component<Props$u, SpreadsheetChildE
 }
 
 type GaugeMenu = "backgroundColor" | "sectionColor-lowerColor" | "sectionColor-middleColor" | "sectionColor-upperColor";
-interface Props$t {
+interface Props$s {
     figureId: UID;
     definition: GaugeChartDefinition;
     updateChart: (figureId: UID, definition: Partial<GaugeChartDefinition>) => DispatchResult;
 }
-declare class GaugeChartDesignPanel extends Component<Props$t, SpreadsheetChildEnv> {
+declare class GaugeChartDesignPanel extends Component<Props$s, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         ColorPicker: typeof ColorPicker;
@@ -5196,12 +5211,12 @@ declare class LineConfigPanel extends LineBarPieConfigPanel {
     onUpdateCumulative(ev: any): void;
 }
 
-interface Props$s {
+interface Props$r {
     figureId: UID;
     definition: ScorecardChartDefinition;
     updateChart: (figureId: UID, definition: Partial<ScorecardChartDefinition>) => DispatchResult;
 }
-declare class ScorecardChartConfigPanel extends Component<Props$s, SpreadsheetChildEnv> {
+declare class ScorecardChartConfigPanel extends Component<Props$r, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         SelectionInput: typeof SelectionInput;
@@ -5220,12 +5235,12 @@ declare class ScorecardChartConfigPanel extends Component<Props$s, SpreadsheetCh
 }
 
 type ColorPickerId = undefined | "backgroundColor" | "baselineColorUp" | "baselineColorDown";
-interface Props$r {
+interface Props$q {
     figureId: UID;
     definition: ScorecardChartDefinition;
     updateChart: (figureId: UID, definition: Partial<ScorecardChartDefinition>) => DispatchResult;
 }
-declare class ScorecardChartDesignPanel extends Component<Props$r, SpreadsheetChildEnv> {
+declare class ScorecardChartDesignPanel extends Component<Props$q, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         ColorPicker: typeof ColorPicker;
@@ -5336,10 +5351,10 @@ interface AutofillRule {
     sequence: number;
 }
 
-interface Props$q {
+interface Props$p {
     figure: Figure;
 }
-declare class ChartJsComponent extends Component<Props$q, SpreadsheetChildEnv> {
+declare class ChartJsComponent extends Component<Props$p, SpreadsheetChildEnv> {
     static template: string;
     private canvas;
     private chart?;
@@ -5351,10 +5366,10 @@ declare class ChartJsComponent extends Component<Props$q, SpreadsheetChildEnv> {
     private updateChartJs;
 }
 
-interface Props$p {
+interface Props$o {
     figure: Figure;
 }
-declare class ScorecardChart extends Component<Props$p, SpreadsheetChildEnv> {
+declare class ScorecardChart extends Component<Props$o, SpreadsheetChildEnv> {
     static template: string;
     private ctx;
     get runtime(): ScorecardChartRuntime;
@@ -5438,7 +5453,7 @@ declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
     get popoverStyle(): string;
 }
 
-interface Props$o {
+interface Props$n {
     position: DOMCoordinates;
     menuItems: FullMenuItem[];
     depth: number;
@@ -5453,7 +5468,7 @@ interface MenuState {
     scrollOffset?: Pixel;
     menuItems: FullMenuItem[];
 }
-declare class Menu extends Component<Props$o, SpreadsheetChildEnv> {
+declare class Menu extends Component<Props$n, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Menu: typeof Menu;
@@ -5496,11 +5511,11 @@ declare class Menu extends Component<Props$o, SpreadsheetChildEnv> {
     onMouseOver(menu: FullMenuItem, position: Pixel): void;
 }
 
-interface Props$n {
+interface Props$m {
     figure: Figure;
     onFigureDeleted: () => void;
 }
-declare class ChartFigure extends Component<Props$n, SpreadsheetChildEnv> {
+declare class ChartFigure extends Component<Props$m, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Menu: typeof Menu;
@@ -5518,7 +5533,7 @@ declare class ChartFigure extends Component<Props$n, SpreadsheetChildEnv> {
     get chartComponent(): new (...args: any) => Component;
 }
 
-interface Props$m {
+interface Props$l {
     position: Position;
 }
 interface Position {
@@ -5529,7 +5544,7 @@ interface State$2 {
     position: Position;
     handler: boolean;
 }
-declare class Autofill extends Component<Props$m, SpreadsheetChildEnv> {
+declare class Autofill extends Component<Props$l, SpreadsheetChildEnv> {
     static template: string;
     state: State$2;
     get style(): string;
@@ -5552,18 +5567,18 @@ declare class ClientTag extends Component<ClientTagProps, SpreadsheetChildEnv> {
     get tagStyle(): string;
 }
 
-interface Props$l {
+interface Props$k {
     values: AutocompleteValue[];
     selectedIndex: number;
     onValueSelected: (value: string) => void;
 }
-declare class TextValueProvider extends Component<Props$l> {
+declare class TextValueProvider extends Component<Props$k> {
     static template: string;
 }
 
 declare class ContentEditableHelper {
     el: HTMLElement;
-    constructor(el: HTMLElement | null);
+    constructor(el: HTMLElement);
     updateEl(el: HTMLElement): void;
     /**
      * select the text at position start to end, no matter the children
@@ -5617,7 +5632,7 @@ declare class ContentEditableHelper {
     private getStartAndEndSelection;
 }
 
-interface Props$k {
+interface Props$j {
     functionName: string;
     functionDescription: FunctionDescription;
     argToFocus: number;
@@ -5625,12 +5640,12 @@ interface Props$k {
 interface AssistantState {
     allowCellSelectionBehind: boolean;
 }
-declare class FunctionDescriptionProvider extends Component<Props$k> {
+declare class FunctionDescriptionProvider extends Component<Props$j> {
     static template: string;
     assistantState: AssistantState;
     private timeOutId;
     setup(): void;
-    getContext(): Props$k;
+    getContext(): Props$j;
     onMouseMove(): void;
 }
 
@@ -5643,13 +5658,14 @@ interface AutocompleteValue {
     text: string;
     description: string;
 }
-interface Props$j {
+interface ComposerProps {
     inputStyle: string;
     rect?: Rect;
     delimitation?: DOMDimension;
     focus: "inactive" | "cellFocus" | "contentFocus";
-    onComposerUnmounted?: () => void;
-    onComposerContentFocused: (selection: ComposerSelection) => void;
+    onComposerContentFocused: () => void;
+    onComposerCellFocused?: (content: String) => void;
+    isDefaultFocus?: boolean;
 }
 interface ComposerState$1 {
     positionStart: number;
@@ -5666,7 +5682,7 @@ interface FunctionDescriptionState {
     functionDescription: FunctionDescription;
     argToFocus: number;
 }
-declare class Composer extends Component<Props$j, SpreadsheetChildEnv> {
+declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         TextValueProvider: typeof TextValueProvider;
@@ -5674,6 +5690,7 @@ declare class Composer extends Component<Props$j, SpreadsheetChildEnv> {
     };
     static defaultProps: {
         inputStyle: string;
+        isDefaultFocus: boolean;
     };
     composerRef: {
         el: HTMLElement | null;
@@ -5701,7 +5718,8 @@ declare class Composer extends Component<Props$j, 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;
@@ -5722,8 +5740,8 @@ declare class Composer extends Component<Props$j, SpreadsheetChildEnv> {
 
 interface Props$i {
     focus: "inactive" | "cellFocus" | "contentFocus";
-    onComposerUnmounted: () => void;
-    onComposerContentFocused: (selection: ComposerSelection) => void;
+    onComposerContentFocused: () => void;
+    onComposerCellFocused: () => void;
 }
 /**
  * This component is a composer which positions itself on the grid at the anchor cell.
@@ -5734,11 +5752,16 @@ declare class GridComposer extends Component<Props$i, SpreadsheetChildEnv> {
     static components: {
         Composer: typeof Composer;
     };
-    private gridComposerRef;
-    private zone;
     private rect;
-    private composerState;
+    private isEditing;
+    get defaultRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
     setup(): void;
+    get composerProps(): ComposerProps;
     get containerStyle(): string;
     get composerStyle(): string;
 }
@@ -6401,7 +6424,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.
@@ -6448,7 +6471,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>;
@@ -6460,7 +6482,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;
@@ -6480,7 +6502,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;