@odoo/o-spreadsheet 16.0.31 → 16.0.32

package/dist/o-spreadsheet.d.ts

@@ -2,6 +2,12 @@ import * as _odoo_owl from '@odoo/owl';
 import { ComponentConstructor, EventBus as EventBus$1, Component } from '@odoo/owl';
 import { ChartConfiguration, ChartData, ChartDataSets, ChartOptions } from 'chart.js';
 
+declare class FocusableElement {
+    private focusableElement;
+    setFocusableElement(element: HTMLElement): void;
+    focus(): void;
+}
+
 type TranslationFunction = (string: string, ...values: string[] | [{
     [key: string]: string;
 }]) => string;
@@ -41,6 +47,7 @@ interface SpreadsheetChildEnv extends SpreadsheetEnv {
     toggleSidePanel: (panel: string, panelProps?: any) => void;
     clipboard: Clipboard;
     _t: TranslationFunction;
+    focusableElement: FocusableElement;
 }
 
 declare enum CellErrorLevel {
@@ -375,6 +382,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;
 }
 
@@ -1294,7 +1305,6 @@ declare class EditionPlugin extends UIPlugin {
     allowDispatch(cmd: Command): CommandResult;
     private handleEvent;
     handle(cmd: Command): void;
-    unsubscribe(): void;
     getEditionMode(): EditionMode;
     getCurrentContent(): string;
     getEditionSheet(): string;
@@ -4164,7 +4174,6 @@ declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<S
     constructor(getters: Getters, state: StateObserver, dispatch: CommandDispatcher["dispatch"], config: ModelConfig, selection: SelectionStreamProcessor, initialRanges: string[], inputHasSingleRange: boolean);
     handleEvent(event: SelectionEvent): void;
     handle(cmd: Command): void;
-    unsubscribe(): void;
     getSelectionInputValue(): string[];
     getSelectionInputHighlights(): Highlight$1[];
     /**
@@ -4226,7 +4235,6 @@ declare class SelectionInputsManagerPlugin extends UIPlugin {
     constructor(getters: Getters, state: StateObserver, dispatch: CommandDispatcher["dispatch"], config: ModelConfig, selection: SelectionStreamProcessor);
     allowDispatch(cmd: Command): CommandResult;
     handle(cmd: Command): void;
-    unsubscribe(): void;
     /**
      * Return a list of all valid XCs.
      * e.g. ["A1", "Sheet2!B3", "E12"]
@@ -4859,7 +4867,7 @@ interface ChartBuilder {
     name: string;
 }
 
-interface Props$y {
+interface Props$x {
     ranges: string[];
     hasSingleRange?: boolean;
     required?: boolean;
@@ -4880,7 +4888,7 @@ interface SelectionRange extends Omit<RangeInputValue, "color"> {
  * onSelectionChanged is called every time the input value
  * changes.
  */
-declare class SelectionInput extends Component<Props$y, SpreadsheetChildEnv> {
+declare class SelectionInput extends Component<Props$x, SpreadsheetChildEnv> {
     static template: string;
     private id;
     private previousRanges;
@@ -4904,12 +4912,12 @@ declare class SelectionInput extends Component<Props$y, SpreadsheetChildEnv> {
     confirm(): void;
 }
 
-interface Props$x {
+interface Props$w {
     figureId: UID;
     definition: LineChartDefinition | BarChartDefinition | PieChartDefinition;
     updateChart: (figureId: UID, definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => DispatchResult;
 }
-declare class LineBarPieConfigPanel extends Component<Props$x, SpreadsheetChildEnv> {
+declare class LineBarPieConfigPanel extends Component<Props$w, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         SelectionInput: typeof SelectionInput;
@@ -4965,12 +4973,12 @@ declare class ColorPicker extends Component<ColorPickerProps, SpreadsheetChildEn
     isSameColor(color1: Color, color2: Color): boolean;
 }
 
-interface Props$w {
+interface Props$v {
     figureId: UID;
     definition: LineChartDefinition | BarChartDefinition | PieChartDefinition;
     updateChart: (figureId: UID, definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => CommandResult | CommandResult[];
 }
-declare class LineBarPieDesignPanel extends Component<Props$w, SpreadsheetChildEnv> {
+declare class LineBarPieDesignPanel extends Component<Props$v, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         ColorPicker: typeof ColorPicker;
@@ -4984,12 +4992,12 @@ declare class LineBarPieDesignPanel extends Component<Props$w, SpreadsheetChildE
     updateSelect(attr: string, ev: any): void;
 }
 
-interface Props$v {
+interface Props$u {
     figureId: UID;
     definition: GaugeChartDefinition;
     updateChart: (figureId: UID, definition: Partial<GaugeChartDefinition>) => DispatchResult;
 }
-declare class GaugeChartConfigPanel extends Component<Props$v, SpreadsheetChildEnv> {
+declare class GaugeChartConfigPanel extends Component<Props$u, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         SelectionInput: typeof SelectionInput;
@@ -5003,12 +5011,12 @@ declare class GaugeChartConfigPanel extends Component<Props$v, SpreadsheetChildE
 }
 
 type GaugeMenu = "backgroundColor" | "sectionColor-lowerColor" | "sectionColor-middleColor" | "sectionColor-upperColor";
-interface Props$u {
+interface Props$t {
     figureId: UID;
     definition: GaugeChartDefinition;
     updateChart: (figureId: UID, definition: Partial<GaugeChartDefinition>) => DispatchResult;
 }
-declare class GaugeChartDesignPanel extends Component<Props$u, SpreadsheetChildEnv> {
+declare class GaugeChartDesignPanel extends Component<Props$t, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         ColorPicker: typeof ColorPicker;
@@ -5041,12 +5049,12 @@ declare class LineConfigPanel extends LineBarPieConfigPanel {
     onUpdateCumulative(ev: any): void;
 }
 
-interface Props$t {
+interface Props$s {
     figureId: UID;
     definition: ScorecardChartDefinition;
     updateChart: (figureId: UID, definition: Partial<ScorecardChartDefinition>) => DispatchResult;
 }
-declare class ScorecardChartConfigPanel extends Component<Props$t, SpreadsheetChildEnv> {
+declare class ScorecardChartConfigPanel extends Component<Props$s, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         SelectionInput: typeof SelectionInput;
@@ -5065,12 +5073,12 @@ declare class ScorecardChartConfigPanel extends Component<Props$t, SpreadsheetCh
 }
 
 type ColorPickerId = undefined | "backgroundColor" | "baselineColorUp" | "baselineColorDown";
-interface Props$s {
+interface Props$r {
     figureId: UID;
     definition: ScorecardChartDefinition;
     updateChart: (figureId: UID, definition: Partial<ScorecardChartDefinition>) => DispatchResult;
 }
-declare class ScorecardChartDesignPanel extends Component<Props$s, SpreadsheetChildEnv> {
+declare class ScorecardChartDesignPanel extends Component<Props$r, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         ColorPicker: typeof ColorPicker;
@@ -5178,10 +5186,10 @@ interface AutofillRule {
     sequence: number;
 }
 
-interface Props$r {
+interface Props$q {
     figure: Figure;
 }
-declare class ChartJsComponent extends Component<Props$r, SpreadsheetChildEnv> {
+declare class ChartJsComponent extends Component<Props$q, SpreadsheetChildEnv> {
     static template: string;
     private canvas;
     private chart?;
@@ -5193,10 +5201,10 @@ declare class ChartJsComponent extends Component<Props$r, SpreadsheetChildEnv> {
     private updateChartJs;
 }
 
-interface Props$q {
+interface Props$p {
     figure: Figure;
 }
-declare class ScorecardChart extends Component<Props$q, SpreadsheetChildEnv> {
+declare class ScorecardChart extends Component<Props$p, SpreadsheetChildEnv> {
     static template: string;
     private ctx;
     get runtime(): ScorecardChartRuntime;
@@ -5243,7 +5251,7 @@ declare enum ComponentsImportance {
     ChartAnchor = 1000
 }
 
-interface Props$p {
+interface Props$o {
     /**
      * Coordinates are expressed relative to the "body" element.
      */
@@ -5264,7 +5272,7 @@ interface Props$p {
     onMouseWheel: (ev: WheelEvent) => void;
     zIndex: Number;
 }
-declare class Popover extends Component<Props$p, SpreadsheetChildEnv> {
+declare class Popover extends Component<Props$o, SpreadsheetChildEnv> {
     static template: string;
     static defaultProps: {
         flipHorizontalOffset: number;
@@ -5284,7 +5292,7 @@ declare class Popover extends Component<Props$p, SpreadsheetChildEnv> {
     private verticalPosition;
 }
 
-interface Props$o {
+interface Props$n {
     position: DOMCoordinates;
     menuItems: FullMenuItem[];
     depth: number;
@@ -5299,7 +5307,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;
     MENU_WIDTH: number;
     static components: {
@@ -5352,12 +5360,12 @@ declare class Menu extends Component<Props$o, SpreadsheetChildEnv> {
     onMouseOver(menu: FullMenuItem, position: Pixel): void;
 }
 
-interface Props$n {
+interface Props$m {
     figure: Figure;
     sidePanelIsOpen: boolean;
     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;
@@ -5375,7 +5383,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 {
@@ -5386,7 +5394,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;
@@ -5414,7 +5422,7 @@ interface AutocompleteValue {
     text: string;
     description: string;
 }
-interface Props$l {
+interface Props$k {
     provider: string;
     filter?: (searchTerm: string, vals: AutocompleteValue[]) => AutocompleteValue[];
     search: string;
@@ -5427,7 +5435,7 @@ interface TextValueProviderApi {
     moveDown: () => void;
     getValueToFill: () => string | undefined;
 }
-declare class TextValueProvider extends Component<Props$l> implements TextValueProviderApi {
+declare class TextValueProvider extends Component<Props$k> implements TextValueProviderApi {
     static template: string;
     state: {
         values: AutocompleteValue[];
@@ -5444,7 +5452,7 @@ declare class TextValueProvider extends Component<Props$l> implements TextValueP
 
 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
@@ -5498,7 +5506,7 @@ declare class ContentEditableHelper {
     private getStartAndEndSelection;
 }
 
-interface Props$k {
+interface Props$j {
     functionName: string;
     functionDescription: FunctionDescription;
     argToFocus: number;
@@ -5507,12 +5515,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;
 }
 
@@ -5521,13 +5529,14 @@ type HtmlContent = {
     color?: Color;
     class?: 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;
@@ -5544,7 +5553,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;
@@ -5553,6 +5562,7 @@ declare class Composer extends Component<Props$j, SpreadsheetChildEnv> {
     static defaultProps: {
         inputStyle: string;
         focus: string;
+        isDefaultFocus: boolean;
     };
     composerRef: {
         el: HTMLElement | null;
@@ -5581,7 +5591,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;
     onMousedown(ev: MouseEvent): void;
     onClick(): void;
@@ -5603,7 +5614,8 @@ declare class Composer extends Component<Props$j, SpreadsheetChildEnv> {
 interface Props$i {
     focus: "inactive" | "cellFocus" | "contentFocus";
     content: string;
-    onComposerUnmounted: () => void;
+    onComposerContentFocused: () => void;
+    onComposerCellFocused: () => void;
 }
 /**
  * This component is a composer which positions itself on the grid at the anchor cell.
@@ -5614,11 +5626,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;
 }
@@ -6110,7 +6127,6 @@ declare class Grid extends Component<Props$5, SpreadsheetChildEnv> {
     readonly HEADER_WIDTH = 48;
     private menuState;
     private gridRef;
-    private hiddenInput;
     onMouseWheel: (ev: WheelEvent) => void;
     canvasPosition: DOMCoordinates;
     hoveredCell: Partial<Position$1>;
@@ -6122,7 +6138,7 @@ declare class Grid extends Component<Props$5, SpreadsheetChildEnv> {
     get gridOverlayDimensions(): string;
     onClosePopover(): void;
     private keyDownMapping;
-    focus(): void;
+    focusDefaultElement(): void;
     get gridEl(): HTMLElement;
     getAutofillPosition(): {
         left: number;
@@ -6141,7 +6157,6 @@ declare class Grid extends Component<Props$5, 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;
@@ -6464,7 +6479,7 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
     save(): 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.