@odoo/o-spreadsheet 19.5.0-alpha.13 → 19.5.0-alpha.15

package/dist/types/plugins/{ui_core_views → evaluation}/fingerprint.d.ts

@@ -1,10 +1,10 @@
 import { Cell } from "../../types/cells";
-import { CoreViewPlugin } from "../core_view_plugin";
+import { EvaluationPlugin } from "../evaluation_plugin";
 /**
  * A string that represents the shape of a formula.
  */
 export type Fingerprint = string;
-export declare class FingerprintPlugin extends CoreViewPlugin {
+export declare class FingerprintPlugin extends EvaluationPlugin {
     static getters: readonly ["getCellFingerprint"];
     getCellFingerprint(cell: Cell): Fingerprint | undefined;
     private computeFormulaFingerprint;

package/dist/types/plugins/evaluation/formula_tracker.d.ts

@@ -0,0 +1,8 @@
+import { EvaluationCommand } from "../../types/commands";
+import { EvaluationPlugin } from "../evaluation_plugin";
+export declare class FormulaTrackerPlugin extends EvaluationPlugin {
+    static getters: readonly ["getCellsWithTrackedFormula"];
+    private trackedCells;
+    handle(cmd: EvaluationCommand): void;
+    getCellsWithTrackedFormula(formula: string): number[];
+}

package/dist/types/plugins/evaluation/geo_loader.d.ts

@@ -0,0 +1,12 @@
+import { GeoChartRegion } from "../../types/chart/geo_chart";
+import { EvaluationPlugin, EvaluationPluginConfig } from "../evaluation_plugin";
+export declare class GeoLoaderEvaluation extends EvaluationPlugin {
+    static getters: readonly ["getGeoJsonFeatures", "geoFeatureNameToId", "getGeoChartAvailableRegions"];
+    private readonly geoJsonService;
+    private geoJsonCache;
+    constructor(config: EvaluationPluginConfig);
+    getGeoChartAvailableRegions(): GeoChartRegion[];
+    getGeoJsonFeatures(region: string): GeoJSON.Feature[] | undefined;
+    geoFeatureNameToId(region: string, featureName: string): string | undefined;
+    private convertToGeoJson;
+}

package/dist/types/plugins/{ui_core_views → evaluation}/header_sizes_ui.d.ts

@@ -1,8 +1,8 @@
 import { Canvas2DContext } from "../../types/canvas";
-import { Command } from "../../types/commands";
+import { EvaluationCommand } from "../../types/commands";
 import { AnchorOffset } from "../../types/figure";
 import { CellPosition, Dimension, HeaderIndex, Immutable, Pixel, UID } from "../../types/misc";
-import { CoreViewPlugin } from "../core_view_plugin";
+import { EvaluationPlugin } from "../evaluation_plugin";
 interface HeaderSizeState {
     tallestCellInRow: Immutable<Record<UID, Array<CellWithSize | undefined>>>;
 }
@@ -10,12 +10,12 @@ interface CellWithSize {
     cell: CellPosition;
     size: Pixel;
 }
-export declare class HeaderSizeUIPlugin extends CoreViewPlugin<HeaderSizeState> implements HeaderSizeState {
+export declare class HeaderSizeUIPlugin extends EvaluationPlugin<HeaderSizeState> implements HeaderSizeState {
     static getters: readonly ["getRowSize", "getHeaderSize", "getMaxAnchorOffset"];
     readonly tallestCellInRow: Immutable<Record<UID, Array<CellWithSize | undefined>>>;
     ctx: Canvas2DContext;
-    beforeHandle(cmd: Command): void;
-    handle(cmd: Command): void;
+    beforeHandle(cmd: EvaluationCommand): void;
+    handle(cmd: EvaluationCommand): void;
     getRowSize(sheetId: UID, row: HeaderIndex): Pixel;
     getMaxAnchorOffset(sheetId: UID, height: Pixel, width: Pixel): AnchorOffset;
     getHeaderSize(sheetId: UID, dimension: Dimension, index: HeaderIndex): Pixel;

package/dist/types/plugins/{ui_stateful/header_visibility_ui.d.ts → evaluation/header_visibility_evaluation.d.ts}

@@ -1,7 +1,7 @@
 import { CellPosition, Dimension, HeaderIndex, UID } from "../../types/misc";
 import { ExcelWorkbookData } from "../../types/workbook_data";
-import { UIPlugin } from "../ui_plugin";
-export declare class HeaderVisibilityUIPlugin extends UIPlugin {
+import { EvaluationPlugin } from "../evaluation_plugin";
+export declare class HeaderVisibilityEvaluationPlugin extends EvaluationPlugin {
     static getters: readonly ["getNextVisibleCellPosition", "findVisibleHeader", "findLastVisibleColRowIndex", "findFirstVisibleColRowIndex", "isRowHidden", "isColHidden", "isHeaderHidden"];
     isRowHidden(sheetId: UID, index: number): boolean;
     isColHidden(sheetId: UID, index: number): boolean;

package/dist/types/plugins/evaluation/pivot_presence_plugin.d.ts

@@ -0,0 +1,12 @@
+import { PivotPresenceTracker } from "../../helpers/pivot/pivot_presence_tracker";
+import { EvaluationCommand } from "../../types/commands";
+import { UID } from "../../types/misc";
+import { EvaluationPlugin } from "../evaluation_plugin";
+export declare class PivotPresencePlugin extends EvaluationPlugin {
+    static getters: readonly ["getPivotPresenceTracker"];
+    private trackPresencePivotId?;
+    private sheetId?;
+    private tracker?;
+    handle(cmd: EvaluationCommand): void;
+    getPivotPresenceTracker(pivotId: UID, sheetId: UID): PivotPresenceTracker | undefined;
+}

package/dist/types/plugins/{ui_core_views → evaluation}/pivot_ui.d.ts

@@ -1,25 +1,25 @@
 import { CompiledFormula } from "../../formulas/compiler";
 import { CellValue } from "../../types/cells";
-import { Command } from "../../types/commands";
+import { EvaluationCommand } from "../../types/commands";
 import { CellPosition, Matrix, SortDirection, UID } from "../../types/misc";
 import { PivotCoreMeasure, PivotStyle, PivotTableCell } from "../../types/pivot";
 import { Pivot } from "../../types/pivot_runtime";
-import { CoreViewPlugin, CoreViewPluginConfig } from "../core_view_plugin";
+import { EvaluationPlugin, EvaluationPluginConfig } from "../evaluation_plugin";
 export declare const UNDO_REDO_PIVOT_COMMANDS: string[];
 interface PivotEvaluatedArgs {
     functionName: string;
     args: (CellValue | Matrix<CellValue> | undefined)[];
 }
-export declare class PivotUIPlugin extends CoreViewPlugin {
+export declare class PivotUIPlugin extends EvaluationPlugin {
     static getters: readonly ["getPivot", "getFirstPivotFunction", "getPivotCellSortDirection", "getPivotIdFromPosition", "getPivotIdsFromPosition", "getPivotCellFromPosition", "generateNewCalculatedMeasureName", "isPivotUnused", "isSpillPivotFormula", "getAllPivotArrayFormulas", "getPivotStyleAtPosition"];
     private pivots;
     private unusedPivotsInFormulas?;
     private custom;
     private pivotPositionCache;
     private shouldInvalidateCache;
-    constructor(config: CoreViewPluginConfig);
-    beforeHandle(cmd: Command): void;
-    handle(cmd: Command): void;
+    constructor(config: EvaluationPluginConfig);
+    beforeHandle(cmd: EvaluationCommand): void;
+    handle(cmd: EvaluationCommand): void;
     finalize(): void;
     /**
      * Get the id of the first pivot in the formula at the given position. Returns undefined if there

package/dist/types/plugins/evaluation/subtotal_evaluation.d.ts

@@ -0,0 +1,5 @@
+import { EvaluationCommand } from "../../types/commands";
+import { EvaluationPlugin } from "../evaluation_plugin";
+export declare class SubtotalEvaluationPlugin extends EvaluationPlugin {
+    handle(cmd: EvaluationCommand): void;
+}

package/dist/types/plugins/{ui_stateful → evaluation}/table_computed_style.d.ts

@@ -1,10 +1,10 @@
-import { Command } from "../../types/commands";
+import { Command, EvaluationCommand } from "../../types/commands";
 import { Border, CellPosition, Style } from "../../types/misc";
-import { UIPlugin } from "../ui_plugin";
-export declare class TableComputedStylePlugin extends UIPlugin {
+import { EvaluationPlugin } from "../evaluation_plugin";
+export declare class TableComputedStylePlugin extends EvaluationPlugin {
     static getters: readonly ["getCellTableStyle", "getCellTableBorder"];
     private tableStyles;
-    handle(cmd: Command): void;
+    handle(cmd: EvaluationCommand): void;
     finalize(): void;
     getCellTableStyle(position: CellPosition): Style | undefined;
     getCellTableBorder(position: CellPosition): Border | undefined;
@@ -21,8 +21,8 @@ export declare class TableComputedStylePlugin extends UIPlugin {
      */
     private getTableMapping;
 }
-declare const invalidateTableStyleCommands: readonly ["HIDE_COLUMNS_ROWS", "UNHIDE_COLUMNS_ROWS", "UNFOLD_HEADER_GROUP", "UNGROUP_HEADERS", "FOLD_HEADER_GROUP", "FOLD_ALL_HEADER_GROUPS", "UNFOLD_ALL_HEADER_GROUPS", "FOLD_HEADER_GROUPS_IN_ZONE", "UNFOLD_HEADER_GROUPS_IN_ZONE", "CREATE_TABLE", "UPDATE_TABLE", "UPDATE_FILTER", "REMOVE_TABLE", "RESIZE_TABLE", "CREATE_TABLE_STYLE", "REMOVE_TABLE_STYLE", "DELETE_CONTENT"];
-export declare function doesCommandInvalidatesTableStyle(cmd: Command): cmd is {
+declare const invalidateTableStyleCommands: readonly ["HIDE_COLUMNS_ROWS", "UNHIDE_COLUMNS_ROWS", "UNFOLD_HEADER_GROUP", "UNGROUP_HEADERS", "FOLD_HEADER_GROUP", "FOLD_ALL_HEADER_GROUPS", "UNFOLD_ALL_HEADER_GROUPS", "FOLD_HEADER_GROUPS_IN_ZONE", "UNFOLD_HEADER_GROUPS_IN_ZONE", "CREATE_TABLE", "UPDATE_TABLE", "UPDATE_FILTER", "REMOVE_TABLE", "CREATE_TABLE_STYLE", "REMOVE_TABLE_STYLE", "DELETE_CONTENT"];
+export declare function doesCommandInvalidatesTableStyle<C extends Command>(cmd: C): cmd is Extract<C, {
     type: (typeof invalidateTableStyleCommands)[number];
-} & Command;
+}>;
 export {};

package/dist/types/plugins/evaluation_plugin.d.ts

@@ -0,0 +1,31 @@
+import { Session } from "../collaborative/session";
+import { StateObserver } from "../state_observer";
+import { EvaluationCommand, EvaluationCommandDispatcher } from "../types/commands";
+import { Currency } from "../types/currency";
+import { EvaluationGetters } from "../types/getters";
+import { Color } from "../types/misc";
+import { ModelConfig } from "../types/model";
+import { BasePlugin } from "./base_plugin";
+export interface EvaluationPluginConfig {
+    readonly getters: EvaluationGetters;
+    readonly stateObserver: StateObserver;
+    readonly custom: ModelConfig["custom"];
+    readonly session: Session;
+    readonly dispatch: EvaluationCommandDispatcher["dispatch"];
+    readonly defaultCurrency?: Partial<Currency>;
+    readonly customColors: Color[];
+    readonly external: ModelConfig["external"];
+}
+export interface EvaluationPluginConstructor {
+    new (config: EvaluationPluginConfig): EvaluationPlugin;
+    getters: readonly string[];
+}
+/**
+ * Evaluation plugins handle any data derived from core data (i.e. evaluation).
+ * They cannot impact the model data (i.e. cannot dispatch core commands).
+ */
+export declare class EvaluationPlugin<State = any> extends BasePlugin<State, EvaluationCommand> {
+    protected getters: EvaluationGetters;
+    protected dispatch: EvaluationCommandDispatcher["dispatch"];
+    constructor({ getters, stateObserver, dispatch }: EvaluationPluginConfig);
+}

package/dist/types/plugins/plugin_registries.d.ts

@@ -1,8 +1,14 @@
 import { Registry } from "../registries/registry";
 import { CorePluginConstructor } from "./core_plugin";
-import { CoreViewPluginConstructor } from "./core_view_plugin";
+import { EvaluationPluginConstructor } from "./evaluation_plugin";
 import { UIPluginConstructor } from "./ui_plugin";
-export declare const corePluginRegistry: Registry<CorePluginConstructor>;
-export declare const featurePluginRegistry: Registry<UIPluginConstructor>;
-export declare const statefulUIPluginRegistry: Registry<UIPluginConstructor>;
-export declare const coreViewsPluginRegistry: Registry<CoreViewPluginConstructor>;
+export declare class PluginRegistry<T extends new (config: any) => any> extends Registry<T> {
+    private readonly PluginClass;
+    constructor(PluginClass: new (config: any) => any);
+    add(key: string, value: T): this;
+    replace(key: string, value: T): this;
+}
+export declare const corePluginRegistry: PluginRegistry<CorePluginConstructor>;
+export declare const featurePluginRegistry: PluginRegistry<UIPluginConstructor>;
+export declare const statefulUIPluginRegistry: PluginRegistry<UIPluginConstructor>;
+export declare const evaluationPluginRegistry: PluginRegistry<EvaluationPluginConstructor>;

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

@@ -0,0 +1,6 @@
+import { ChartRuntime } from "../../types/chart/chart";
+import { UIPlugin } from "../ui_plugin";
+export declare class ChartUIPlugin extends UIPlugin {
+    static getters: readonly ["getChartRuntime"];
+    getChartRuntime(chartId: string): ChartRuntime;
+}

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

@@ -1,9 +1,6 @@
 import { Command } from "../../types/commands";
 import { GridRenderingTheme } from "../../types/rendering";
 import { UIPlugin, UIPluginConfig } from "../ui_plugin";
-export declare const BACKGROUND_HEADER_SELECTED_COLOR = "#E8EAED";
-export declare const BACKGROUND_HEADER_ACTIVE_COLOR = "#595959";
-export declare const COLOR_THEMES: Record<string, GridRenderingTheme>;
 export declare class ColorThemeUIPlugin extends UIPlugin {
     static getters: readonly ["isDarkMode", "getSpreadsheetTheme"];
     private colorScheme?;

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

@@ -3,21 +3,16 @@ import { Command } from "../../types/commands";
 import { UID } from "../../types/misc";
 import { UIPlugin, UIPluginConfig } from "../ui_plugin";
 export declare class GeoFeaturePlugin extends UIPlugin {
-    static getters: readonly ["getGeoJsonFeatures", "geoFeatureNameToId", "getGeoChartAvailableRegions", "getAvailableChartRegions"];
+    static getters: readonly ["getAvailableChartRegions"];
     private readonly geoJsonService;
-    private geoJsonCache;
     /** Stores the initial region of each geo chart at the time of the START command */
     private initialRegions;
     constructor(config: UIPluginConfig);
     handle(cmd: Command): void;
     private trackInitialRegion;
-    getGeoChartAvailableRegions(): GeoChartRegion[];
     /**
      * Returns the regions that can be selected as an alternative for a given geo chart in dashboard mode.
      * The available alternatives are based on the initial region of the chart (before any dashboard-level change).
      */
     getAvailableChartRegions(chartId: UID): GeoChartRegion[];
-    getGeoJsonFeatures(region: string): GeoJSON.Feature[] | undefined;
-    geoFeatureNameToId(region: string, featureName: string): string | undefined;
-    private convertToGeoJson;
 }

package/dist/types/plugins/{ui_core_views → ui_stateful}/cell_icon_plugin.d.ts

@@ -2,8 +2,8 @@ import { GridIcon } from "../../registries/icons_on_cell_registry";
 import { Command } from "../../types/commands";
 import { CellPosition } from "../../types/misc";
 import { Rect } from "../../types/rendering";
-import { CoreViewPlugin } from "../core_view_plugin";
-export declare class CellIconPlugin extends CoreViewPlugin {
+import { UIPlugin } from "../ui_plugin";
+export declare class CellIconPlugin extends UIPlugin {
     static getters: readonly ["doesCellHaveGridIcon", "getCellIcons", "getCellIconRect"];
     private cellIconsCache;
     handle(cmd: Command): void;

package/dist/types/registries/chart_data_source_registry.d.ts

@@ -1,8 +1,7 @@
 import type * as ChartJS from "chart.js";
 import { ChartCreationContext, ChartData, ChartDataSource, ChartDataSourceType, ChartType, DataSetStyle, ExcelChartDefinition } from "../types/chart/chart";
 import { CommandResult } from "../types/commands";
-import { CoreGetters } from "../types/core_getters";
-import { Getters } from "../types/getters";
+import { CoreGetters, EvaluationGetters } from "../types/getters";
 import { RangeAdapterFunctions, UID } from "../types/misc";
 import { Validator } from "../types/validator";
 import { Registry } from "./registry";
@@ -13,15 +12,15 @@ export interface ChartDataSourceBuilder<TExternal, TInternal> {
     fromHierarchicalContextCreation: (context: ChartCreationContext) => ChartDataSource<string>;
     validate: (dataSource: TExternal, validator: Validator) => CommandResult | CommandResult[];
     transform(dataSource: TExternal, defaultSheetId: UID, rangeAdapters: RangeAdapterFunctions): TExternal;
-    extractData(dataSource: TInternal, chartId: UID, getters: Getters): ChartData;
-    extractHierarchicalData(dataSource: TInternal, chartId: UID, getters: Getters): ChartData;
+    extractData(dataSource: TInternal, chartId: UID, getters: EvaluationGetters): ChartData;
+    extractHierarchicalData(dataSource: TInternal, chartId: UID, getters: EvaluationGetters): ChartData;
     adaptRanges(dataSource: TInternal, rangeAdapters: RangeAdapterFunctions): TInternal;
     duplicateInDuplicatedSheet(dataSource: TInternal, sheetIdFrom: UID, sheetIdTo: UID, getters: CoreGetters): TInternal;
     getDefinition(dataSource: TInternal, defaultSheetId: UID, getters: CoreGetters): TExternal;
     getContextCreation(dataSource: TExternal): ChartCreationContext;
     getHierarchicalContextCreation(dataSource: TExternal): ChartCreationContext;
     toExcelDataSets(dataSource: TInternal, dataSetStyles: DataSetStyle, getters: CoreGetters): Pick<ExcelChartDefinition, "dataSets" | "labelRange"> | undefined;
-    onDataSetClick?: (chartType: ChartType, chartId: UID, event: ChartJS.ChartEvent, items: ChartJS.ActiveElement[], chartJsChart: ChartJS.Chart, getters: Getters) => void;
+    onDataSetClick?: (chartType: ChartType, chartId: UID, event: ChartJS.ChartEvent, items: ChartJS.ActiveElement[], chartJsChart: ChartJS.Chart, getters: EvaluationGetters) => void;
     onDataSetHover?: (chartType: ChartType, chartId: UID, event: ChartJS.ChartEvent, items: ChartJS.ActiveElement[], chartJsChart: ChartJS.Chart) => void;
 }
 export interface ChartDataSourceRegistry extends Registry<ChartDataSourceBuilder<unknown, unknown>> {

package/dist/types/registries/chart_registry.d.ts

@@ -1,9 +1,8 @@
 import { CoreChartOptions } from "chart.js";
-import { CompiledFormula } from "..";
+import { ColorThemeName, CompiledFormula } from "..";
 import { ChartCreationContext, ChartData, ChartRuntime, ChartType, ChartTypeDefinition, ExcelChartDefinition } from "../types/chart/chart";
 import { CommandResult } from "../types/commands";
-import { CoreGetters } from "../types/core_getters";
-import { Getters } from "../types/getters";
+import { CoreGetters, EvaluationGetters } from "../types/getters";
 import { RangeAdapterFunctions, UID } from "../types/misc";
 import { Range } from "../types/range";
 import { Validator } from "../types/validator";
@@ -46,8 +45,8 @@ export interface ChartTypeBuilder<T extends ChartType> {
      * Get the definition of the chart used for excel export.
      * If the chart is not supported by Excel, this function returns undefined.
      */
-    getDefinitionForExcel(getters: Getters, definition: ChartTypeDefinition<T, Range>, params: Pick<ExcelChartDefinition, "dataSets" | "labelRange">): ExcelChartDefinition | undefined;
-    getRuntime(getters: Getters, definition: ChartTypeDefinition<T, Range>, chartDataExtractors: ChartDataExtractors, sheetId: UID, eventHandlers: ChartJsEventHandlers): ChartRuntime;
+    getDefinitionForExcel(getters: EvaluationGetters, definition: ChartTypeDefinition<T, Range>, params: Pick<ExcelChartDefinition, "dataSets" | "labelRange">): ExcelChartDefinition | undefined;
+    getRuntime(getters: EvaluationGetters, definition: ChartTypeDefinition<T, Range>, chartDataExtractors: ChartDataExtractors, sheetId: UID, eventHandlers: ChartJsEventHandlers, colorThemeName: ColorThemeName): ChartRuntime;
     /** Get all the formulas used in the chart */
     getFormulas(getters: CoreGetters, sheetId: UID, definition: ChartTypeDefinition<T, Range>): CompiledFormula[];
     allowedDefinitionKeys: readonly string[];

package/dist/types/registries/criterion_registry.d.ts

@@ -1,6 +1,6 @@
 import { CellValue } from "../types/cells";
 import { EvaluatedCriterion, GenericCriterion, GenericCriterionType } from "../types/generic_criterion";
-import { Getters } from "../types/getters";
+import { EvaluationGetters } from "../types/getters";
 import { UID } from "../types/misc";
 import { Range } from "../types/range";
 import { Registry } from "./registry";
@@ -20,13 +20,13 @@ export type CriterionEvaluator<T = unknown> = {
      * For more complex criteria (like "top10"), we might want to pre-compute some data before evaluating the criterion for
      * each cell, to avoid recomputing everything each time.
      */
-    preComputeCriterion?: (criterion: GenericCriterion, criterionRanges: Range[], getters: Getters) => T;
+    preComputeCriterion?: (criterion: GenericCriterion, criterionRanges: Range[], getters: EvaluationGetters) => T;
     /**
      * Returns the error string to display when the value is not valid.
      *
      * The criterion values should be in canonical form (non-localized), and formulas should be evaluated.
      */
-    getErrorString: (criterion: EvaluatedCriterion, getters: Getters, sheetId: UID) => string;
+    getErrorString: (criterion: EvaluatedCriterion, getters: EvaluationGetters, sheetId: UID) => string;
     /**
      * Checks if a criterion value is valid.
      *
@@ -36,7 +36,7 @@ export type CriterionEvaluator<T = unknown> = {
     /** Return the number of values that the criterion must contains. Return undefined if the criterion can have any number of values */
     numberOfValues: (criterion: GenericCriterion) => number | undefined;
     name: string;
-    getPreview: (criterion: GenericCriterion, getters: Getters) => string;
+    getPreview: (criterion: GenericCriterion, getters: EvaluationGetters) => string;
     /** Error string when a criterion value is invalid */
     criterionValueErrorString: string;
     allowedValues?: "onlyLiterals" | "onlyFormulas";

package/dist/types/registries/evaluation_registry.d.ts

@@ -1,4 +1,4 @@
-import { Getters } from "../types/getters";
+import { EvaluationGetters } from "../types/getters";
 import { Registry } from "./registry";
 /**
  * This registry is used to register functions that should be called after each iteration of the evaluation.
@@ -6,4 +6,4 @@ import { Registry } from "./registry";
  * to avoid to reload the data of the pivot at each function call (PIVOT.VALUE and PIVOT.HEADER). After each
  * evaluation iteration, the pivot has to be re-evaluated during the next iteration.
  */
-export declare const onIterationEndEvaluationRegistry: Registry<(getters: Getters) => void>;
+export declare const onIterationEndEvaluationRegistry: Registry<(getters: EvaluationGetters) => void>;

package/dist/types/registries/figures_registry.d.ts

@@ -15,7 +15,7 @@ export interface FigureContent {
     isThemeDependant: boolean;
     SidePanelComponent?: string;
     keepRatio?: boolean;
-    minFigSize?: number;
+    minFigSize: number;
     borderWidth: (getters: Getters) => number;
     hasShadow: (getters: Getters) => boolean;
     isRounded: (getters: Getters) => boolean;

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

@@ -1,14 +1,27 @@
+import { ZoomedMouseEvent } from "../components/helpers/zoom";
 import { Pixel } from "../types/misc";
-import { Rect } from "../types/rendering";
+import { DOMCoordinates, Rect } from "../types/rendering";
 /**
  * Holds the zoom level of the spreadsheet UI, and everything derived purely from it.
  */
 export declare class ZoomStore {
     mutators: readonly ["setZoom"];
-    storeGetters: readonly ["getZoomedRect"];
+    storeGetters: readonly ["getZoomedRect", "getZoomedEvent"];
     zoomLevel: number;
     setZoom(zoom: number): "noStateChange" | undefined;
     getZoomedRect(rect: Rect): Rect;
+    /**
+     * Return a POJO containing the original event as well as the client position and the client offset
+     * where the event would target if the spreadsheet was not zoomed
+     * @param ev unzoomed mouse event
+     * @param originalTargetPosition The original target bounding rect the resulting ZoomedMouseEvent offset must refer to
+     * @returns a ZoomedMouseEvent
+     */
+    getZoomedEvent<T extends MouseEvent>(ev: T, originalTargetPosition?: DOMCoordinates | null): ZoomedMouseEvent<T>;
+    /**
+     * Returns the bounding rect of the closest or self element who is targetable by a ZoomedMouseEvent
+     */
+    private getZoomTargetPosition;
     get scrollBarWidth(): Pixel;
     get cssZoom(): string;
 }

package/dist/types/types/collaborative/transport_service.d.ts

@@ -16,6 +16,7 @@ export interface RemoteRevisionMessage extends AbstractMessage {
 }
 export interface RemoteRevisionsSquishedMessage extends Omit<RemoteRevisionMessage, "commands"> {
     commands: (CoreCommand | SquishedCoreCommand)[];
+    squishedFailed?: boolean;
 }
 export interface RevisionUndoneMessage extends AbstractMessage {
     type: "REVISION_UNDONE";