@odoo/o-spreadsheet 17.1.0-alpha.4 → 17.1.0-alpha.6

package/dist/o-spreadsheet.d.ts

@@ -776,7 +776,7 @@ interface TransportService<T = any> {
 }
 
 declare class Revision implements RevisionData {
-    readonly rootCommand?: Command | "SNAPSHOT" | "REMOTE" | undefined;
+    readonly rootCommand?: Command | undefined;
     readonly timestamp?: number | undefined;
     readonly id: UID;
     readonly clientId: ClientId;
@@ -791,7 +791,7 @@ declare class Revision implements RevisionData {
      *  - clientId: Client who initiated the action
      *  - changes: List of changes applied on the state.
      */
-    constructor(id: UID, clientId: ClientId, commands: readonly CoreCommand[], rootCommand?: Command | "SNAPSHOT" | "REMOTE" | undefined, changes?: readonly HistoryChange[], timestamp?: number | undefined);
+    constructor(id: UID, clientId: ClientId, commands: readonly CoreCommand[], rootCommand?: Command | undefined, changes?: readonly HistoryChange[], timestamp?: number | undefined);
     setChanges(changes: readonly HistoryChange[]): void;
     get commands(): readonly CoreCommand[];
     get changes(): readonly HistoryChange[];
@@ -820,6 +820,7 @@ declare class Session extends EventBus<CollaborativeEvent> {
     private isReplayingInitialRevisions;
     private processedRevisions;
     private uuidGenerator;
+    private lastLocalOperation;
     /**
      * Manages the collaboration between multiple users on the same spreadsheet.
      * It can forward local state changes to other users to ensure they all eventually
@@ -861,9 +862,9 @@ declare class Session extends EventBus<CollaborativeEvent> {
     getRevisionId(): UID;
     isFullySynchronized(): boolean;
     /**
-     * Get the last local revision whose root command isn't in the given list of ignored commands
+     * Get the last local revision
      * */
-    getLastLocalNonEmptyRevision(ignoredRootCommands: CommandTypes[]): Revision | undefined;
+    getLastLocalNonEmptyRevision(): Revision | undefined;
     private _move;
     /**
      * Handles messages received from other clients in the collaborative
@@ -1615,7 +1616,7 @@ declare enum ClipboardMIMEType {
 type ClipboardContent = {
     [type in ClipboardMIMEType]?: string;
 };
-type ClipboardPasteOptions = "onlyFormat" | "onlyValue";
+type ClipboardPasteOptions = "onlyFormat" | "asValue";
 
 interface SearchOptions {
     matchCase: boolean;
@@ -1703,6 +1704,7 @@ interface MoveColumnsRowsCommand extends HeadersDependentCommand {
     type: "MOVE_COLUMNS_ROWS";
     base: HeaderIndex;
     elements: HeaderIndex[];
+    position: "before" | "after";
 }
 interface ResizeColumnsRowsCommand extends HeadersDependentCommand {
     type: "RESIZE_COLUMNS_ROWS";
@@ -1825,10 +1827,7 @@ interface DeleteFigureCommand extends SheetDependentCommand {
 interface CreateChartCommand extends SheetDependentCommand {
     type: "CREATE_CHART";
     id: UID;
-    position?: {
-        x: Pixel;
-        y: Pixel;
-    };
+    position?: DOMCoordinates;
     size?: FigureSize;
     definition: ChartDefinition;
 }
@@ -1840,10 +1839,7 @@ interface UpdateChartCommand extends SheetDependentCommand {
 interface CreateImageOverCommand extends SheetDependentCommand {
     type: "CREATE_IMAGE";
     figureId: UID;
-    position: {
-        x: Pixel;
-        y: Pixel;
-    };
+    position: DOMCoordinates;
     size: FigureSize;
     definition: Image;
 }
@@ -2599,6 +2595,7 @@ type ValueAndFormat = {
 };
 type Arg = Maybe<ValueAndFormat> | Matrix<ValueAndFormat>;
 type ArgValue = Maybe<CellValue> | Matrix<CellValue>;
+declare function isMatrix(x: any): x is Matrix<any>;
 interface HeaderDimensions {
     start: Pixel;
     size: Pixel;
@@ -4029,25 +4026,23 @@ declare class CustomColorsPlugin extends UIPlugin<CustomColorState> {
     private tryToAddColor;
 }
 
+interface EvaluationChartStyle {
+    background: Color;
+    fontColor: Color;
+}
 interface EvaluationChartState {
     charts: Record<UID, ChartRuntime | undefined>;
 }
 declare class EvaluationChartPlugin extends UIPlugin<EvaluationChartState> {
-    static getters: readonly ["getChartRuntime", "getBackgroundOfSingleCellChart"];
+    static getters: readonly ["getChartRuntime", "getStyleOfSingleCellChart"];
     charts: Record<UID, ChartRuntime | undefined>;
     private createRuntimeChart;
     handle(cmd: CoreViewCommand): void;
     getChartRuntime(figureId: UID): ChartRuntime;
     /**
-     * Get the background color of a chart based on the color of the first cell of the main range
-     * of the chart. In order of priority, it will return :
-     *
-     *  - the chart background color if one is defined
-     *  - the fill color of the cell if one is defined
-     *  - the fill color of the cell from conditional formats if one is defined
-     *  - the default chart color if no other color is defined
+     * Get the background and textColor of a chart based on the color of the first cell of the main range of the chart.
      */
-    getBackgroundOfSingleCellChart(chartBackground: Color | undefined, mainRange: Range | undefined): Color;
+    getStyleOfSingleCellChart(chartBackground: Color | undefined, mainRange: Range | undefined): EvaluationChartStyle;
     exportForExcel(data: ExcelWorkbookData): void;
 }
 
@@ -4891,18 +4886,12 @@ declare class InternalViewport {
     canScrollHorizontally: boolean;
     viewportWidth: Pixel;
     viewportHeight: Pixel;
-    offsetCorrectionX: Pixel;
-    offsetCorrectionY: Pixel;
-    constructor(getters: Getters, sheetId: UID, boundaries: Zone, sizeInGrid: {
-        width: Pixel;
-        height: Pixel;
-    }, options: {
+    private offsetCorrectionX;
+    private offsetCorrectionY;
+    constructor(getters: Getters, sheetId: UID, boundaries: Zone, sizeInGrid: DOMDimension, options: {
         canScrollVertically: boolean;
         canScrollHorizontally: boolean;
-    }, offsets: {
-        x: Pixel;
-        y: Pixel;
-    });
+    }, offsets: DOMCoordinates);
     /** Returns the maximum size (in Pixels) of the viewport relative to its allocated client size
      * When the viewport grid size is smaller than its client width (resp. height), it will return
      * the client width (resp. height).
@@ -4925,9 +4914,9 @@ declare class InternalViewport {
      * the pane that is actually displayed on the client. We therefore adjust the offset of the pane
      * until it contains the cell completely.
      */
-    adjustPosition(position?: Position$1): void;
-    adjustPositionX(targetCol: HeaderIndex): void;
-    adjustPositionY(targetRow: HeaderIndex): void;
+    adjustPosition(position: Position$1): void;
+    private adjustPositionX;
+    private adjustPositionY;
     setViewportOffset(offsetX: Pixel, offsetY: Pixel): void;
     adjustViewportZone(): void;
     /**
@@ -4938,7 +4927,6 @@ declare class InternalViewport {
     getRect(zone: Zone): Rect | undefined;
     isVisible(col: HeaderIndex, row: HeaderIndex): boolean;
     private searchHeaderIndex;
-    private get zone();
     private setViewportOffsetX;
     private setViewportOffsetY;
     /** Corrects the viewport's horizontal offset based on the current structure
@@ -6418,8 +6406,8 @@ interface Props$m {
     onCellHovered: (position: Partial<Position$1>) => void;
     onCellDoubleClicked: (col: HeaderIndex, row: HeaderIndex) => void;
     onCellClicked: (col: HeaderIndex, row: HeaderIndex, modifiers: {
-        ctrlKey: boolean;
-        shiftKey: boolean;
+        addZone: boolean;
+        expandZone: boolean;
     }) => void;
     onCellRightClicked: (col: HeaderIndex, row: HeaderIndex, coordinates: DOMCoordinates) => void;
     onGridResized: (dimension: Rect) => void;
@@ -6725,6 +6713,7 @@ declare namespace ACTION_EDIT {
 }
 
 declare const formatNumberAutomatic: ActionSpec;
+declare const formatNumberPlainText: ActionSpec;
 declare const formatNumberNumber: ActionSpec;
 declare const formatPercent: ActionSpec;
 declare const formatNumberPercent: ActionSpec;
@@ -6799,6 +6788,7 @@ declare const ACTION_FORMAT_formatNumberFullMonth: typeof formatNumberFullMonth;
 declare const ACTION_FORMAT_formatNumberFullWeekDayAndMonth: typeof formatNumberFullWeekDayAndMonth;
 declare const ACTION_FORMAT_formatNumberNumber: typeof formatNumberNumber;
 declare const ACTION_FORMAT_formatNumberPercent: typeof formatNumberPercent;
+declare const ACTION_FORMAT_formatNumberPlainText: typeof formatNumberPlainText;
 declare const ACTION_FORMAT_formatNumberShortMonth: typeof formatNumberShortMonth;
 declare const ACTION_FORMAT_formatNumberShortWeekDay: typeof formatNumberShortWeekDay;
 declare const ACTION_FORMAT_formatNumberTime: typeof formatNumberTime;
@@ -6845,6 +6835,7 @@ declare namespace ACTION_FORMAT {
     ACTION_FORMAT_formatNumberFullWeekDayAndMonth as formatNumberFullWeekDayAndMonth,
     ACTION_FORMAT_formatNumberNumber as formatNumberNumber,
     ACTION_FORMAT_formatNumberPercent as formatNumberPercent,
+    ACTION_FORMAT_formatNumberPlainText as formatNumberPlainText,
     ACTION_FORMAT_formatNumberShortMonth as formatNumberShortMonth,
     ACTION_FORMAT_formatNumberShortWeekDay as formatNumberShortWeekDay,
     ACTION_FORMAT_formatNumberTime as formatNumberTime,
@@ -7420,6 +7411,7 @@ interface ResizerState {
     draggerShadowThickness: number;
     delta: number;
     base: number;
+    position: "before" | "after";
 }
 interface ResizerProps {
     onOpenContextMenu: (type: ContextMenuType, x: Pixel, y: Pixel) => void;
@@ -7442,7 +7434,7 @@ declare abstract class AbstractResizer extends Component<ResizerProps, Spreadshe
     abstract _getMaxSize(): Pixel;
     abstract _updateSize(): void;
     abstract _moveElements(): void;
-    abstract _selectElement(index: HeaderIndex, ctrlKey: boolean): void;
+    abstract _selectElement(index: HeaderIndex, addDistinctHeader: boolean): void;
     abstract _increaseSelection(index: HeaderIndex): void;
     abstract _fitElementSize(index: HeaderIndex): void;
     abstract _getType(): ContextMenuType;
@@ -7476,7 +7468,7 @@ declare class ColResizer extends AbstractResizer {
     _getMaxSize(): Pixel;
     _updateSize(): void;
     _moveElements(): void;
-    _selectElement(index: HeaderIndex, ctrlKey: boolean): void;
+    _selectElement(index: HeaderIndex, addDistinctHeader: boolean): void;
     _increaseSelection(index: HeaderIndex): void;
     _fitElementSize(index: HeaderIndex): void;
     _getType(): ContextMenuType;
@@ -7501,7 +7493,7 @@ declare class RowResizer extends AbstractResizer {
     _getMaxSize(): Pixel;
     _updateSize(): void;
     _moveElements(): void;
-    _selectElement(index: HeaderIndex, ctrlKey: boolean): void;
+    _selectElement(index: HeaderIndex, addDistinctHeader: boolean): void;
     _increaseSelection(index: HeaderIndex): void;
     _fitElementSize(index: HeaderIndex): void;
     _getType(): ContextMenuType;
@@ -7628,9 +7620,9 @@ declare class Grid extends Component<Props$1, SpreadsheetChildEnv> {
     getClientPositionKey(client: Client): string;
     isCellHovered(col: HeaderIndex, row: HeaderIndex): boolean;
     private getGridRect;
-    onCellClicked(col: HeaderIndex, row: HeaderIndex, { ctrlKey, shiftKey }: {
-        ctrlKey: boolean;
-        shiftKey: boolean;
+    onCellClicked(col: HeaderIndex, row: HeaderIndex, { addZone, expandZone }: {
+        addZone: boolean;
+        expandZone: boolean;
     }): void;
     onCellDoubleClicked(col: HeaderIndex, row: HeaderIndex): void;
     closeOpenedPopover(): void;
@@ -7844,6 +7836,7 @@ declare const helpers: {
     colorToRGBA: typeof colorToRGBA;
     positionToZone: typeof positionToZone;
     isDefined: typeof isDefined;
+    isMatrix: typeof isMatrix;
     lazy: typeof lazy;
     genericRepeat: typeof genericRepeat;
     createAction: typeof createAction;