@odoo/o-spreadsheet 19.5.0-alpha.3 → 19.5.0-alpha.5

package/dist/types/components/tables/table_resizer/table_resizer.d.ts

@@ -16,6 +16,7 @@ export declare class TableResizer extends Component<SpreadsheetChildEnv> {
             clientY: number;
         }, onPointerMove: (col: HeaderIndex, row: HeaderIndex, ev: MouseEvent) => void, onPointerUp: () => void, startScrollDirection?: import("../../helpers/drag_and_drop_grid_hook").DnDDirection) => void;
     };
+    private viewStore;
     setup(): void;
     get containerStyle(): string;
     onMouseDown(ev: PointerEvent): void;

package/dist/types/components/top_bar/zoom_editor/zoom_editor.d.ts

@@ -1,7 +1,7 @@
+import { Component } from "../../../owl3_compatibility_layer";
 import { SpreadsheetChildEnv } from "../../../types/spreadsheet_env";
 import { ToolBarDropdownStore } from "../../helpers/top_bar_tool_hook";
 import { NumberEditor } from "../../number_editor/number_editor";
-import { Component } from "../../../owl3_compatibility_layer";
 export declare class ToolBarZoom extends Component<SpreadsheetChildEnv> {
     static template: string;
     static components: {
@@ -11,6 +11,7 @@ export declare class ToolBarZoom extends Component<SpreadsheetChildEnv> {
         class: string;
     }>;
     topBarToolStore: ToolBarDropdownStore;
+    private viewStore;
     valueList: number[];
     setup(): void;
     get currentFontSize(): number;

package/dist/types/formulas/compiler.d.ts

@@ -92,6 +92,7 @@ export declare class CompiledFormula implements Omit<ICompiledFormula, "tokens"
      * Make a new instance of CompiledFormula by compiling the formula string as input by the user.
      * */
     static Compile(formula: string, sheetId: UID, getters: CoreGetters): CompiledFormula;
+    areRangeShapesInLineWithNormalizedFormula(): boolean;
 }
 /**
  * A compiled formula serialized

package/dist/types/helpers/carousel_helpers.d.ts

@@ -1,6 +1,13 @@
 import { ChartDefinition } from "../types/chart/chart";
-import { CarouselItem } from "../types/figure";
+import { AnchorOffset, CarouselItem } from "../types/figure";
 import { Getters } from "../types/getters";
+import { UID } from "../types/misc";
+import { SpreadsheetChildEnv } from "../types/spreadsheet_env";
 export declare const CAROUSEL_DEFAULT_CHART_DEFINITION: ChartDefinition;
+/**
+ * Compute the anchor of a chart popped out of a carousel: slightly offset from the
+ * carousel figure so the new chart does not perfectly overlap it.
+ */
+export declare function getPoppedOutChartAnchor(env: SpreadsheetChildEnv, sheetId: UID, carouselId: UID): AnchorOffset;
 export declare function getCarouselItemPreview(getters: Getters, item: CarouselItem): string;
 export declare function getCarouselItemTitle(getters: Getters, item: CarouselItem): string;

package/dist/types/helpers/figures/charts/chart_common.d.ts

@@ -6,7 +6,6 @@ import { Getters } from "../../../types/getters";
 import { Locale } from "../../../types/locale";
 import { Color, RangeAdapterFunctions, UID } from "../../../types/misc";
 import { Range } from "../../../types/range";
-import { DOMCoordinates, DOMDimension } from "../../../types/rendering";
 import { ColorGenerator } from "../../color";
 export declare const TREND_LINE_XAXIS_ID = "x1";
 export declare const MOVING_AVERAGE_TREND_LINE_XAXIS_ID = "xMovingAverage";
@@ -47,7 +46,6 @@ export declare function chartMutedFontColor(backgroundColor: Color | undefined):
 export declare function checkDataset(dataSource: ChartRangeDataSource<string>): CommandResult;
 export declare function checkLabelRange(dataSource: ChartRangeDataSource<string>): CommandResult;
 export declare function shouldRemoveFirstLabel(numberOfLabels: number, numberOfDataPoints: number | undefined, dataSetsHaveTitle: boolean): boolean;
-export declare function getChartPositionAtCenterOfViewport(getters: Getters, chartSize: DOMDimension): DOMCoordinates;
 export declare function getDefinedAxis(definition: Partial<ChartDefinition<string | Range>>): {
     useLeftAxis: boolean;
     useRightAxis: boolean;

package/dist/types/helpers/figures/figure/figure.d.ts

@@ -1,8 +1,9 @@
 import { Position, UID } from "../../..";
 import { AnchorOffset, Figure, FigureSize } from "../../../types/figure";
 import { Getters } from "../../../types/getters";
-export declare function centerFigurePosition(getters: Getters, size: FigureSize): AnchorOffset;
-export declare function getMaxFigureSize(getters: Getters, figureSize: FigureSize): FigureSize;
+import { SpreadsheetChildEnv } from "../../../types/spreadsheet_env";
+export declare function centerFigurePosition(env: SpreadsheetChildEnv, size: FigureSize): AnchorOffset;
+export declare function getMaxFigureSize(figureSize: FigureSize): FigureSize;
 export declare function boundColRowOffsetInSheet(getters: Getters, sheetId: UID, position: Position, figure: Figure): {
     col: import("../../..").HeaderIndex;
     row: import("../../..").HeaderIndex;

package/dist/types/helpers/pivot/pivot_highlight.d.ts

@@ -1,3 +1,3 @@
-import { Getters } from "../../types/getters";
 import { Highlight, UID } from "../../types/misc";
-export declare function getPivotHighlights(getters: Getters, pivotId: UID): Highlight[];
+import { SpreadsheetChildEnv } from "../../types/spreadsheet_env";
+export declare function getPivotHighlights(env: SpreadsheetChildEnv, pivotId: UID): Highlight[];

package/dist/types/helpers/viewport_collection.d.ts

@@ -1,7 +1,6 @@
-import { CommandResult, ResizeViewportCommand, SetViewportOffsetCommand } from "../types/commands";
 import { AnchorOffset, Figure, FigureUI } from "../types/figure";
 import { RenderingGetters } from "../types/getters";
-import { CellPosition, Dimension, HeaderDimensions, HeaderIndex, PaneDivision, Pixel, PixelPosition, Position, UID, Zone } from "../types/misc";
+import { CellPosition, Dimension, HeaderDimensions, HeaderIndex, PaneDivision, Pixel, PixelPosition, Position, SheetViewDimensions, UID, Zone } from "../types/misc";
 import { DOMCoordinates, DOMDimension, EdgeScrollInfo, Rect, SheetDOMScrollInfo, Viewport } from "../types/rendering";
 import { InternalViewport } from "./internal_viewport";
 type SheetViewports = {
@@ -143,18 +142,21 @@ export declare class ViewportCollection {
     getViewportZoomLevel(): number;
     ensureMainViewportExist(sheetId: UID): void;
     getSubViewports(sheetId: UID): InternalViewport[];
-    checkPositiveDimension(cmd: ResizeViewportCommand): CommandResult.Success | CommandResult.InvalidViewportSize;
-    checkValuesAreDifferent(cmd: ResizeViewportCommand): CommandResult.Success | CommandResult.ValuesNotChanged;
+    checkPositiveDimension(dims: SheetViewDimensions): boolean;
+    checkValuesAreDifferent(dims: SheetViewDimensions): boolean;
     checkScrollingDirection(sheetId: UID, { offsetX, offsetY }: {
         offsetX: Pixel;
         offsetY: Pixel;
-    }): CommandResult;
-    checkIfViewportsWillChange(sheetId: UID, { offsetX, offsetY }: SetViewportOffsetCommand): CommandResult.Success | CommandResult.ViewportScrollLimitsReached;
+    }): boolean;
+    checkIfViewportsWillChange(sheetId: UID, { offsetX, offsetY }: {
+        offsetX: Pixel;
+        offsetY: Pixel;
+    }): boolean;
     getMainViewport(sheetId: UID): Viewport;
     getMainInternalViewport(sheetId: UID): InternalViewport;
     /** gets rid of deprecated sheetIds */
     cleanViewports(): void;
-    resizeSheetView(height: Pixel, width: Pixel, gridOffsetX?: Pixel, gridOffsetY?: Pixel): void;
+    resizeSheetView(dimensions: SheetViewDimensions): void;
     recomputeViewports(): void;
     setSheetViewOffset(sheetId: UID, offsetX: Pixel, offsetY: Pixel): void;
     getViewportOffset(sheetId: UID): {

package/dist/types/index.d.ts

@@ -228,6 +228,8 @@ import "./plugins/plugin_registries";
 import "./registries/auto_completes/autocompelete_registration";
 import "./registries/chart_types";
 import "./registries/interactive_icon_on_cell_registry";
+import { AutofillStore } from "./components/autofill/autofill_store";
+import { TableAutofillStore } from "./components/autofill/table_autofill_store";
 import { Composer } from "./components/composer/composer/composer";
 import { StandaloneComposer } from "./components/composer/standalone_composer/standalone_composer";
 import { Select } from "./components/select/select";
@@ -239,6 +241,7 @@ import { replaceSymbolInFormula } from "./helpers/formulas";
 import { getFirstPivotFunction, getNumberOfPivotFunctions } from "./helpers/pivot/pivot_composer_helpers";
 import { domainToColRowDomain } from "./helpers/pivot/pivot_domain_helpers";
 import { fuzzyLookup } from "./helpers/search";
+import { ViewportsStore } from "./stores/viewports_store";
 export declare const helpers: {
     arg: typeof arg;
     isEvaluationError: typeof isEvaluationError;
@@ -419,8 +422,11 @@ export declare const stores: {
     SidePanelStore: typeof SidePanelStore;
     PivotSidePanelStore: typeof PivotSidePanelStore;
     PivotMeasureDisplayPanelStore: typeof PivotMeasureDisplayPanelStore;
+    TableAutofillStore: typeof TableAutofillStore;
+    AutofillStore: typeof AutofillStore;
     ClientFocusStore: typeof ClientFocusStore;
     GridRenderer: typeof GridRenderer;
+    ViewportsStore: typeof ViewportsStore;
 };
 export { getCaretDownSvg, getCaretUpSvg } from "./components/icons/icons";
 export { createAutocompleteArgumentsProvider } from "./functions/autocomplete_arguments_provider";

package/dist/types/plugins/core/squisher.d.ts

@@ -30,6 +30,7 @@ export declare class Squisher {
     private alreadyAppliedNumberOffsets;
     private previousStrings;
     private baseFormulaWasTransformed;
+    private rangeToStringOptions;
     private baseNumber;
     constructor(getters: CoreGetters);
     /** Build the result object based on a transformation. Joins the numbers into a single string, tries to do the same

package/dist/types/plugins/ui_feature/figure.d.ts

@@ -1,6 +1,10 @@
 import { Command, CommandResult } from "../../types/commands";
+import { Figure, FigureUI } from "../../types/figure";
+import { UID } from "../../types/misc";
 import { UIPlugin } from "../ui_plugin";
 export declare class FigureUIPlugin extends UIPlugin {
+    static getters: readonly ["getFigureUI"];
     allowDispatch(cmd: Command): CommandResult | CommandResult[];
     handle(cmd: Command): void;
+    getFigureUI(sheetId: UID, figure: Figure): FigureUI;
 }

package/dist/types/plugins/ui_stateful/carousel_ui.d.ts

@@ -1,5 +1,5 @@
 import { SpreadsheetChart } from "../../helpers/figures/chart";
-import { Command, CommandResult, LocalCommand } from "../../types/commands";
+import { Command, CommandResult, LocalCommand, PopOutChartFromCarouselCommand } from "../../types/commands";
 import { CarouselItem } from "../../types/figure";
 import { UID } from "../../types/misc";
 import { UIPlugin } from "../ui_plugin";
@@ -8,7 +8,7 @@ export declare class CarouselUIPlugin extends UIPlugin {
     carouselStates: Record<UID, string | undefined>;
     allowDispatch(cmd: LocalCommand): CommandResult | CommandResult[];
     handle(cmd: Command): void;
-    popOutChartFromCarousel(carouselId: UID, chartId: UID, sheetId: UID): void;
+    popOutChartFromCarousel(cmd: PopOutChartFromCarouselCommand): void;
     getSelectedCarouselItem(figureId: UID): CarouselItem | undefined;
     getChartFromFigureId(figureId: UID): SpreadsheetChart | undefined;
     getChartIdFromFigureId(figureId: UID): UID | undefined;

package/dist/types/stores/array_formula_highlight.d.ts

@@ -3,7 +3,7 @@ import { Get } from "../types/store_engine";
 import { HighlightStore } from "./highlight_store";
 import { SpreadsheetStore } from "./spreadsheet_store";
 export declare class ArrayFormulaHighlight extends SpreadsheetStore {
-    protected highlightStore: import("../types/store_engine").CQS<Pick<HighlightStore, "register" | "unRegister"> & import("../types/store_engine").OmitFunctions<HighlightStore>>;
+    protected highlightStore: import("../types/store_engine").Store<HighlightStore>;
     constructor(get: Get);
     get highlights(): Highlight[];
 }

package/dist/types/{plugins/ui_feature/automatic_sum.d.ts → stores/automatic_sum_store.d.ts}

@@ -1,14 +1,15 @@
-import { Command } from "../../types/commands";
-import { Position, UID, Zone } from "../../types/misc";
-import { UIPlugin } from "../ui_plugin";
+import { Command } from "../types/commands";
+import { Position, UID, Zone } from "../types/misc";
+import { SpreadsheetStore } from "./spreadsheet_store";
 interface AutomaticSum {
     position: Position;
     zone: Zone;
 }
-export declare class AutomaticSumPlugin extends UIPlugin {
+export declare class AutomaticSumStore extends SpreadsheetStore {
     static getters: readonly ["getAutomaticSums"];
     handle(cmd: Command): void;
     getAutomaticSums(sheetId: UID, zone: Zone, anchor: Position): AutomaticSum[];
+    get automaticSumsOnMainSelectedZone(): AutomaticSum[];
     private sumData;
     private sumAdjacentData;
     /**

package/dist/types/stores/checkbox_toggle.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "../types/commands";
+import { Zone } from "../types/misc";
+import { SpreadsheetStore } from "./spreadsheet_store";
+export declare class CheckboxToggleStore extends SpreadsheetStore {
+    storeGetters: readonly ["hasBooleanValidationInZones"];
+    handle(cmd: Command): void;
+    hasBooleanValidationInZones(zones: Zone[]): boolean;
+    private toggleCheckbox;
+}

package/dist/types/stores/client_focus_store.d.ts

@@ -5,6 +5,7 @@ export declare class ClientFocusStore extends SpreadsheetStore {
     mutators: readonly ["focusClient", "unfocusClient", "showClientTag", "hideClientTag", "jumpToClient"];
     private _showClientTag;
     private clientFocusTimeout;
+    private viewStore;
     constructor(get: Get);
     get focusedClients(): Set<ClientId>;
     jumpToClient(clientId: ClientId): void;

package/dist/types/stores/data_cleanup_store.d.ts

@@ -0,0 +1,31 @@
+import { CancelledReason, Command } from "../types/commands";
+import { Get } from "../types/store_engine";
+import { SpreadsheetStore } from "./spreadsheet_store";
+export declare class DataCleanupStore extends SpreadsheetStore {
+    mutators: readonly ["setHasHeader", "setColumns", "toggleAllColumns", "toggleColumn"];
+    private notificationStore;
+    hasHeader: boolean;
+    columns: {
+        [colIndex: number]: boolean;
+    };
+    constructor(get: Get);
+    private updateColumns;
+    setHasHeader(hasHeader: boolean): void;
+    setColumns(columns: {
+        [colIndex: number]: boolean;
+    }): void;
+    toggleAllColumns(): void;
+    toggleColumn(colIndex: number): void;
+    private get isEveryColumnSelected();
+    get removeDuplicateErrors(): CancelledReason[];
+    handle(cmd: Command): void;
+    private removeDuplicates;
+    private getUniqueRowsIndexes;
+    private notifyRowsRemovedAndRemaining;
+    private checkSingleRangeSelected;
+    private checkNoMergeInZone;
+    private checkRangeContainsValues;
+    private checkNoColumnProvided;
+    private checkColumnsIncludedInZone;
+    private getColsToAnalyze;
+}

package/dist/types/stores/spreadsheet_store.d.ts

@@ -7,7 +7,7 @@ import { RendererStore } from "./renderer_store";
 export declare class SpreadsheetStore extends DisposableStore {
     protected model: Model;
     protected getters: import("..").Getters;
-    protected renderer: import("../types/store_engine").CQS<Pick<RendererStore, "register" | "unRegister" | "draw" | "startAnimation" | "stopAnimation"> & import("../types/store_engine").OmitFunctions<RendererStore>>;
+    protected renderer: import("../types/store_engine").Store<RendererStore>;
     constructor(get: Get);
     get renderingLayers(): Readonly<LayerName[]>;
     protected handle(cmd: Command): void;

package/dist/types/stores/trim_whitespace_store.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "../types/commands";
+import { SpreadsheetStore } from "./spreadsheet_store";
+export declare class TrimWhitespaceStore extends SpreadsheetStore {
+    mutators: readonly ["trimWhitespace"];
+    private notificationStore;
+    trimWhitespace(): void;
+    handle(cmd: Command): void;
+    private _trimWhitespace;
+}

package/dist/types/stores/viewports_store.d.ts

@@ -0,0 +1,73 @@
+import { CellPosition, FigureUI, HeaderIndex, Pixel, SheetViewDimensions } from "..";
+import { ViewportCollection } from "../helpers/viewport_collection";
+import { Command } from "../types/commands";
+import { DOMCoordinates, DOMDimension, Rect, SheetDOMScrollInfo, Viewport } from "../types/rendering";
+import { Get } from "../types/store_engine";
+import { SpreadsheetStore } from "./spreadsheet_store";
+/**
+ * Viewport store.
+ *
+ * This store manages all things related to all viewport states.
+ *
+ */
+export declare class ViewportsStore extends SpreadsheetStore {
+    mutators: readonly ["setViewportOffset", "resizeSheetView", "setZoom", "shiftViewportDown", "shiftViewportUp", "scrollToCell"];
+    viewports: ViewportCollection;
+    private sheetsWithDirtyViewports;
+    private shouldRepositionViewports;
+    constructor(get: Get);
+    private handleEvent;
+    handle(cmd: Command): void;
+    finalize(): void;
+    private setViewports;
+    private syncPaneDivision;
+    setViewportOffset(offset: {
+        offsetX: Pixel;
+        offsetY: Pixel;
+    }): "noStateChange" | undefined;
+    resizeSheetView(dimensions: SheetViewDimensions): "noStateChange" | undefined;
+    setZoom(zoom: number): "noStateChange" | undefined;
+    shiftViewportDown(): void;
+    shiftViewportUp(): void;
+    scrollToCell(col: HeaderIndex, row: HeaderIndex): void;
+    get sheetViewDimensionWithHeaders(): DOMDimension;
+    get sheetViewDimension(): DOMDimension;
+    get gridOffset(): DOMCoordinates;
+    /** type as pane, not viewport but basically pane extends viewport */
+    get activeMainViewport(): Viewport;
+    /**
+     * Return the DOM scroll info of the active sheet, ie. the offset between the viewport left/top side and
+     * the grid left/top side, corresponding to the scroll of the scrollbars and not snapped to the grid.
+     */
+    get activeSheetScrollInfo(): SheetDOMScrollInfo;
+    get visibleCols(): HeaderIndex[];
+    get visibleRows(): HeaderIndex[];
+    /**
+     * Get the positions of all the cells that are visible in the viewport, taking merges into account.
+     */
+    get visibleCellPositions(): CellPosition[];
+    /**
+     * Return the main viewport maximum size relative to the client size.
+     */
+    get mainViewportRect(): Rect;
+    get maximumSheetOffset(): {
+        maxOffsetX: Pixel;
+        maxOffsetY: Pixel;
+    };
+    get scrollBarWidth(): Pixel;
+    /**
+     * Returns the position of the MainViewport relatively to the start of the grid (without headers)
+     * It corresponds to the summed dimensions of the visible cols/rows (in x/y respectively)
+     * situated before the pane divisions.
+     */
+    get mainViewportCoordinates(): DOMCoordinates;
+    get zoomLevel(): number;
+    get visibleFigures(): FigureUI[];
+    /**
+     * Shift the viewport vertically and move the selection anchor
+     * such that it remains at the same place relative to the
+     * viewport top.
+     */
+    private shiftVertically;
+    private getPaneDivisions;
+}