@odoo/o-spreadsheet 16.3.18 → 16.3.24

package/dist/o-spreadsheet.d.ts

@@ -911,6 +911,34 @@ 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;
+    toLocaleDateString(): 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.
  */
@@ -1709,6 +1737,7 @@ interface MoveColumnsRowsCommand extends GridDependentCommand {
     type: "MOVE_COLUMNS_ROWS";
     base: HeaderIndex;
     elements: HeaderIndex[];
+    position: "before" | "after";
 }
 interface ResizeColumnsRowsCommand extends GridDependentCommand {
     type: "RESIZE_COLUMNS_ROWS";
@@ -2297,69 +2326,70 @@ declare const enum CommandResult {
     InvalidFigureId = 28,
     InputAlreadyFocused = 29,
     MaximumRangesReached = 30,
-    InvalidChartDefinition = 31,
-    InvalidDataSet = 32,
-    InvalidLabelRange = 33,
-    InvalidScorecardKeyValue = 34,
-    InvalidScorecardBaseline = 35,
-    InvalidGaugeDataRange = 36,
-    EmptyGaugeRangeMin = 37,
-    GaugeRangeMinNaN = 38,
-    EmptyGaugeRangeMax = 39,
-    GaugeRangeMaxNaN = 40,
-    GaugeRangeMinBiggerThanRangeMax = 41,
-    GaugeLowerInflectionPointNaN = 42,
-    GaugeUpperInflectionPointNaN = 43,
-    GaugeLowerBiggerThanUpper = 44,
-    InvalidAutofillSelection = 45,
-    WrongComposerSelection = 46,
-    MinBiggerThanMax = 47,
-    LowerBiggerThanUpper = 48,
-    MidBiggerThanMax = 49,
-    MinBiggerThanMid = 50,
-    FirstArgMissing = 51,
-    SecondArgMissing = 52,
-    MinNaN = 53,
-    MidNaN = 54,
-    MaxNaN = 55,
-    ValueUpperInflectionNaN = 56,
-    ValueLowerInflectionNaN = 57,
-    MinInvalidFormula = 58,
-    MidInvalidFormula = 59,
-    MaxInvalidFormula = 60,
-    ValueUpperInvalidFormula = 61,
-    ValueLowerInvalidFormula = 62,
-    InvalidSortZone = 63,
-    WaitingSessionConfirmation = 64,
-    MergeOverlap = 65,
-    TooManyHiddenElements = 66,
-    Readonly = 67,
-    InvalidViewportSize = 68,
-    InvalidScrollingDirection = 69,
-    FigureDoesNotExist = 70,
-    InvalidConditionalFormatId = 71,
-    InvalidCellPopover = 72,
-    EmptyTarget = 73,
-    InvalidFreezeQuantity = 74,
-    FrozenPaneOverlap = 75,
-    ValuesNotChanged = 76,
-    InvalidFilterZone = 77,
-    FilterOverlap = 78,
-    FilterNotFound = 79,
-    MergeInFilter = 80,
-    NonContinuousTargets = 81,
-    DuplicatedFigureId = 82,
-    InvalidSelectionStep = 83,
-    DuplicatedChartId = 84,
-    ChartDoesNotExist = 85,
-    InvalidHeaderIndex = 86,
-    InvalidQuantity = 87,
-    MoreThanOneColumnSelected = 88,
-    EmptySplitSeparator = 89,
-    SplitWillOverwriteContent = 90,
-    NoSplitSeparatorInSelection = 91,
-    NoActiveSheet = 92,
-    NoChanges = 93
+    InvalidInputId = 31,
+    InvalidChartDefinition = 32,
+    InvalidDataSet = 33,
+    InvalidLabelRange = 34,
+    InvalidScorecardKeyValue = 35,
+    InvalidScorecardBaseline = 36,
+    InvalidGaugeDataRange = 37,
+    EmptyGaugeRangeMin = 38,
+    GaugeRangeMinNaN = 39,
+    EmptyGaugeRangeMax = 40,
+    GaugeRangeMaxNaN = 41,
+    GaugeRangeMinBiggerThanRangeMax = 42,
+    GaugeLowerInflectionPointNaN = 43,
+    GaugeUpperInflectionPointNaN = 44,
+    GaugeLowerBiggerThanUpper = 45,
+    InvalidAutofillSelection = 46,
+    WrongComposerSelection = 47,
+    MinBiggerThanMax = 48,
+    LowerBiggerThanUpper = 49,
+    MidBiggerThanMax = 50,
+    MinBiggerThanMid = 51,
+    FirstArgMissing = 52,
+    SecondArgMissing = 53,
+    MinNaN = 54,
+    MidNaN = 55,
+    MaxNaN = 56,
+    ValueUpperInflectionNaN = 57,
+    ValueLowerInflectionNaN = 58,
+    MinInvalidFormula = 59,
+    MidInvalidFormula = 60,
+    MaxInvalidFormula = 61,
+    ValueUpperInvalidFormula = 62,
+    ValueLowerInvalidFormula = 63,
+    InvalidSortZone = 64,
+    WaitingSessionConfirmation = 65,
+    MergeOverlap = 66,
+    TooManyHiddenElements = 67,
+    Readonly = 68,
+    InvalidViewportSize = 69,
+    InvalidScrollingDirection = 70,
+    FigureDoesNotExist = 71,
+    InvalidConditionalFormatId = 72,
+    InvalidCellPopover = 73,
+    EmptyTarget = 74,
+    InvalidFreezeQuantity = 75,
+    FrozenPaneOverlap = 76,
+    ValuesNotChanged = 77,
+    InvalidFilterZone = 78,
+    FilterOverlap = 79,
+    FilterNotFound = 80,
+    MergeInFilter = 81,
+    NonContinuousTargets = 82,
+    DuplicatedFigureId = 83,
+    InvalidSelectionStep = 84,
+    DuplicatedChartId = 85,
+    ChartDoesNotExist = 86,
+    InvalidHeaderIndex = 87,
+    InvalidQuantity = 88,
+    MoreThanOneColumnSelected = 89,
+    EmptySplitSeparator = 90,
+    SplitWillOverwriteContent = 91,
+    NoSplitSeparatorInSelection = 92,
+    NoActiveSheet = 93,
+    NoChanges = 94
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -2893,8 +2923,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;
@@ -3113,7 +3144,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;
     /**
@@ -3723,7 +3754,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.
      */
@@ -4384,7 +4415,7 @@ interface RangeInputValue {
  * This plugin handles this internal state.
  */
 declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<SelectionEvent> {
-    private readonly inputHasSingleRange;
+    readonly inputHasSingleRange: boolean;
     static layers: LAYERS[];
     static getters: never[];
     ranges: RangeInputValue[];
@@ -4392,7 +4423,6 @@ declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<S
     private activeSheet;
     private willAddNewRange;
     constructor(config: UIPluginConfig, initialRanges: string[], inputHasSingleRange: boolean);
-    allowDispatch(cmd: LocalCommand): CommandResult;
     handleEvent(event: SelectionEvent): void;
     handle(cmd: Command): void;
     getSelectionInputValue(): string[];
@@ -5932,8 +5962,8 @@ interface Props$j {
     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;
@@ -6790,6 +6820,7 @@ interface ResizerState {
     draggerShadowThickness: number;
     delta: number;
     base: number;
+    position: "before" | "after";
 }
 interface ResizerProps {
     onOpenContextMenu: (type: ContextMenuType, x: Pixel, y: Pixel) => void;
@@ -6812,7 +6843,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;
@@ -6846,7 +6877,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;
@@ -6871,7 +6902,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;
@@ -6998,9 +7029,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;
@@ -7037,7 +7068,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;
 
 declare function arg(definition: string, description?: string): ArgDefinition;