@odoo/o-spreadsheet 19.1.3 → 19.1.4

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

@@ -431,7 +431,7 @@ declare class CellPlugin extends CorePlugin<CoreState$1> implements CoreState$1
             [id: string]: Cell;
         };
     };
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID, sheetName: AdaptSheetName): void;
+    adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID, sheetName: AdaptSheetName): void;
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     private clearZones;
@@ -561,7 +561,7 @@ declare abstract class AbstractChart {
      * This function should be used to update all the ranges of the chart after
      * a grid change (add/remove col/row, rename sheet, ...)
      */
-    abstract updateRanges(applyChange: ApplyRangeChange, sheetId: UID, adaptSheetName: AdaptSheetName): AbstractChart;
+    abstract updateRanges(rangeAdapters: RangeAdapterFunctions): AbstractChart;
     /**
      * Duplicate the chart when a sheet is duplicated.
      * The ranges that are in the same sheet as the chart are adapted to the new sheetId.
@@ -594,7 +594,7 @@ declare class ChartPlugin extends CorePlugin<ChartState> implements ChartState {
     readonly charts: Record<UID, FigureChart | undefined>;
     private createChart;
     private validateChartDefinition;
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID, adaptSheetName: AdaptSheetName): void;
+    adaptRanges(rangeAdapters: RangeAdapterFunctions): void;
     allowDispatch(cmd: Command): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     getContextCreationChart(chartId: UID): ChartCreationContext | undefined;
@@ -701,9 +701,9 @@ declare class ConditionalFormatPlugin extends CorePlugin<ConditionalFormatState>
     readonly cfRules: {
         [sheet: string]: ConditionalFormatInternal[];
     };
-    adaptCFFormulas(applyChange: ApplyRangeChange): void;
-    adaptCFRanges(sheetId: UID, applyChange: ApplyRangeChange): void;
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
+    adaptCFFormulas({ applyChange, adaptFormulaString }: RangeAdapterFunctions): void;
+    adaptCFRanges(sheetId: UID, { applyChange }: RangeAdapterFunctions): void;
+    adaptRanges(rangeAdapters: RangeAdapterFunctions, sheetId: UID): void;
     allowDispatch(cmd: Command): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     import(data: WorkbookData): void;
@@ -872,7 +872,7 @@ declare class DataValidationPlugin extends CorePlugin<DataValidationState> imple
     readonly rules: {
         [sheet: string]: DataValidationRule[];
     };
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
+    adaptRanges(rangeAdapters: RangeAdapterFunctions, sheetId: UID): void;
     private adaptDVFormulas;
     private adaptDVRanges;
     allowDispatch(cmd: Command): CommandResult | CommandResult[];
@@ -907,7 +907,7 @@ declare class FigurePlugin extends CorePlugin<FigureState> implements FigureStat
         [sheet: string]: Record<UID, Figure | undefined> | undefined;
     };
     readonly insertionOrders: UID[];
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
+    adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID): void;
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     beforeHandle(cmd: CoreCommand): void;
     handle(cmd: CoreCommand): void;
@@ -1124,7 +1124,7 @@ declare class MergePlugin extends CorePlugin<MergeState> implements MergeState {
     readonly mergeCellMap: Record<UID, SheetMergeCellMap | undefined>;
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
+    adaptRanges(rangeAdapters: RangeAdapterFunctions, sheetId: UID): void;
     getMerges(sheetId: UID): Merge[];
     getMerge({ sheetId, col, row }: CellPosition): Merge | undefined;
     getMergesInZone(sheetId: UID, zone: Zone): Merge[];
@@ -1375,7 +1375,7 @@ declare class PivotCorePlugin extends CorePlugin<CoreState> implements CoreState
     readonly compiledMeasureFormulas: Record<UID, Record<string, MeasureState>>;
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
-    adaptRanges(applyChange: ApplyRangeChange): void;
+    adaptRanges({ applyChange, adaptFormulaString }: RangeAdapterFunctions): void;
     getPivotDisplayName(pivotId: UID): string;
     getPivotName(pivotId: UID): string;
     /**
@@ -1414,12 +1414,12 @@ declare class PivotCorePlugin extends CorePlugin<CoreState> implements CoreState
     export(data: WorkbookData): void;
 }
 
-declare class RangeAdapter$1 implements CommandHandler<CoreCommand> {
+declare class RangeAdapterPlugin implements CommandHandler<CoreCommand> {
     private getters;
     private providers;
     private isAdaptingRanges;
     constructor(getters: CoreGetters);
-    static getters: readonly ["adaptFormulaStringDependencies", "copyFormulaStringForSheet", "extendRange", "getRangeString", "getRangeFromSheetXC", "createAdaptedRanges", "getRangeData", "getRangeDataFromXc", "getRangeDataFromZone", "getRangeFromRangeData", "getRangeFromZone", "getRangesUnion", "recomputeRanges", "isRangeValid", "removeRangesSheetPrefix"];
+    static getters: readonly ["copyFormulaStringForSheet", "extendRange", "getRangeString", "getRangeFromSheetXC", "createAdaptedRanges", "getRangeData", "getRangeDataFromXc", "getRangeDataFromZone", "getRangeFromRangeData", "getRangeFromZone", "getRangesUnion", "recomputeRanges", "isRangeValid", "removeRangesSheetPrefix"];
     allowDispatch(cmd: CoreCommand): CommandResult;
     beforeHandle(command: Command): void;
     handle(cmd: CoreCommand): void;
@@ -1476,7 +1476,6 @@ declare class RangeAdapter$1 implements CommandHandler<CoreCommand> {
     getRangeFromRangeData(data: RangeData): Range;
     isRangeValid(rangeStr: string): boolean;
     getRangesUnion(ranges: Range[]): Range;
-    adaptFormulaStringDependencies(sheetId: UID, formula: string, applyChange: ApplyRangeChange): string;
     /**
      * Copy a formula string to another sheet.
      *
@@ -1657,7 +1656,7 @@ declare class StylePlugin extends CorePlugin<StylePluginState> implements StyleP
     readonly styles: Record<UID, ZoneStyle[] | undefined>;
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
+    adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID): void;
     private handleAddColumnn;
     private handleAddRows;
     private styleIsDefault;
@@ -1684,7 +1683,7 @@ declare class TablePlugin extends CorePlugin<TableState> implements TableState {
     static getters: readonly ["getCoreTable", "getCoreTables", "getCoreTableMatchingTopLeft"];
     readonly tables: Record<UID, Record<TableId, CoreTable | undefined>>;
     readonly nextTableId: number;
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
+    adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID): void;
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     getCoreTables(sheetId: UID): CoreTable[];
@@ -1784,7 +1783,7 @@ type PluginGetters<Plugin extends {
     new (...args: unknown[]): any;
     getters: readonly string[];
 }> = Pick<InstanceType<Plugin>, GetterNames<Plugin>>;
-type RangeAdapterGetters = Pick<RangeAdapter$1, GetterNames<typeof RangeAdapter$1>>;
+type RangeAdapterGetters = Pick<RangeAdapterPlugin, GetterNames<typeof RangeAdapterPlugin>>;
 type CoreGetters = PluginGetters<typeof SheetPlugin> & PluginGetters<typeof HeaderSizePlugin> & PluginGetters<typeof HeaderVisibilityPlugin> & PluginGetters<typeof CellPlugin> & PluginGetters<typeof StylePlugin> & PluginGetters<typeof MergePlugin> & PluginGetters<typeof BordersPlugin> & PluginGetters<typeof ChartPlugin> & PluginGetters<typeof ImagePlugin> & PluginGetters<typeof CarouselPlugin> & PluginGetters<typeof FigurePlugin> & RangeAdapterGetters & PluginGetters<typeof ConditionalFormatPlugin> & PluginGetters<typeof TablePlugin> & PluginGetters<typeof SettingsPlugin> & PluginGetters<typeof HeaderGroupingPlugin> & PluginGetters<typeof DataValidationPlugin> & PluginGetters<typeof PivotCorePlugin>;
 
 type VerticalAxisPosition = "left" | "right";
@@ -2073,7 +2072,7 @@ declare class BasePlugin<State = any, C = any> implements CommandHandler<C>, Val
 interface CorePluginConfig {
     readonly getters: CoreGetters;
     readonly stateObserver: StateObserver;
-    readonly range: RangeAdapter$1;
+    readonly range: RangeAdapterPlugin;
     readonly dispatch: CoreCommandDispatcher["dispatch"];
     readonly canDispatch: CoreCommandDispatcher["dispatch"];
     readonly custom: ModelConfig["custom"];
@@ -2103,7 +2102,7 @@ declare class CorePlugin<State = any> extends BasePlugin<State, CoreCommand> imp
      * @param sheetId an sheetId to adapt either range of that sheet specifically, or ranges pointing to that sheet
      * @param sheetName couple of old and new sheet names to adapt ranges pointing to that sheet
      */
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID, sheetName: AdaptSheetName): void;
+    adaptRanges(rangeAdapterFunctions: RangeAdapterFunctions, sheetId: UID, sheetName: AdaptSheetName): void;
 }
 
 type ZoneBorderData = {
@@ -2127,7 +2126,7 @@ declare class BordersPlugin extends CorePlugin<BordersPluginState> implements Bo
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     beforeHandle(cmd: CoreCommand): void;
-    adaptRanges(applyChange: ApplyRangeChange, sheetId: UID): void;
+    adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID): void;
     private onRowRemove;
     private onColRemove;
     getCellBorder(position: CellPosition): Border;
@@ -6348,13 +6347,15 @@ declare const enum DIRECTION {
     RIGHT = "right"
 }
 type ChangeType = "REMOVE" | "RESIZE" | "MOVE" | "CHANGE" | "NONE";
-type ApplyRangeChangeResult = {
-    changeType: Exclude<ChangeType, "NONE">;
-    range: Range;
-} | {
-    changeType: "NONE";
+type ApplyRangeChangeResult<T> = {
+    changeType: ChangeType;
+    range: T;
+};
+type ApplyFormulaRangeChangeResult = {
+    changeType: ChangeType;
+    formula: string;
 };
-type ApplyRangeChange = (range: Range) => ApplyRangeChangeResult;
+type ApplyRangeChange = (range: Range) => ApplyRangeChangeResult<Range>;
 type AdaptSheetName = {
     old: string;
     current: string;
@@ -6364,10 +6365,15 @@ type RangeAdapter = {
     sheetName: AdaptSheetName;
     applyChange: ApplyRangeChange;
 };
+type RangeAdapterFunctions = {
+    applyChange: ApplyRangeChange;
+    adaptRangeString: (defaultSheetId: UID, sheetXC: string) => ApplyRangeChangeResult<string>;
+    adaptFormulaString: (defaultSheetId: UID, formula: string) => string;
+};
 type Dimension = "COL" | "ROW";
 type ConsecutiveIndexes = HeaderIndex[];
 interface RangeProvider {
-    adaptRanges: (applyChange: ApplyRangeChange, sheetId: UID, sheetName: AdaptSheetName) => void;
+    adaptRanges: (adapterFunctions: RangeAdapterFunctions, sheetId: UID, sheetName: AdaptSheetName) => void;
 }
 type Validation<T> = (toValidate: T) => CommandResult | CommandResult[];
 type Increment = 1 | -1 | 0;
@@ -6722,4 +6728,4 @@ declare class NumberTooLargeError extends EvaluationError {
 
 declare const __info__: {};
 
-export { AST, ASTFuncall, ASTOperation, ASTString, ASTSymbol, ASTUnaryOperation, AdaptSheetName, AdjacentEdge, Alias, Align, AnchorZone, ApplyRangeChange, ApplyRangeChangeResult, Arg, BadExpressionError, BasePlugin, Border, BorderData, BorderDescr, BorderDescrWithOpacity, BorderPosition, BorderStyle, Box, BoxTextContent, CSSProperties, CellErrorType, CellPosition, CellValue, ChangeType, CircularDependencyError, ClipboardCell, Cloneable, Color, CompiledFormula, ComposerFocusType, ConsecutiveIndexes, CoreGetters, CreateRevisionOptions, DEFAULT_LOCALE, DEFAULT_LOCALES, DIRECTION, DOMCoordinates, DOMDimension, DataBarFill, DebouncedFunction, Dimension, Direction, DivisionByZeroError, EdgeScrollInfo, EditionMode, EnsureRange, ErrorValue, EvaluationError, FilterId, Format, FormulaToExecute, FunctionCode, FunctionCodeBuilder, FunctionRegistry, FunctionResultNumber, FunctionResultObject, GetSymbolValue, GlobalChart, GridClickModifiers, GridRenderingContext, HSLA, HeaderDimensions, HeaderGroup, HeaderIndex, Highlight, HistoryChange, Image, Immutable, Increment, InvalidReferenceError, LayerName, Lazy, Link, Locale, LocaleCode, Matrix, Maybe, MenuMouseEvent, Merge, Model, NotAvailableError, NumberTooLargeError, OPERATOR_MAP, OP_PRIORITY, Offset, OperationSequenceNode, OrderedLayers, POSTFIX_UNARY_OPERATORS, PaneDivision, Pixel, PixelPosition, PluginGetters, Position, RGBA, RangeAdapter, RangeCompiledFormula, RangeProvider, Rect, Ref, ReferenceDenormalizer, Registry, RenderingBorder, RenderingBox, RenderingGridIcon, Row, Scope, ScrollDirection, Selection, SelectionStep, SetDecimalStep, Sheet, SheetDOMScrollInfo, SortDirection, SortOptions, SplillBlockedError, SpreadsheetClipboardData, StateObserver, Style, TableId, Token, TokenizingChars, Transformation, TransformationFactory, TranslationFunction, UID, UNARY_OPERATOR_MAP, UnboundedZone, UnknownFunctionError, UpdateCellData, UuidGenerator, Validation, Validator, ValueAndLabel, VerticalAlign, Viewport, WorkbookHistory, Wrapping, Zone, ZoneDimension, __info__, _t, addRenderingLayer, batched, borderStyles, buildSheetLink, categories, cellReference, chartStyleToCellStyle, clip, compile, compileTokens, concat, convertAstNodes, createEmptyStructure, debounce, deepCopy, deepEquals, deepEqualsArray, errorTypes, escapeRegExp, findNextDefinedValue, functionCache, getAddHeaderStartIndex, getCanonicalSymbolName, getFormulaNumberRegex, getFullReference, getSearchRegex, getUniqueText, getUnquotedSheetName, groupConsecutive, includesAll, insertItemsAtIndex, isBoolean, isColHeader, isColReference, isConsecutive, isDefined, isFormula, isMarkdownLink, isMatrix, isNotNull, isNumber, isNumberBetween, isObjectEmptyRecursive, isRowHeader, isRowReference, isSheetUrl, isSingleCellReference, isWebLink, iterateAstNodes, largeMax, largeMin, lazy, linkNext, loopThroughReferenceType, mapAst, markdownLink, memoize, parse, parseMarkdownLink, parseNumber, parseSheetUrl, parseTokens, percentile, range, rangeReference, rangeTokenize, removeDuplicates, removeFalsyAttributes, removeIndexesFromArray, replaceItemAtIndex, replaceNewLines, sanitizeSheetName, setDefaultTranslationMethod, setTranslationMethod, setXcToFixedReferenceType, specialWhiteSpaceRegexp, splitReference, tokenize, transpose2dPOJO, trimContent, unquote, whiteSpaceCharacters };
+export { AST, ASTFuncall, ASTOperation, ASTString, ASTSymbol, ASTUnaryOperation, AdaptSheetName, AdjacentEdge, Alias, Align, AnchorZone, ApplyFormulaRangeChangeResult, ApplyRangeChange, ApplyRangeChangeResult, Arg, BadExpressionError, BasePlugin, Border, BorderData, BorderDescr, BorderDescrWithOpacity, BorderPosition, BorderStyle, Box, BoxTextContent, CSSProperties, CellErrorType, CellPosition, CellValue, ChangeType, CircularDependencyError, ClipboardCell, Cloneable, Color, CompiledFormula, ComposerFocusType, ConsecutiveIndexes, CoreGetters, CreateRevisionOptions, DEFAULT_LOCALE, DEFAULT_LOCALES, DIRECTION, DOMCoordinates, DOMDimension, DataBarFill, DebouncedFunction, Dimension, Direction, DivisionByZeroError, EdgeScrollInfo, EditionMode, EnsureRange, ErrorValue, EvaluationError, FilterId, Format, FormulaToExecute, FunctionCode, FunctionCodeBuilder, FunctionRegistry, FunctionResultNumber, FunctionResultObject, GetSymbolValue, GlobalChart, GridClickModifiers, GridRenderingContext, HSLA, HeaderDimensions, HeaderGroup, HeaderIndex, Highlight, HistoryChange, Image, Immutable, Increment, InvalidReferenceError, LayerName, Lazy, Link, Locale, LocaleCode, Matrix, Maybe, MenuMouseEvent, Merge, Model, NotAvailableError, NumberTooLargeError, OPERATOR_MAP, OP_PRIORITY, Offset, OperationSequenceNode, OrderedLayers, POSTFIX_UNARY_OPERATORS, PaneDivision, Pixel, PixelPosition, PluginGetters, Position, RGBA, RangeAdapter, RangeAdapterFunctions, RangeCompiledFormula, RangeProvider, Rect, Ref, ReferenceDenormalizer, Registry, RenderingBorder, RenderingBox, RenderingGridIcon, Row, Scope, ScrollDirection, Selection, SelectionStep, SetDecimalStep, Sheet, SheetDOMScrollInfo, SortDirection, SortOptions, SplillBlockedError, SpreadsheetClipboardData, StateObserver, Style, TableId, Token, TokenizingChars, Transformation, TransformationFactory, TranslationFunction, UID, UNARY_OPERATOR_MAP, UnboundedZone, UnknownFunctionError, UpdateCellData, UuidGenerator, Validation, Validator, ValueAndLabel, VerticalAlign, Viewport, WorkbookHistory, Wrapping, Zone, ZoneDimension, __info__, _t, addRenderingLayer, batched, borderStyles, buildSheetLink, categories, cellReference, chartStyleToCellStyle, clip, compile, compileTokens, concat, convertAstNodes, createEmptyStructure, debounce, deepCopy, deepEquals, deepEqualsArray, errorTypes, escapeRegExp, findNextDefinedValue, functionCache, getAddHeaderStartIndex, getCanonicalSymbolName, getFormulaNumberRegex, getFullReference, getSearchRegex, getUniqueText, getUnquotedSheetName, groupConsecutive, includesAll, insertItemsAtIndex, isBoolean, isColHeader, isColReference, isConsecutive, isDefined, isFormula, isMarkdownLink, isMatrix, isNotNull, isNumber, isNumberBetween, isObjectEmptyRecursive, isRowHeader, isRowReference, isSheetUrl, isSingleCellReference, isWebLink, iterateAstNodes, largeMax, largeMin, lazy, linkNext, loopThroughReferenceType, mapAst, markdownLink, memoize, parse, parseMarkdownLink, parseNumber, parseSheetUrl, parseTokens, percentile, range, rangeReference, rangeTokenize, removeDuplicates, removeFalsyAttributes, removeIndexesFromArray, replaceItemAtIndex, replaceNewLines, sanitizeSheetName, setDefaultTranslationMethod, setTranslationMethod, setXcToFixedReferenceType, specialWhiteSpaceRegexp, splitReference, tokenize, transpose2dPOJO, trimContent, unquote, whiteSpaceCharacters };