@odoo/o-spreadsheet 19.5.0-alpha.0 → 19.5.0-alpha.10

package/dist/types/types/getters.d.ts

@@ -10,31 +10,26 @@ import { FingerprintPlugin } from "../plugins/ui_core_views/fingerprint";
 import { FormulaTrackerPlugin } from "../plugins/ui_core_views/formula_tracker";
 import { HeaderSizeUIPlugin } from "../plugins/ui_core_views/header_sizes_ui";
 import { PivotUIPlugin } from "../plugins/ui_core_views/pivot_ui";
-import { AutofillPlugin } from "../plugins/ui_feature/autofill";
-import { AutomaticSumPlugin } from "../plugins/ui_feature/automatic_sum";
-import { CellComputedStylePlugin } from "../plugins/ui_feature/cell_computed_style";
-import { CheckboxTogglePlugin } from "../plugins/ui_feature/checkbox_toggle";
 import { CollaborativePlugin } from "../plugins/ui_feature/collaborative";
 import { ColorThemeUIPlugin } from "../plugins/ui_feature/color_theme";
 import { DynamicTranslate } from "../plugins/ui_feature/dynamic_translate";
-import { FigureUIPlugin } from "../plugins/ui_feature/figure";
 import { GeoFeaturePlugin } from "../plugins/ui_feature/geo_features";
-import { HeaderVisibilityUIPlugin } from "../plugins/ui_feature/header_visibility_ui";
 import { HistoryPlugin } from "../plugins/ui_feature/local_history";
 import { LockSheetPlugin } from "../plugins/ui_feature/lock_sheet";
 import { PivotPresencePlugin } from "../plugins/ui_feature/pivot_presence_plugin";
 import { SortPlugin } from "../plugins/ui_feature/sort";
-import { SplitToColumnsPlugin } from "../plugins/ui_feature/split_to_columns";
 import { SubtotalEvaluationPlugin } from "../plugins/ui_feature/subtotal_evaluation";
-import { TableComputedStylePlugin } from "../plugins/ui_feature/table_computed_style";
 import { UIOptionsPlugin } from "../plugins/ui_feature/ui_options";
 import { SheetUIPlugin } from "../plugins/ui_feature/ui_sheet";
 import { CarouselUIPlugin } from "../plugins/ui_stateful/carousel_ui";
+import { CellComputedStylePlugin } from "../plugins/ui_stateful/cell_computed_style";
 import { ClipboardPlugin } from "../plugins/ui_stateful/clipboard";
+import { FigureUIPlugin } from "../plugins/ui_stateful/figure";
 import { FilterEvaluationPlugin } from "../plugins/ui_stateful/filter_evaluation";
 import { HeaderPositionsUIPlugin } from "../plugins/ui_stateful/header_positions";
+import { HeaderVisibilityUIPlugin } from "../plugins/ui_stateful/header_visibility_ui";
 import { GridSelectionPlugin } from "../plugins/ui_stateful/selection";
-import { SheetViewPlugin } from "../plugins/ui_stateful/sheetview";
+import { TableComputedStylePlugin } from "../plugins/ui_stateful/table_computed_style";
 import { CoreGetters, PluginGetters } from "./core_getters";
 /**
  * The getters that can be used in the rendering-related stores and helpers. The SheetView and Selection getters should
@@ -43,5 +38,27 @@ import { CoreGetters, PluginGetters } from "./core_getters";
 export type RenderingGetters = {
     isReadonly: () => boolean;
     isDashboard: () => boolean;
-} & CoreGetters & PluginGetters<typeof AutofillPlugin> & PluginGetters<typeof AutomaticSumPlugin> & PluginGetters<typeof HistoryPlugin> & PluginGetters<typeof ClipboardPlugin> & PluginGetters<typeof EvaluationPlugin> & PluginGetters<typeof EvaluationChartPlugin> & PluginGetters<typeof EvaluationConditionalFormatPlugin> & PluginGetters<typeof HeaderVisibilityUIPlugin> & PluginGetters<typeof CustomColorsPlugin> & PluginGetters<typeof AutomaticSumPlugin> & PluginGetters<typeof CollaborativePlugin> & PluginGetters<typeof SortPlugin> & PluginGetters<typeof UIOptionsPlugin> & PluginGetters<typeof SheetUIPlugin> & PluginGetters<typeof FilterEvaluationPlugin> & PluginGetters<typeof FingerprintPlugin> & PluginGetters<typeof SplitToColumnsPlugin> & PluginGetters<typeof SubtotalEvaluationPlugin> & PluginGetters<typeof HeaderSizeUIPlugin> & PluginGetters<typeof EvaluationDataValidationPlugin> & PluginGetters<typeof HeaderPositionsUIPlugin> & PluginGetters<typeof TableStylePlugin> & PluginGetters<typeof CellComputedStylePlugin> & PluginGetters<typeof DynamicTablesPlugin> & PluginGetters<typeof PivotUIPlugin> & PluginGetters<typeof TableComputedStylePlugin> & PluginGetters<typeof GeoFeaturePlugin> & PluginGetters<typeof PivotPresencePlugin> & PluginGetters<typeof TableComputedStylePlugin> & PluginGetters<typeof CheckboxTogglePlugin> & PluginGetters<typeof CellIconPlugin> & PluginGetters<typeof DynamicTranslate> & PluginGetters<typeof FormulaTrackerPlugin> & PluginGetters<typeof LockSheetPlugin> & PluginGetters<typeof CarouselUIPlugin> & PluginGetters<typeof ColorThemeUIPlugin> & PluginGetters<typeof FigureUIPlugin>;
-export type Getters = RenderingGetters & PluginGetters<typeof SheetViewPlugin> & PluginGetters<typeof GridSelectionPlugin>;
+} & CoreGetters & PluginGetters<typeof HistoryPlugin> & PluginGetters<typeof ClipboardPlugin> & PluginGetters<typeof EvaluationPlugin> & PluginGetters<typeof EvaluationChartPlugin> & PluginGetters<typeof EvaluationConditionalFormatPlugin> & PluginGetters<typeof HeaderVisibilityUIPlugin> & PluginGetters<typeof CustomColorsPlugin> & PluginGetters<typeof CollaborativePlugin> & PluginGetters<typeof SortPlugin> & PluginGetters<typeof UIOptionsPlugin> & PluginGetters<typeof SheetUIPlugin> & PluginGetters<typeof FilterEvaluationPlugin> & PluginGetters<typeof FingerprintPlugin> & PluginGetters<typeof SubtotalEvaluationPlugin> & PluginGetters<typeof HeaderSizeUIPlugin> & PluginGetters<typeof EvaluationDataValidationPlugin> & PluginGetters<typeof HeaderPositionsUIPlugin> & PluginGetters<typeof TableStylePlugin> & PluginGetters<typeof CellComputedStylePlugin> & PluginGetters<typeof DynamicTablesPlugin> & PluginGetters<typeof PivotUIPlugin> & PluginGetters<typeof TableComputedStylePlugin> & PluginGetters<typeof GeoFeaturePlugin> & PluginGetters<typeof PivotPresencePlugin> & PluginGetters<typeof TableComputedStylePlugin> & PluginGetters<typeof CellIconPlugin> & PluginGetters<typeof DynamicTranslate> & PluginGetters<typeof FormulaTrackerPlugin> & PluginGetters<typeof LockSheetPlugin> & PluginGetters<typeof CarouselUIPlugin> & PluginGetters<typeof ColorThemeUIPlugin> & PluginGetters<typeof FigureUIPlugin>;
+export type Getters = RenderingGetters & PluginGetters<typeof GridSelectionPlugin>;
+export interface ViewportsGetters {
+    getColDimensions: Getters["getColDimensions"];
+    getRowDimensions: Getters["getRowDimensions"];
+    findLastVisibleColRowIndex: Getters["findLastVisibleColRowIndex"];
+    isReadonly: Getters["isReadonly"];
+    getMainCellPosition: Getters["getMainCellPosition"];
+    getNextVisibleCellPosition: Getters["getNextVisibleCellPosition"];
+    getColRowOffset: Getters["getColRowOffset"];
+    isColHidden: Getters["isColHidden"];
+    isRowHidden: Getters["isRowHidden"];
+    isHeaderHidden: Getters["isHeaderHidden"];
+    getNumberHeaders: Getters["getNumberHeaders"];
+    getHeaderSize: Getters["getHeaderSize"];
+    getColSize: Getters["getColSize"];
+    getRowSize: Getters["getRowSize"];
+    getSheetIds: Getters["getSheetIds"];
+    tryGetSheet: Getters["tryGetSheet"];
+    getNumberCols: Getters["getNumberCols"];
+    getNumberRows: Getters["getNumberRows"];
+    getSheetZone: Getters["getSheetZone"];
+    getFigures: Getters["getFigures"];
+}

package/dist/types/types/misc.d.ts

@@ -2,6 +2,7 @@ import { CellValue, EvaluatedCell } from "./cells";
 import { CompiledFormula } from "../formulas/compiler";
 import { CommandResult } from "./commands";
 import { Format } from "./format";
+import { ComputeFunction } from "./functions";
 import { Range } from "./range";
 /**
  * The following type is meant to be used in union with other aliases to prevent
@@ -142,7 +143,7 @@ export interface Border {
 export type ReferenceDenormalizer = (range: Range) => FunctionResultObject;
 export type EnsureRange = (range: Range) => Matrix<FunctionResultObject>;
 export type GetSymbolValue = (symbolName: string, isRange: boolean) => Arg;
-export type FormulaToExecute = (deps: Range[], refFn: ReferenceDenormalizer, range: EnsureRange, getSymbolValue: GetSymbolValue, ctx: object) => Matrix<FunctionResultObject> | FunctionResultObject;
+export type FormulaToExecute = (deps: Range[], refFn: ReferenceDenormalizer, range: EnsureRange, getSymbolValue: GetSymbolValue, ctx: object, functions: ComputeFunction[]) => Matrix<FunctionResultObject> | FunctionResultObject;
 export interface LiteralValues {
     numbers: {
         value: number;
@@ -200,6 +201,10 @@ export interface PixelPosition {
     x: Pixel;
     y: Pixel;
 }
+export interface PixelDimension {
+    width: Pixel;
+    height: Pixel;
+}
 export interface Merge extends Zone {
     id: number;
 }
@@ -259,6 +264,9 @@ export type ConsecutiveIndexes = HeaderIndex[];
 export interface RangeProvider {
     adaptRanges: (adapterFunctions: RangeAdapterFunctions) => void;
 }
+export interface FormulaProvider {
+    getFormulas: () => CompiledFormula[];
+}
 export type Validation<T> = (toValidate: T) => CommandResult | CommandResult[];
 export type Increment = 1 | -1 | 0;
 export interface Ref<T> {
@@ -324,6 +332,10 @@ export interface Offset {
     col: number;
     row: number;
 }
+export interface PixelOffset {
+    offsetX: Pixel;
+    offsetY: Pixel;
+}
 export type DebouncedFunction<T> = T & {
     stopDebounce: () => void;
     isDebouncePending: () => boolean;
@@ -345,4 +357,10 @@ export interface NamedRange {
     name: string;
     range: Range;
 }
+export interface SheetViewDimensions {
+    height: Pixel;
+    width: Pixel;
+    gridOffsetX?: Pixel;
+    gridOffsetY?: Pixel;
+}
 export {};

package/dist/types/types/range.d.ts

@@ -22,6 +22,7 @@ export interface BoundedRange {
 export interface RangeStringOptions {
     useBoundedReference?: boolean;
     useFixedReference?: boolean;
+    doNotSimplifyRange?: boolean;
 }
 export interface RangeData {
     _zone: Zone | UnboundedZone;

package/dist/types/types/rendering.d.ts

@@ -105,6 +105,7 @@ export type GridRenderingContext = {
     thinLineWidth: number;
     viewports: ViewportCollection;
     hideGridLines?: boolean;
+    hideFrozenPaneBorder?: boolean;
 } & SelectionState;
 declare const LAYERS: {
     readonly Background: 0;

package/dist/types/types/store_engine.d.ts

@@ -28,9 +28,16 @@ export type SkipFirst<T extends any[]> = T extends [any, ...infer U] ? U : never
 export type OmitFunctions<T> = {
     [K in keyof T as T[K] extends Function ? never : K]: T[K];
 };
-export type Store<S> = S extends {
-    mutators: readonly (keyof S)[];
-} ? CQS<Pick<S, S["mutators"][number]> & OmitFunctions<S>> : CQS<OmitFunctions<S>>;
+export type FunctionKeys<T> = {
+    [K in keyof T]: T[K] extends Function ? K : never;
+}[keyof T];
+export type MutatorKeys<S> = S extends {
+    mutators: readonly FunctionKeys<S>[];
+} ? S["mutators"][number] : never;
+export type GetterKeys<S> = S extends {
+    storeGetters: readonly FunctionKeys<S>[];
+} ? S["storeGetters"][number] : never;
+export type Store<S> = CQS<Pick<S, MutatorKeys<S>> & OmitFunctions<S>> & Pick<S, GetterKeys<S>>;
 /**
  * Command Query Separation [1,2] implementation with types.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odoo/o-spreadsheet",
-  "version": "19.5.0-alpha.0",
+  "version": "19.5.0-alpha.10",
   "description": "A spreadsheet component",
   "type": "module",
   "main": "dist/o_spreadsheet.cjs",
@@ -141,7 +141,7 @@
     "xmlSelfClosingSpace": false
   },
   "dependencies": {
-    "@odoo/owl": "3.0.0-alpha.40",
+    "@odoo/owl": "3.0.0-alpha.45",
     "bootstrap": "5.3.3",
     "font-awesome": "^4.7.0",
     "rbush": "^3.0.1"

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

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

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

@@ -1,16 +0,0 @@
-import { Command, CommandResult } from "../../types/commands";
-import { UIPlugin } from "../ui_plugin";
-export declare class DataCleanupPlugin extends UIPlugin {
-    allowDispatch(cmd: Command): CommandResult | CommandResult[];
-    handle(cmd: Command): void;
-    private removeDuplicates;
-    private getUniqueRowsIndexes;
-    private notifyRowsRemovedAndRemaining;
-    private checkSingleRangeSelected;
-    private checkNoMergeInZone;
-    private checkRangeContainsValues;
-    private checkNoColumnProvided;
-    private checkColumnsIncludedInZone;
-    private checkColumnsAreUnique;
-    private trimWhitespace;
-}

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

@@ -1,21 +0,0 @@
-import { Command, CommandResult } from "../../types/commands";
-import { UIPlugin } from "../ui_plugin";
-export declare class SplitToColumnsPlugin extends UIPlugin {
-    static getters: readonly ["getAutomaticSeparator"];
-    allowDispatch(cmd: Command): CommandResult | CommandResult[];
-    handle(cmd: Command): void;
-    getAutomaticSeparator(): string;
-    private getAutoSeparatorForString;
-    private splitIntoColumns;
-    private getSplittedCols;
-    private splitAndRemoveTrailingEmpty;
-    private willSplittedColsOverwriteContent;
-    private removeMergesInSplitZone;
-    private addColsToAvoidCollisions;
-    private getColsToAddToAvoidCollision;
-    private addColumnsToNotOverflowSheet;
-    private checkSingleColSelected;
-    private checkNonEmptySelector;
-    private checkNotOverwritingContent;
-    private checkSeparatorInSelection;
-}

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

@@ -1,6 +0,0 @@
-import { Command } from "../../types/commands";
-import { UIPlugin } from "../ui_plugin";
-export declare class TableAutofillPlugin extends UIPlugin {
-    handle(cmd: Command): void;
-    private autofillTableZone;
-}

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

@@ -1,6 +0,0 @@
-import { Command, CommandResult } from "../../types/commands";
-import { UIPlugin } from "../ui_plugin";
-export declare class TableResizeUI extends UIPlugin {
-    allowDispatch(cmd: Command): CommandResult | CommandResult[];
-    handle(cmd: Command): void;
-}

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

@@ -1,123 +0,0 @@
-import { ViewportCollection } from "../../helpers/viewport_collection";
-import { Command, CommandResult, LocalCommand } from "../../types/commands";
-import { AnchorOffset, Figure, FigureUI } from "../../types/figure";
-import { CellPosition, Dimension, HeaderDimensions, HeaderIndex, Pixel, PixelPosition, UID, Zone } from "../../types/misc";
-import { DOMCoordinates, DOMDimension, EdgeScrollInfo, Rect, SheetDOMScrollInfo, Viewport } from "../../types/rendering";
-import { UIPlugin } from "../ui_plugin";
-/**
- * Viewport plugin.
- *
- * This plugin manages all things related to all viewport states.
- *
- */
-export 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", "getRect", "getFigureUI", "getPositionAnchorOffset", "getGridOffset", "getViewportZoomLevel", "getScrollBarWidth", "getMaximumSheetOffset", "getViewportCollection"];
-    private viewports;
-    private sheetsWithDirtyViewports;
-    private shouldRepositionViewports;
-    allowDispatch(cmd: LocalCommand): CommandResult | CommandResult[];
-    private handleEvent;
-    handle(cmd: Command): void;
-    finalize(): void;
-    private setViewports;
-    private syncPaneDivision;
-    /**
-     * Return the index of a column given an offset x, based on the viewport left
-     * visible cell.
-     * It returns -1 if no column is found.
-     */
-    getColIndex(x: Pixel): HeaderIndex;
-    /**
-     * Return the index of a row given an offset y, based on the viewport top
-     * visible cell.
-     * It returns -1 if no row is found.
-     */
-    getRowIndex(y: Pixel): HeaderIndex;
-    getSheetViewDimensionWithHeaders(): DOMDimension;
-    getSheetViewDimension(): DOMDimension;
-    getGridOffset(): DOMCoordinates;
-    /** type as pane, not viewport but basically pane extends viewport */
-    getActiveMainViewport(): 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.
-     */
-    getActiveSheetScrollInfo(): SheetDOMScrollInfo;
-    getSheetViewVisibleCols(): HeaderIndex[];
-    getSheetViewVisibleRows(): HeaderIndex[];
-    /**
-     * Get the positions of all the cells that are visible in the viewport, taking merges into account.
-     */
-    getVisibleCellPositions(): CellPosition[];
-    /**
-     * Return the main viewport maximum size relative to the client size.
-     */
-    getMainViewportRect(): Rect;
-    getMaximumSheetOffset(): {
-        maxOffsetX: Pixel;
-        maxOffsetY: Pixel;
-    };
-    getColRowOffsetInViewport(dimension: Dimension, referenceHeaderIndex: HeaderIndex, targetHeaderIndex: HeaderIndex): Pixel;
-    /**
-     * Check if a given position is visible in the viewport.
-     */
-    isVisibleInViewport(cellPosition: CellPosition): boolean;
-    getScrollBarWidth(): Pixel;
-    getEdgeScrollCol(x: number, previousX: number, startingX: number): EdgeScrollInfo;
-    getEdgeScrollRow(y: number, previousY: number, startingY: number): EdgeScrollInfo;
-    /**
-     * Computes the coordinates and size to draw the zone on the canvas
-     */
-    getVisibleRect(zone: Zone): Rect;
-    /**
-     * Computes the coordinates and size to draw the zone on the canvas after it has been zoomed
-     */
-    getVisibleRectWithZoom(zone: Zone): Rect;
-    /**
-     * Computes the coordinates and size to draw the zone without taking the grid offset into account
-     */
-    getVisibleRectWithoutHeaders(zone: Zone): Rect;
-    /**
-     * Computes the actual size and position (:Rect) of the zone on the canvas
-     * regardless of the viewport dimensions.
-     */
-    getRect(zone: Zone): Rect;
-    /**
-     * Computes the actual size and position (:Rect) of the zone on the canvas
-     * regardless of the viewport dimensions.
-     */
-    getRectWithoutHeaders(zone: Zone): Rect;
-    /**
-     * 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.
-     */
-    getMainViewportCoordinates(): DOMCoordinates;
-    /**
-     * Returns the size, start and end coordinates of a column relative to the left
-     * column of the current viewport
-     */
-    getColDimensionsInViewport(sheetId: UID, col: HeaderIndex): HeaderDimensions;
-    /**
-     * Returns the size, start and end coordinates of a row relative to the top row
-     * of the current viewport
-     */
-    getRowDimensionsInViewport(sheetId: UID, row: HeaderIndex): HeaderDimensions;
-    getViewportZoomLevel(): number;
-    /**
-     * Shift the viewport vertically and move the selection anchor
-     * such that it remains at the same place relative to the
-     * viewport top.
-     */
-    private shiftVertically;
-    getVisibleFigures(): FigureUI[];
-    getFigureUI(sheetId: UID, figure: Figure): FigureUI;
-    getPositionAnchorOffset(position: PixelPosition): AnchorOffset;
-    isPixelPositionVisible(position: PixelPosition): boolean;
-    getFrozenSheetViewRatio(sheetId: UID): {
-        xRatio: number;
-        yRatio: number;
-    };
-    getViewportCollection(): ViewportCollection;
-    private getPaneDivisions;
-}