@odoo/o-spreadsheet 19.1.0-alpha.12 → 19.1.0-alpha.14

package/dist/o-spreadsheet-engine.d.ts

@@ -120,7 +120,7 @@ declare enum CellValueType {
  * formulas.
  */
 declare const POSTFIX_UNARY_OPERATORS: string[];
-type TokenType = "OPERATOR" | "NUMBER" | "STRING" | "SYMBOL" | "SPACE" | "DEBUGGER" | "ARG_SEPARATOR" | "LEFT_PAREN" | "RIGHT_PAREN" | "REFERENCE" | "INVALID_REFERENCE" | "UNKNOWN";
+type TokenType = "OPERATOR" | "NUMBER" | "STRING" | "SYMBOL" | "SPACE" | "DEBUGGER" | "ARG_SEPARATOR" | "ARRAY_ROW_SEPARATOR" | "LEFT_PAREN" | "RIGHT_PAREN" | "LEFT_BRACE" | "RIGHT_BRACE" | "REFERENCE" | "INVALID_REFERENCE" | "UNKNOWN";
 interface Token {
     readonly type: TokenType;
     readonly value: string;
@@ -1190,7 +1190,7 @@ declare class MergePlugin extends CorePlugin<MergeState> implements MergeState {
 }
 
 type Aggregator = "array_agg" | "count" | "count_distinct" | "bool_and" | "bool_or" | "max" | "min" | "avg" | "sum";
-type Granularity = "day" | "week" | "month" | "quarter" | "year" | "second_number" | "minute_number" | "hour_number" | "day_of_week" | "day_of_month" | "iso_week_number" | "month_number" | "quarter_number";
+type Granularity = "day" | "month" | "year" | "second_number" | "minute_number" | "hour_number" | "day_of_week" | "day_of_month" | "iso_week_number" | "month_number" | "quarter_number";
 interface PivotCoreDimension {
     fieldName: string;
     order?: SortDirection;
@@ -1645,6 +1645,7 @@ interface StylePluginState {
 declare class StylePlugin extends CorePlugin<StylePluginState> implements StylePluginState {
     static getters: readonly ["getCellStyle", "getCellStyleInZone", "getZoneStyles", "getStyleColors"];
     readonly styles: Record<UID, ZoneStyle[] | undefined>;
+    allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
     private handleAddColumnn;
@@ -1662,6 +1663,7 @@ declare class StylePlugin extends CorePlugin<StylePluginState> implements StyleP
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
     exportForExcel(data: ExcelWorkbookData): void;
+    private checkUselessSetFormatting;
 }
 
 interface TableState {
@@ -1790,29 +1792,17 @@ interface CommonChartDefinition {
     readonly humanize?: boolean;
 }
 
-interface GeoChartDefinition {
+interface GeoChartDefinition extends CommonChartDefinition {
     readonly type: "geo";
-    readonly dataSets: CustomizedDataSet[];
-    readonly dataSetsHaveTitle: boolean;
-    readonly labelRange?: string;
-    readonly title: TitleDesign;
-    readonly background?: Color;
-    readonly legendPosition: LegendPosition;
-    readonly colorScale?: GeoChartColorScale;
+    readonly colorScale?: ChartColorScale;
     readonly missingValueColor?: Color;
     readonly region?: string;
-    readonly humanize?: boolean;
+    readonly showColorBar?: boolean;
 }
 type GeoChartRuntime = {
     chartJsConfig: ChartConfiguration;
     background: Color;
 };
-interface GeoChartCustomColorScale {
-    minColor: Color;
-    midColor?: Color;
-    maxColor: Color;
-}
-type GeoChartColorScale = GeoChartCustomColorScale | "blues" | "cividis" | "greens" | "greys" | "oranges" | "purples" | "rainbow" | "reds" | "viridis";
 type GeoChartProjection = "azimuthalEqualArea" | "azimuthalEquidistant" | "gnomonic" | "orthographic" | "stereographic" | "equalEarth" | "albers" | "albersUsa" | "conicConformal" | "conicEqualArea" | "conicEquidistant" | "equirectangular" | "mercator" | "transverseMercator" | "naturalEarth1";
 interface GeoChartRegion {
     id: string;
@@ -3044,7 +3034,7 @@ type SelectionEventOptions = {
 interface SelectionEvent {
     anchor: AnchorZone;
     previousAnchor: AnchorZone;
-    mode: "newAnchor" | "overrideSelection" | "updateAnchor";
+    mode: "newAnchor" | "overrideSelection" | "updateAnchor" | "commitSelection";
     options: SelectionEventOptions;
 }
 
@@ -3054,6 +3044,7 @@ type StatefulStream<Event, State> = {
     resetDefaultAnchor: (owner: unknown, state: State) => void;
     resetAnchor: (owner: unknown, state: State) => void;
     observe: (owner: unknown, callbacks: StreamCallbacks<Event>) => void;
+    unobserve: (owner: unknown) => void;
     release: (owner: unknown) => void;
     getBackToDefault(): void;
 };
@@ -3072,6 +3063,7 @@ interface SelectionProcessor {
     selectAll(): DispatchResult;
     loopSelection(): DispatchResult;
     selectTableAroundSelection(): DispatchResult;
+    commitSelection(): DispatchResult;
     isListening(owner: unknown): boolean;
 }
 type SelectionStreamProcessor = SelectionProcessor & StatefulStream<SelectionEvent, AnchorZone>;
@@ -3484,12 +3476,16 @@ declare class UIOptionsPlugin extends UIPlugin {
 }
 
 declare class SheetUIPlugin extends UIPlugin {
-    static getters: readonly ["getCellWidth", "getTextWidth", "getCellText", "getCellMultiLineText", "getContiguousZone", "computeTextYCoordinate"];
+    static getters: readonly ["getCellWidth", "getTextWidth", "getCellText", "getCellMultiLineText", "getMultilineTextSize", "getContiguousZone", "computeTextYCoordinate"];
     private ctx;
     allowDispatch(cmd: LocalCommand): CommandResult | CommandResult[];
     handle(cmd: Command): void;
     getCellWidth(position: CellPosition): number;
     getTextWidth(text: string, style: Style): Pixel;
+    getMultilineTextSize(text: string[], style: Style): {
+        width: number;
+        height: number;
+    };
     getCellText(position: CellPosition, args?: {
         showFormula?: boolean;
         availableWidth?: number;
@@ -3544,6 +3540,7 @@ declare class CarouselUIPlugin extends UIPlugin {
     private fixWrongCarouselState;
     private addNewChartToCarousel;
     private addFigureChartToCarousel;
+    private duplicateCarouselChart;
     private getCarouselItemId;
 }
 
@@ -3892,7 +3889,7 @@ declare class InternalViewport {
  *
  */
 declare class SheetViewPlugin extends UIPlugin {
-    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "getVisibleRectWithoutHeaders", "getVisibleRectWithZoom", "getVisibleCellPositions", "getColRowOffsetInViewport", "getMainViewportCoordinates", "getActiveSheetScrollInfo", "getSheetViewVisibleCols", "getSheetViewVisibleRows", "getFrozenSheetViewRatio", "isPixelPositionVisible", "getColDimensionsInViewport", "getRowDimensionsInViewport", "getAllActiveViewportsZonesAndRect", "getRect", "getFigureUI", "getPositionAnchorOffset", "getGridOffset", "getViewportZoomLevel", "getScrollBarWidth"];
+    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "getVisibleRectWithoutHeaders", "getVisibleRectWithZoom", "getVisibleCellPositions", "getColRowOffsetInViewport", "getMainViewportCoordinates", "getActiveSheetScrollInfo", "getSheetViewVisibleCols", "getSheetViewVisibleRows", "getFrozenSheetViewRatio", "isPixelPositionVisible", "getColDimensionsInViewport", "getRowDimensionsInViewport", "getAllActiveViewportsZonesAndRect", "getRect", "getFigureUI", "getPositionAnchorOffset", "getGridOffset", "getViewportZoomLevel", "getScrollBarWidth", "getMaximumSheetOffset"];
     private viewports;
     /**
      * The viewport dimensions are usually set by one of the components
@@ -3944,7 +3941,10 @@ declare class SheetViewPlugin extends UIPlugin {
      * Return the main viewport maximum size relative to the client size.
      */
     getMainViewportRect(): Rect;
-    private getMaximumSheetOffset;
+    getMaximumSheetOffset(): {
+        maxOffsetX: Pixel;
+        maxOffsetY: Pixel;
+    };
     getColRowOffsetInViewport(dimension: Dimension, referenceHeaderIndex: HeaderIndex, targetHeaderIndex: HeaderIndex): Pixel;
     /**
      * Check if a given position is visible in the viewport.
@@ -4603,6 +4603,8 @@ type Rect = DOMCoordinates & DOMDimension;
 interface BoxTextContent {
     textLines: string[];
     width: Pixel;
+    textHeight: Pixel;
+    textWidth: Pixel;
     align: Align;
     fontSizePx: number;
     x: Pixel;
@@ -4752,6 +4754,16 @@ interface XLSXExport {
  */
 type XlsxHexColor = string & Alias;
 
+declare const CALENDAR_CHART_GRANULARITIES: Granularity[];
+type CalendarChartGranularity = (typeof CALENDAR_CHART_GRANULARITIES)[number];
+interface CalendarChartDefinition extends CommonChartDefinition {
+    readonly type: "calendar";
+    readonly horizontalGroupBy: CalendarChartGranularity;
+    readonly verticalGroupBy: CalendarChartGranularity;
+    readonly colorScale?: ChartColorScale;
+    readonly missingValueColor?: Color;
+}
+
 interface ComboChartDefinition extends CommonChartDefinition {
     readonly dataSets: ComboChartDataSet[];
     readonly type: "combo";
@@ -5106,9 +5118,9 @@ type WaterfallChartRuntime = {
     background: Color;
 };
 
-declare const CHART_TYPES: readonly ["line", "bar", "pie", "scorecard", "gauge", "scatter", "combo", "waterfall", "pyramid", "radar", "geo", "funnel", "sunburst", "treemap"];
+declare const CHART_TYPES: readonly ["line", "bar", "pie", "scorecard", "gauge", "scatter", "combo", "waterfall", "pyramid", "radar", "geo", "funnel", "sunburst", "treemap", "calendar"];
 type ChartType = (typeof CHART_TYPES)[number];
-type ChartDefinition = LineChartDefinition | PieChartDefinition | BarChartDefinition | ScorecardChartDefinition | GaugeChartDefinition | ScatterChartDefinition | ComboChartDefinition | WaterfallChartDefinition | PyramidChartDefinition | RadarChartDefinition | GeoChartDefinition | FunnelChartDefinition | SunburstChartDefinition | TreeMapChartDefinition;
+type ChartDefinition = LineChartDefinition | PieChartDefinition | BarChartDefinition | ScorecardChartDefinition | GaugeChartDefinition | ScatterChartDefinition | ComboChartDefinition | WaterfallChartDefinition | PyramidChartDefinition | RadarChartDefinition | GeoChartDefinition | FunnelChartDefinition | SunburstChartDefinition | TreeMapChartDefinition | CalendarChartDefinition;
 type ChartJSRuntime = LineChartRuntime | PieChartRuntime | BarChartRuntime | ComboChartRuntime | ScatterChartRuntime | WaterfallChartRuntime | PyramidChartRuntime | RadarChartRuntime | GeoChartRuntime | FunnelChartRuntime | SunburstChartRuntime | TreeMapChartRuntime;
 type ChartRuntime = ChartJSRuntime | ScorecardChartRuntime | GaugeChartRuntime;
 interface DatasetDesign {
@@ -5227,6 +5239,11 @@ interface ChartCreationContext {
     readonly zoomable?: boolean;
     readonly humanize?: boolean;
 }
+interface ChartColorScale {
+    minColor: Color;
+    midColor?: Color;
+    maxColor: Color;
+}
 
 /**
  * There are two kinds of commands: CoreCommands and LocalCommands
@@ -5474,6 +5491,12 @@ interface AddFigureChartToCarouselCommand extends SheetDependentCommand {
     carouselFigureId: UID;
     chartFigureId: UID;
 }
+interface DuplicateCarouselChartCommand extends SheetDependentCommand {
+    type: "DUPLICATE_CAROUSEL_CHART";
+    carouselId: UID;
+    chartId: UID;
+    duplicatedChartId: UID;
+}
 interface UpdateCarouselActiveItemCommand extends SheetDependentCommand {
     type: "UPDATE_CAROUSEL_ACTIVE_ITEM";
     figureId: UID;
@@ -5917,7 +5940,7 @@ UpdateCellCommand | UpdateCellPositionCommand | ClearCellCommand | ClearCellsCom
  | UpdateLocaleCommand
 /** PIVOT */
  | AddPivotCommand | UpdatePivotCommand | InsertPivotCommand | RenamePivotCommand | RemovePivotCommand | DuplicatePivotCommand;
-type LocalCommand = RequestUndoCommand | RequestRedoCommand | UndoCommand | RedoCommand | CopyCommand | CutCommand | PasteCommand | CopyPasteCellsAboveCommand | CopyPasteCellsOnLeftCommand | RepeatPasteCommand | CleanClipBoardHighlightCommand | AutoFillCellCommand | PasteFromOSClipboardCommand | AutoresizeColumnsCommand | AutoresizeRowsCommand | MoveColumnsRowsCommand | ActivateSheetCommand | EvaluateCellsCommand | EvaluateChartsCommand | StartChangeHighlightCommand | StartCommand | AutofillCommand | AutofillSelectCommand | AutofillTableCommand | ShowFormulaCommand | AutofillAutoCommand | SelectFigureCommand | ReplaceSearchCommand | SortCommand | SetDecimalCommand | SetContextualFormatCommand | ResizeViewportCommand | SetZoomCommand | SumSelectionCommand | DeleteCellCommand | InsertCellCommand | SetViewportOffsetCommand | MoveViewportDownCommand | MoveViewportUpCommand | MoveViewportToCellCommand | ActivateNextSheetCommand | ActivatePreviousSheetCommand | UpdateFilterCommand | SplitTextIntoColumnsCommand | RemoveDuplicatesCommand | TrimWhitespaceCommand | ResizeTableCommand | RefreshPivotCommand | InsertNewPivotCommand | DuplicatePivotInNewSheetCommand | InsertPivotWithTableCommand | SplitPivotFormulaCommand | PaintFormat | DeleteUnfilteredContentCommand | PivotStartPresenceTracking | PivotStopPresenceTracking | ToggleCheckboxCommand | AddNewChartToCarouselCommand | AddFigureChartToCarouselCommand | UpdateCarouselActiveItemCommand | PopOutChartFromCarouselCommand;
+type LocalCommand = RequestUndoCommand | RequestRedoCommand | UndoCommand | RedoCommand | CopyCommand | CutCommand | PasteCommand | CopyPasteCellsAboveCommand | CopyPasteCellsOnLeftCommand | RepeatPasteCommand | CleanClipBoardHighlightCommand | AutoFillCellCommand | PasteFromOSClipboardCommand | AutoresizeColumnsCommand | AutoresizeRowsCommand | MoveColumnsRowsCommand | ActivateSheetCommand | EvaluateCellsCommand | EvaluateChartsCommand | StartChangeHighlightCommand | StartCommand | AutofillCommand | AutofillSelectCommand | AutofillTableCommand | ShowFormulaCommand | AutofillAutoCommand | SelectFigureCommand | ReplaceSearchCommand | SortCommand | SetDecimalCommand | SetContextualFormatCommand | ResizeViewportCommand | SetZoomCommand | SumSelectionCommand | DeleteCellCommand | InsertCellCommand | SetViewportOffsetCommand | MoveViewportDownCommand | MoveViewportUpCommand | MoveViewportToCellCommand | ActivateNextSheetCommand | ActivatePreviousSheetCommand | UpdateFilterCommand | SplitTextIntoColumnsCommand | RemoveDuplicatesCommand | TrimWhitespaceCommand | ResizeTableCommand | RefreshPivotCommand | InsertNewPivotCommand | DuplicatePivotInNewSheetCommand | InsertPivotWithTableCommand | SplitPivotFormulaCommand | PaintFormat | DeleteUnfilteredContentCommand | PivotStartPresenceTracking | PivotStopPresenceTracking | ToggleCheckboxCommand | AddNewChartToCarouselCommand | AddFigureChartToCarouselCommand | DuplicateCarouselChartCommand | UpdateCarouselActiveItemCommand | PopOutChartFromCarouselCommand;
 type Command = CoreCommand | LocalCommand;
 /**
  * Holds the result of a command dispatch.
@@ -6184,6 +6207,7 @@ interface Style {
     fillColor?: Color;
     textColor?: Color;
     fontSize?: number;
+    rotation?: number;
 }
 interface DataBarFill {
     color: Color;
@@ -6475,11 +6499,15 @@ interface ASTSymbol extends ASTBase {
     type: "SYMBOL";
     value: string;
 }
+interface ASTArray extends ASTBase {
+    type: "ARRAY";
+    value: AST[][];
+}
 interface ASTEmpty extends ASTBase {
     type: "EMPTY";
     value: "";
 }
-type AST = ASTOperation | ASTUnaryOperation | ASTFuncall | ASTSymbol | ASTNumber | ASTBoolean | ASTString | ASTReference | ASTEmpty;
+type AST = ASTOperation | ASTUnaryOperation | ASTFuncall | ASTSymbol | ASTArray | ASTNumber | ASTBoolean | ASTString | ASTReference | ASTEmpty;
 declare const OP_PRIORITY: {
     "%": number;
     "^": number;