@odoo/o-spreadsheet 16.1.27 → 16.1.31

package/dist/o-spreadsheet.d.ts

@@ -202,6 +202,33 @@ declare function toCartesian(xc: string): Position$1;
  */
 declare function toXC(col: HeaderIndex, row: HeaderIndex, rangePart?: RangePart): string;
 
+/**
+ * A DateTime object that can be used to manipulate spreadsheet dates.
+ * Conceptually, a spreadsheet date is simply a number with a date format,
+ * and it is timezone-agnostic.
+ * This DateTime object consistently uses UTC time to represent a naive date and time.
+ */
+declare class DateTime {
+    private jsDate;
+    constructor(year: number, month: number, day: number, hours?: number, minutes?: number, seconds?: number);
+    static fromTimestamp(timestamp: number): DateTime;
+    static now(): DateTime;
+    toString(): string;
+    getTime(): number;
+    getFullYear(): number;
+    getMonth(): number;
+    getDate(): number;
+    getDay(): number;
+    getHours(): number;
+    getMinutes(): number;
+    getSeconds(): number;
+    setFullYear(year: number): void;
+    setDate(date: number): void;
+    setHours(hours: number): void;
+    setMinutes(minutes: number): void;
+    setSeconds(seconds: number): void;
+}
+
 /**
  * Formats a cell value with its format.
  */
@@ -1194,7 +1221,7 @@ declare class StateObserver {
         commands: CoreCommand[];
     };
     addCommand(command: CoreCommand): void;
-    addChange(...args: any[]): void;
+    addChange(...args: [...HistoryChange["path"], any]): void;
 }
 
 interface Validator {
@@ -1626,6 +1653,7 @@ interface MoveColumnsRowsCommand extends GridDependentCommand {
     type: "MOVE_COLUMNS_ROWS";
     base: HeaderIndex;
     elements: HeaderIndex[];
+    position: "before" | "after";
 }
 interface ResizeColumnsRowsCommand extends GridDependentCommand {
     type: "RESIZE_COLUMNS_ROWS";
@@ -2259,7 +2287,8 @@ declare const enum CommandResult {
     DuplicatedChartId = 84,
     ChartDoesNotExist = 85,
     InvalidHeaderIndex = 86,
-    InvalidQuantity = 87
+    InvalidQuantity = 87,
+    NoChanges = 88
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -3043,7 +3072,8 @@ interface BordersPluginState {
 declare class BordersPlugin extends CorePlugin<BordersPluginState> implements BordersPluginState {
     static getters: readonly ["getCellBorder"];
     readonly borders: BordersPluginState["borders"];
-    handle(cmd: Command): void;
+    allowDispatch(cmd: CoreCommand): CommandResult.Success | CommandResult.NoChanges;
+    handle(cmd: CoreCommand): void;
     /**
      * Move borders according to the inserted columns.
      * Ensure borders continuity.
@@ -3140,6 +3170,7 @@ declare class BordersPlugin extends CorePlugin<BordersPluginState> implements Bo
      * Compute the borders to add to the given zone merged.
      */
     private addBordersToMerge;
+    private checkBordersUnchanged;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
     exportForExcel(data: ExcelWorkbookData): void;
@@ -3164,7 +3195,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
         };
     };
     adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID): void;
-    allowDispatch(cmd: CoreCommand): CommandResult;
+    allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     /**
      * Set a format to all the cells in a zone
@@ -3237,6 +3268,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
     private createFormulaCellWithDependencies;
     private createErrorFormula;
     private checkCellOutOfSheet;
+    private checkUselessClearCell;
 }
 
 /**
@@ -3745,15 +3777,6 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
      */
     private moveCellOnRowsDeletion;
     private updateRowsStructureOnDeletion;
-    /**
-     * Update the rows of the sheet after an addition:
-     * - Rename the rows
-     *
-     * @param sheet Sheet on which the deletion occurs
-     * @param addedRow Index of the added row
-     * @param rowsToAdd Number of the rows to add
-     */
-    private updateRowsStructureOnAddition;
     /**
      * Add empty rows at the end of the rows
      *
@@ -3801,7 +3824,7 @@ declare class EvaluationPlugin extends UIPlugin {
     constructor(config: UIPluginConfig);
     handle(cmd: Command): void;
     finalize(): void;
-    evaluateFormula(formulaString: string, sheetId?: UID): any;
+    evaluateFormula(formulaString: string, sheetId?: UID): FunctionReturnValue | null;
     /**
      * Return the value of each cell in the range as they are displayed in the grid.
      */
@@ -4806,8 +4829,7 @@ type Getters = {
 } & LocalHistoryGetters & CoreGetters & SessionGetters & AutofillGetters & AutomaticSumGetters & ClipboardGetters & EditionGetters & EvaluationGetters & EvaluationChartGetters & EvaluationConditionalFormatGetters & FindAndReplaceGetters & HighlightGetters & CustomColorsGetters & RendererGetters & SelectionGetters & SelectionInputGetters & SelectionMultiUserGetters & SortGetters & UIOptionsGetters & SheetUIGetters & ViewportGetters & CellPopoverPluginGetters & FilterEvaluationGetters & HeaderVisibilityIUIGetters;
 
 interface HistoryChange {
-    root: any;
-    path: (string | number)[];
+    path: [any, ...(number | string)[]];
     before: any;
     after: any;
 }
@@ -5885,8 +5907,8 @@ interface Props$d {
     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: DOMDimension) => void;
@@ -5943,6 +5965,7 @@ interface ResizerState {
     draggerShadowThickness: number;
     delta: number;
     base: number;
+    position: "before" | "after";
 }
 interface ResizerProps {
     onOpenContextMenu: (type: ContextMenuType, x: Pixel, y: Pixel) => void;
@@ -5965,7 +5988,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;
@@ -5999,7 +6022,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;
@@ -6024,7 +6047,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;
@@ -6449,9 +6472,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;
@@ -6486,7 +6509,7 @@ declare class ChartPanel extends Component<Props, SpreadsheetChildEnv> {
 declare function toNumber(value: string | number | boolean | null | undefined): number;
 declare function toString(value: string | number | boolean | null | undefined): string;
 declare function toBoolean(value: string | number | boolean | null | undefined): boolean;
-declare function toJsDate(value: string | number | boolean | null | undefined): Date;
+declare function toJsDate(value: string | number | boolean | null | undefined): DateTime;
 
 /**
  * This function is meant to be used as a tag for a template strings.