@odoo/o-spreadsheet 16.4.0-alpha.2 → 16.4.0-alpha.3

package/dist/o-spreadsheet.d.ts

@@ -297,7 +297,7 @@ interface XLSXExportXMLFile {
 }
 interface XLSXExportImageFile {
     path: string;
-    imagePath: string;
+    imageSrc: string;
 }
 interface XLSXExport {
     name: string;
@@ -493,6 +493,7 @@ interface Range extends Cloneable<Range> {
     readonly invalidSheetName?: string;
     /** the sheet on which the range is defined */
     readonly sheetId: UID;
+    readonly rangeData: RangeData;
 }
 interface RangeData {
     _zone: Zone | UnboundedZone;
@@ -574,6 +575,7 @@ declare type ResizeDirection = -1 | 0 | 1;
 interface Image {
     path: string;
     size: FigureSize;
+    mimetype?: string;
 }
 
 interface CellData {
@@ -2869,7 +2871,7 @@ declare class RangeAdapter implements CommandHandler<CoreCommand> {
     private getters;
     private providers;
     constructor(getters: CoreGetters);
-    static getters: readonly ["getRangeString", "getSelectionRangeString", "getRangeFromSheetXC", "createAdaptedRanges", "getRangeDataFromXc", "getRangeDataFromZone", "getRangeFromRangeData"];
+    static getters: readonly ["getRangeString", "getRangeFromSheetXC", "createAdaptedRanges", "getRangeDataFromXc", "getRangeDataFromZone", "getRangeFromRangeData", "getRangeFromZone"];
     allowDispatch(cmd: Command): CommandResult;
     beforeHandle(command: Command): void;
     handle(cmd: Command): void;
@@ -2899,10 +2901,6 @@ declare class RangeAdapter implements CommandHandler<CoreCommand> {
      * @param sheetXC the string description of a range, in the form SheetName!XC:XC
      */
     getRangeFromSheetXC(defaultSheetId: UID, sheetXC: string): RangeImpl;
-    /**
-     * Same as `getRangeString` but add all necessary merge to the range to make it a valid selection
-     */
-    getSelectionRangeString(range: Range, forSheetId: UID): string;
     /**
      * Gets the string that represents the range as it is at the moment of the call.
      * The string will be prefixed with the sheet name if the call specified a sheet id in `forSheetId`
@@ -2913,7 +2911,8 @@ declare class RangeAdapter implements CommandHandler<CoreCommand> {
      */
     getRangeString(range: Range, forSheetId: UID): string;
     getRangeDataFromXc(sheetId: UID, xc: string): RangeData;
-    getRangeDataFromZone(sheetId: UID, zone: Zone): RangeData;
+    getRangeDataFromZone(sheetId: UID, zone: Zone | UnboundedZone): RangeData;
+    getRangeFromZone(sheetId: UID, zone: Zone | UnboundedZone): Range;
     getRangeFromRangeData(data: RangeData): Range;
     /**
      * Get a Xc string that represent a part of a range
@@ -3488,7 +3487,7 @@ interface MergeState {
     readonly mergeCellMap: Record<UID, SheetMergeCellMap | undefined>;
 }
 declare class MergePlugin extends CorePlugin<MergeState> implements MergeState {
-    static getters: readonly ["isInMerge", "isInSameMerge", "isMergeHidden", "getMainCellPosition", "getBottomLeftCell", "expandZone", "doesIntersectMerge", "doesColumnsHaveCommonMerges", "doesRowsHaveCommonMerges", "getMerges", "getMerge", "getMergesInZone", "isSingleCellOrMerge"];
+    static getters: readonly ["isInMerge", "isInSameMerge", "isMergeHidden", "getMainCellPosition", "getBottomLeftCell", "expandZone", "doesIntersectMerge", "doesColumnsHaveCommonMerges", "doesRowsHaveCommonMerges", "getMerges", "getMerge", "getMergesInZone", "isSingleCellOrMerge", "getSelectionRangeString"];
     private nextId;
     readonly merges: Record<UID, Record<number, Range | undefined> | undefined>;
     readonly mergeCellMap: Record<UID, SheetMergeCellMap | undefined>;
@@ -3498,6 +3497,10 @@ declare class MergePlugin extends CorePlugin<MergeState> implements MergeState {
     getMerges(sheetId: UID): Merge[];
     getMerge({ sheetId, col, row }: CellPosition): Merge | undefined;
     getMergesInZone(sheetId: UID, zone: Zone): Merge[];
+    /**
+     * Same as `getRangeString` but add all necessary merge to the range to make it a valid selection
+     */
+    getSelectionRangeString(range: Range, forSheetId: UID): string;
     /**
      * Return true if the zone intersects an existing merge:
      * if they have at least a common cell
@@ -3565,7 +3568,7 @@ interface SheetState$1 {
     readonly cellPosition: Record<UID, CellPosition | undefined>;
 }
 declare class SheetPlugin extends CorePlugin<SheetState$1> implements SheetState$1 {
-    static getters: readonly ["getSheetName", "tryGetSheetName", "getSheet", "tryGetSheet", "getSheetIdByName", "getSheetIds", "getVisibleSheetIds", "isSheetVisible", "getEvaluationSheets", "doesHeaderExist", "getCell", "getCellPosition", "getColsZone", "getRowCells", "getRowsZone", "getNumberCols", "getNumberRows", "getNumberHeaders", "getGridLinesVisibility", "getNextSheetName", "isEmpty", "getSheetSize", "getSheetZone", "getPaneDivisions", "checkZonesExistInSheet", "getCommandZones"];
+    static getters: readonly ["getSheetName", "tryGetSheetName", "getSheet", "tryGetSheet", "getSheetIdByName", "getSheetIds", "getVisibleSheetIds", "isSheetVisible", "getEvaluationSheets", "doesHeaderExist", "getCell", "getCellPosition", "getColsZone", "getRowCells", "getRowsZone", "getNumberCols", "getNumberRows", "getNumberHeaders", "getGridLinesVisibility", "getNextSheetName", "isEmpty", "getSheetSize", "getSheetZone", "getPaneDivisions", "checkZonesExistInSheet", "getCommandZones", "getUnboundedZone"];
     readonly sheetIdsMapName: Record<string, UID | undefined>;
     readonly orderedSheetIds: UID[];
     readonly sheets: Record<UID, Sheet | undefined>;
@@ -3605,6 +3608,7 @@ declare class SheetPlugin extends CorePlugin<SheetState$1> implements SheetState
     getNextSheetName(baseName?: string): string;
     getSheetSize(sheetId: UID): ZoneDimension;
     getSheetZone(sheetId: UID): Zone;
+    getUnboundedZone(sheetId: UID, zone: Zone): UnboundedZone;
     getPaneDivisions(sheetId: UID): Readonly<PaneDivision>;
     private setPaneDivisions;
     /**
@@ -5041,7 +5045,7 @@ declare class SelectionInput extends Component<Props$D, SpreadsheetChildEnv> {
 interface Props$C {
     figureId: UID;
     definition: LineChartDefinition | BarChartDefinition | PieChartDefinition;
-    updateChart: (definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => DispatchResult;
+    updateChart: (figureId: UID, definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => DispatchResult;
 }
 declare class LineBarPieConfigPanel extends Component<Props$C, SpreadsheetChildEnv> {
     static template: string;
@@ -5190,7 +5194,7 @@ declare class ColorPickerWidget extends Component<Props$B, SpreadsheetChildEnv>
 interface Props$A {
     figureId: UID;
     definition: LineChartDefinition | BarChartDefinition | PieChartDefinition;
-    updateChart: (definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => CommandResult | CommandResult[];
+    updateChart: (figureId: UID, definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => CommandResult | CommandResult[];
 }
 declare class LineBarPieDesignPanel extends Component<Props$A, SpreadsheetChildEnv> {
     static template: string;
@@ -5209,7 +5213,7 @@ declare class LineBarPieDesignPanel extends Component<Props$A, SpreadsheetChildE
 interface Props$z {
     figureId: UID;
     definition: GaugeChartDefinition;
-    updateChart: (definition: Partial<GaugeChartDefinition>) => DispatchResult;
+    updateChart: (figureId: UID, definition: Partial<GaugeChartDefinition>) => DispatchResult;
 }
 declare class GaugeChartConfigPanel extends Component<Props$z, SpreadsheetChildEnv> {
     static template: string;
@@ -5229,7 +5233,7 @@ declare type GaugeMenu = "backgroundColor" | "sectionColor-lowerColor" | "sectio
 interface Props$y {
     figureId: UID;
     definition: GaugeChartDefinition;
-    updateChart: (definition: Partial<GaugeChartDefinition>) => DispatchResult;
+    updateChart: (figureId: UID, definition: Partial<GaugeChartDefinition>) => DispatchResult;
 }
 declare class GaugeChartDesignPanel extends Component<Props$y, SpreadsheetChildEnv> {
     static template: string;
@@ -5266,7 +5270,7 @@ declare class LineConfigPanel extends LineBarPieConfigPanel {
 interface Props$x {
     figureId: UID;
     definition: ScorecardChartDefinition;
-    updateChart: (definition: Partial<ScorecardChartDefinition>) => DispatchResult;
+    updateChart: (figureId: UID, definition: Partial<ScorecardChartDefinition>) => DispatchResult;
 }
 declare class ScorecardChartConfigPanel extends Component<Props$x, SpreadsheetChildEnv> {
     static template: string;
@@ -5292,7 +5296,7 @@ declare type ColorPickerId = undefined | "backgroundColor" | "baselineColorUp" |
 interface Props$w {
     figureId: UID;
     definition: ScorecardChartDefinition;
-    updateChart: (definition: Partial<ScorecardChartDefinition>) => DispatchResult;
+    updateChart: (figureId: UID, definition: Partial<ScorecardChartDefinition>) => DispatchResult;
 }
 declare class ScorecardChartDesignPanel extends Component<Props$w, SpreadsheetChildEnv> {
     static template: string;
@@ -6473,18 +6477,20 @@ declare class ContentEditableHelper {
      */
     private findChildAtCharacterIndex;
     /**
-     * Sets (or Replaces all) the text inside the root element in the form of distinctive
+     * Sets (or Replaces all) the text inside the root element in the form of distinctive paragraphs and
      * span for each element provided in `contents`.
      *
+     * The function will apply the diff between the current content and the new content to avoid the systematic
+     * destruction of DOM elements which interferes with IME[1]
+     *
+     * Each line of text will be encapsulated in a paragraph element.
      * Each span will have its own fontcolor and specific class if provided in the HtmlContent object.
+     *
+     * [1] https://developer.mozilla.org/en-US/docs/Glossary/Input_method_editor
      */
     setText(contents: HtmlContent[][]): void;
     scrollSelectionIntoView(): void;
-    /**
-     * remove the current selection of the user
-     * */
-    removeSelection(): void;
-    removeAll(): void;
+    private removeAll;
     /**
      * finds the indexes of the current selection.
      * */
@@ -6579,7 +6585,6 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     composerState: ComposerState$1;
     autoCompleteState: AutoCompleteState;
     functionDescriptionState: FunctionDescriptionState;
-    private isKeyStillDown;
     private compositionActive;
     get assistantStyle(): string;
     shouldProcessInputEvents: boolean;
@@ -6591,18 +6596,17 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     private processArrowKeys;
     private handleArrowKeysForAutocomplete;
     private processTabKey;
+    processSpaceKey(ev: KeyboardEvent): void;
     private processEnterKey;
     private processEscapeKey;
     private processF4Key;
     onCompositionStart(): void;
     onCompositionEnd(): void;
     onKeydown(ev: KeyboardEvent): void;
-    onInput(): void;
-    onKeyup(ev: KeyboardEvent): void;
+    onInput(ev: InputEvent): void;
+    onKeyup(): void;
     showAutocomplete(searchTerm: string): void;
-    onMousedown(ev: MouseEvent): void;
     onClick(): void;
-    onBlur(): void;
     private processContent;
     /**
      * Get the HTML content corresponding to the current composer token, divided by lines.
@@ -7038,11 +7042,9 @@ interface Props {
 declare class ChartPanel extends Component<Props, SpreadsheetChildEnv> {
     static template: string;
     private state;
-    private shouldUpdateChart;
     get figureId(): UID;
-    get sheetId(): UID;
     setup(): void;
-    updateChart<T extends ChartDefinition>(updateDefinition: Partial<T>): DispatchResult | undefined;
+    updateChart<T extends ChartDefinition>(figureId: UID, updateDefinition: Partial<T>): DispatchResult | undefined;
     onTypeChange(type: ChartType): void;
     get chartPanel(): ChartSidePanel;
     private getChartDefinition;