@odoo/o-spreadsheet 17.1.0-alpha.3 → 17.1.0-alpha.4

package/dist/o-spreadsheet.d.ts

@@ -1430,80 +1430,6 @@ declare class UIPlugin<State = any> extends BasePlugin<State, Command> {
     drawGrid(ctx: GridRenderingContext, layer: LAYERS): void;
 }
 
-interface SearchOptions {
-    matchCase: boolean;
-    exactMatch: boolean;
-    searchFormulas: boolean;
-}
-interface SearchMatch {
-    selected: boolean;
-    col: HeaderIndex;
-    row: HeaderIndex;
-}
-/**
- * Find and Replace Plugin
- *
- * This plugin is used in combination with the find_and_replace sidePanel
- * It is used to 'highlight' cells that match an input string according to
- * the given searchOptions. The second part of this plugin makes it possible
- * (again with the find_and_replace sidePanel), to replace the values that match
- * the search with a new value.
- */
-declare class FindAndReplacePlugin extends UIPlugin {
-    static layers: LAYERS[];
-    static getters: readonly ["getSearchMatches", "getCurrentSelectedMatchIndex"];
-    private searchMatches;
-    private selectedMatchIndex;
-    private currentSearchRegex;
-    private searchOptions;
-    private toSearch;
-    private isSearchDirty;
-    handle(cmd: Command): void;
-    finalize(): void;
-    getSearchMatches(): SearchMatch[];
-    getCurrentSelectedMatchIndex(): number | null;
-    /**
-     * Will update the current searchOptions and accordingly update the regex.
-     * It will then search for matches using the regex and store them.
-     */
-    private updateSearch;
-    /**
-     * refresh the matches according to the current search options
-     */
-    private refreshSearch;
-    /**
-     * Updates the regex based on the current searchOptions and
-     * the value toSearch
-     */
-    private updateRegex;
-    /**
-     * Find matches using the current regex
-     */
-    private findMatches;
-    private sortByRowThenColumn;
-    /**
-     * Changes the selected search cell. Given a direction it will
-     * Change the selection to the previous, current or nextCell,
-     * if it exists otherwise it will set the selectedMatchIndex to null.
-     * It will also reset the index to 0 if the search has changed.
-     * It is also used to keep coherence between the selected searchMatch
-     * and selectedMatchIndex.
-     */
-    private selectNextCell;
-    private clearSearch;
-    private replaceMatch;
-    /**
-     * Replace the value of the currently selected match
-     */
-    private replace;
-    /**
-     * Apply the replace function to all the matches one time.
-     */
-    private replaceAll;
-    private getSearchableString;
-    drawGrid(renderingContext: GridRenderingContext): void;
-}
-
 type EditionMode = "editing" | "selecting" | "inactive";
 interface ComposerSelection {
     start: number;
@@ -1691,6 +1617,14 @@ type ClipboardContent = {
 };
 type ClipboardPasteOptions = "onlyFormat" | "onlyValue";
 
+interface SearchOptions {
+    matchCase: boolean;
+    exactMatch: boolean;
+    searchFormulas: boolean;
+    searchScope: "allSheets" | "activeSheet" | "specificRange";
+    specificRange?: RangeData;
+}
+
 /**
  * There are two kinds of commands: CoreCommands and LocalCommands
  *
@@ -2499,7 +2433,8 @@ declare const enum CommandResult {
     InvalidDataValidationCriterionValue = "InvalidDataValidationCriterionValue",
     InvalidNumberOfCriterionValues = "InvalidNumberOfCriterionValues",
     BlockingValidationRule = "BlockingValidationRule",
-    InvalidCopyPasteSelection = "InvalidCopyPasteSelection"
+    InvalidCopyPasteSelection = "InvalidCopyPasteSelection",
+    NoChanges = "NoChanges"
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -3078,50 +3013,6 @@ interface SpreadsheetChildEnv extends SpreadsheetEnv {
     loadLocales: () => Promise<Locale[]>;
 }
 
-type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "RANGE<ANY>" | "META";
-interface ArgDefinition {
-    repeating?: boolean;
-    optional?: boolean;
-    lazy?: boolean;
-    description: string;
-    name: string;
-    type: ArgType[];
-    default?: boolean;
-    defaultValue?: any;
-}
-type ComputeFunctionArg<T> = T | (() => T);
-type ComputeFunction<T, R> = (this: EvalContext, ...args: ComputeFunctionArg<T>[]) => R;
-interface AddFunctionDescriptionBase {
-    description: string;
-    category?: string;
-    args: ArgDefinition[];
-    returns: [ArgType];
-    isExported?: boolean;
-    hidden?: boolean;
-}
-interface ComputeValue {
-    compute: ComputeFunction<ArgValue, CellValue | Matrix<CellValue>>;
-}
-interface ComputeFormat {
-    computeFormat: ComputeFunction<Arg, Format | undefined | Matrix<Format | undefined>>;
-}
-interface ComputeValueAndFormat {
-    computeValueAndFormat: ComputeFunction<Arg, Matrix<ValueAndFormat> | ValueAndFormat>;
-}
-type AddFunctionDescription = (AddFunctionDescriptionBase & ComputeValue & Partial<ComputeFormat>) | (AddFunctionDescriptionBase & ComputeValueAndFormat);
-type FunctionDescription = AddFunctionDescription & {
-    minArgRequired: number;
-    maxArgPossible: number;
-    nbrArgRepeating: number;
-    getArgToFocus: (argPosition: number) => number;
-};
-type EvalContext = {
-    __lastFnCalled?: string;
-    __originCellXC?: () => string;
-    locale: Locale;
-    [key: string]: any;
-};
-
 declare class RangeAdapter implements CommandHandler<CoreCommand> {
     private getters;
     private providers;
@@ -3231,7 +3122,8 @@ interface BordersPluginState {
 declare class BordersPlugin extends CorePlugin<BordersPluginState> implements BordersPluginState {
     static getters: readonly ["getCellBorder", "getBordersColors"];
     readonly borders: BordersPluginState["borders"];
-    handle(cmd: Command): void;
+    allowDispatch(cmd: CoreCommand): CommandResult.Success | CommandResult.NoChanges;
+    handle(cmd: CoreCommand): void;
     /**
      * Move borders according to the inserted columns.
      * Ensure borders continuity.
@@ -3329,6 +3221,7 @@ declare class BordersPlugin extends CorePlugin<BordersPluginState> implements Bo
      * Compute the borders to add to the given zone merged.
      */
     private addBordersToMerge;
+    private checkBordersUnchanged;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
     exportForExcel(data: ExcelWorkbookData): void;
@@ -3345,7 +3238,7 @@ interface CoreState {
  * cell and sheet content.
  */
 declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
-    static getters: readonly ["zoneToXC", "getCells", "getFormulaCellContent", "getTranslatedCellFormula", "getCellStyle", "getCellById"];
+    static getters: readonly ["zoneToXC", "getCells", "getTranslatedCellFormula", "getCellStyle", "getCellById"];
     readonly nextId = 1;
     readonly cells: {
         [sheetId: string]: {
@@ -3353,7 +3246,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
         };
     };
     adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID): void;
-    allowDispatch(cmd: CoreCommand): CommandResult;
+    allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     /**
      * Set a format to all the cells in a zone
@@ -3382,7 +3275,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
      * starting an async evaluation even if it has been moved or re-allocated
      */
     getCellById(cellId: UID): Cell | undefined;
-    getFormulaCellContent(sheetId: UID, compiledFormula: RangeCompiledFormula, dependencies?: Range[]): string;
+    private getFormulaCellContent;
     getTranslatedCellFormula(sheetId: UID, offsetX: number, offsetY: number, compiledFormula: RangeCompiledFormula): string;
     getCellStyle(position: CellPosition): Style;
     /**
@@ -3427,6 +3320,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
     private createFormulaCellWithDependencies;
     private createErrorFormula;
     private checkCellOutOfSheet;
+    private checkUselessClearCell;
 }
 
 /**
@@ -4057,15 +3951,6 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
      */
     private moveCellOnRowsDeletion;
     private updateRowsStructureOnDeletion;
-    /**
-     * Update the rows of the sheet after an addition:
-     * - Rename the rows
-     *
-     * @param sheet Sheet on which the deletion occurs
-     * @param addedRow Index of the added row
-     * @param rowsToAdd Number of the rows to add
-     */
-    private updateRowsStructureOnAddition;
     /**
      * Add empty rows at the end of the rows
      *
@@ -4087,11 +3972,9 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
 }
 
 declare class EvaluationPlugin extends UIPlugin {
-    private config;
-    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getSpreadPositionsOf"];
+    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getSpreadPositionsOf", "getArrayFormulaSpreadingOn"];
     private shouldRebuildDependenciesGraph;
     private evaluator;
-    private compilationParams;
     private positionsToUpdate;
     constructor(config: UIPluginConfig);
     beforeHandle(cmd: Command): void;
@@ -4114,6 +3997,7 @@ declare class EvaluationPlugin extends UIPlugin {
     getEvaluatedCells(sheetId: UID): Record<UID, EvaluatedCell>;
     getEvaluatedCellsInZone(sheetId: UID, zone: Zone): EvaluatedCell[];
     getSpreadPositionsOf(position: CellPosition): CellPosition[];
+    getArrayFormulaSpreadingOn(position: CellPosition): CellPosition | undefined;
     exportForExcel(data: ExcelWorkbookData): void;
     /**
      * Returns the corresponding formula cell of a given cell
@@ -4121,7 +4005,6 @@ declare class EvaluationPlugin extends UIPlugin {
      * formula of the array formula that spreads to the cell
      */
     getCorrespondingFormulaCell(position: CellPosition): FormulaCell | undefined;
-    private getCompilationParameters;
 }
 
 interface CustomColorState {
@@ -4458,6 +4341,78 @@ declare class CollaborativePlugin extends UIPlugin {
     drawGrid(renderingContext: GridRenderingContext): void;
 }
 
+/**
+ * Find and Replace Plugin
+ *
+ * This plugin is used in combination with the find_and_replace sidePanel
+ * It is used to 'highlight' cells that match an input string according to
+ * the given searchOptions. The second part of this plugin makes it possible
+ * (again with the find_and_replace sidePanel), to replace the values that match
+ * the search with a new value.
+ */
+declare class FindAndReplacePlugin extends UIPlugin {
+    static layers: LAYERS[];
+    static getters: readonly ["getSearchMatches", "getCurrentSelectedMatchIndex", "getSearchOptions", "getAllSheetMatchesCount", "getActiveSheetMatchesCount", "getSpecificRangeMatchesCount"];
+    private allSheetsMatches;
+    private activeSheetMatches;
+    private specificRangeMatches;
+    private selectedMatchIndex;
+    private currentSearchRegex;
+    private searchOptions;
+    private toSearch;
+    private isSearchDirty;
+    get searchMatches(): CellPosition[];
+    handle(cmd: Command): void;
+    finalize(): void;
+    getSearchMatches(): CellPosition[];
+    getCurrentSelectedMatchIndex(): number | null;
+    getSearchOptions(): SearchOptions;
+    getAllSheetMatchesCount(): number;
+    getActiveSheetMatchesCount(): number;
+    getSpecificRangeMatchesCount(): number;
+    /**
+     * Will update the current searchOptions and accordingly update the regex.
+     * It will then search for matches using the regex and store them.
+     */
+    private updateSearch;
+    /**
+     * refresh the matches according to the current search options
+     */
+    private refreshSearch;
+    /**
+     * Updates the regex based on the current searchOptions and
+     * the value toSearch
+     */
+    private updateRegex;
+    private getSheetsInSearchOrder;
+    /**
+     * Find matches using the current regex
+     */
+    private findMatches;
+    private findMatchesInSheet;
+    /**
+     * Changes the selected search cell. Given a direction it will
+     * Change the selection to the previous, current or nextCell,
+     * if it exists otherwise it will set the selectedMatchIndex to null.
+     * It will also reset the index to 0 if the search has changed.
+     * It is also used to keep coherence between the selected searchMatch
+     * and selectedMatchIndex.
+     */
+    private selectNextCell;
+    private clearSearch;
+    private replaceMatch;
+    /**
+     * Replace the value of the currently selected match
+     */
+    private replace;
+    /**
+     * Apply the replace function to all the matches one time.
+     */
+    private replaceAll;
+    private getSearchableString;
+    drawGrid(renderingContext: GridRenderingContext): void;
+}
+
 declare class HeaderVisibilityUIPlugin extends UIPlugin {
     static getters: readonly ["getNextVisibleCellPosition", "findVisibleHeader", "findLastVisibleColRowIndex", "findFirstVisibleColRowIndex", "isRowHidden", "isColHidden", "isHeaderHidden"];
     isRowHidden(sheetId: UID, index: number): boolean;
@@ -5216,6 +5171,52 @@ type Getters = {
     isDashboard: () => boolean;
 } & CoreGetters & PluginGetters<typeof AutofillPlugin> & PluginGetters<typeof AutomaticSumPlugin> & PluginGetters<typeof HistoryPlugin> & PluginGetters<typeof ClipboardPlugin> & PluginGetters<typeof EditionPlugin> & PluginGetters<typeof EvaluationPlugin> & PluginGetters<typeof EvaluationChartPlugin> & PluginGetters<typeof EvaluationConditionalFormatPlugin> & PluginGetters<typeof FindAndReplacePlugin> & PluginGetters<typeof HeaderVisibilityUIPlugin> & PluginGetters<typeof HighlightPlugin> & PluginGetters<typeof CustomColorsPlugin> & PluginGetters<typeof AutomaticSumPlugin> & PluginGetters<typeof RendererPlugin> & PluginGetters<typeof GridSelectionPlugin> & PluginGetters<typeof SelectionInputsManagerPlugin> & PluginGetters<typeof CollaborativePlugin> & PluginGetters<typeof SortPlugin> & PluginGetters<typeof UIOptionsPlugin> & PluginGetters<typeof SheetUIPlugin> & PluginGetters<typeof SheetViewPlugin> & PluginGetters<typeof CellPopoverPlugin> & PluginGetters<typeof FilterEvaluationPlugin> & PluginGetters<typeof SplitToColumnsPlugin> & PluginGetters<typeof HeaderSizeUIPlugin> & PluginGetters<typeof EvaluationDataValidationPlugin> & PluginGetters<typeof HeaderPositionsUIPlugin>;
 
+type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "RANGE<ANY>" | "META";
+interface ArgDefinition {
+    repeating?: boolean;
+    optional?: boolean;
+    lazy?: boolean;
+    description: string;
+    name: string;
+    type: ArgType[];
+    default?: boolean;
+    defaultValue?: any;
+}
+type ComputeFunctionArg<T> = T | (() => T);
+type ComputeFunction<T, R> = (this: EvalContext, ...args: ComputeFunctionArg<T>[]) => R;
+interface AddFunctionDescriptionBase {
+    description: string;
+    category?: string;
+    args: ArgDefinition[];
+    returns: [ArgType];
+    isExported?: boolean;
+    hidden?: boolean;
+}
+interface ComputeValue {
+    compute: ComputeFunction<ArgValue, CellValue | Matrix<CellValue>>;
+}
+interface ComputeFormat {
+    computeFormat: ComputeFunction<Arg, Format | undefined | Matrix<Format | undefined>>;
+}
+interface ComputeValueAndFormat {
+    computeValueAndFormat: ComputeFunction<Arg, Matrix<ValueAndFormat> | ValueAndFormat>;
+}
+type AddFunctionDescription = (AddFunctionDescriptionBase & ComputeValue & Partial<ComputeFormat>) | (AddFunctionDescriptionBase & ComputeValueAndFormat);
+type FunctionDescription = AddFunctionDescription & {
+    minArgRequired: number;
+    maxArgPossible: number;
+    nbrArgRepeating: number;
+    getArgToFocus: (argPosition: number) => number;
+};
+type EvalContext = {
+    __lastFnCalled?: string;
+    __originSheetId: UID;
+    __originCellXC: () => string | undefined;
+    locale: Locale;
+    getters: Getters;
+    [key: string]: any;
+};
+
 interface HistoryChange {
     path: [any, ...(number | string)[]];
     before: any;
@@ -5774,6 +5775,10 @@ interface ActionSpec {
      * Can be defined to display an icon
      */
     icon?: string | ((env: SpreadsheetChildEnv) => string);
+    /**
+     * Can be defined to display another icon on the right of the item.
+     */
+    secondaryIcon?: string | ((env: SpreadsheetChildEnv) => string);
     /**
      * is the action allowed when running spreadsheet in readonly mode
      */
@@ -5804,6 +5809,7 @@ interface Action {
     isEnabled: (env: SpreadsheetChildEnv) => boolean;
     isActive?: (env: SpreadsheetChildEnv) => boolean;
     icon: (env: SpreadsheetChildEnv) => string;
+    secondaryIcon: (env: SpreadsheetChildEnv) => string;
     isReadonlyAllowed: boolean;
     execute?: (env: SpreadsheetChildEnv) => unknown;
     children: (env: SpreadsheetChildEnv) => Action[];
@@ -7342,6 +7348,9 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
     };
     sidePanel: SidePanelState;
     composer: ComposerState;
+    spreadsheetRef: {
+        el: HTMLElement | null;
+    };
     private _focusGrid?;
     private keyDownMapping;
     private isViewportTooSmall;
@@ -7474,7 +7483,7 @@ declare class ColResizer extends AbstractResizer {
     _getActiveElements(): Set<HeaderIndex>;
     _getPreviousVisibleElement(index: HeaderIndex): HeaderIndex;
     unhide(hiddenElements: HeaderIndex[]): void;
-    unhideStyleValue(hiddenIndex: HeaderIndex): Pixel;
+    getUnhideButtonStyle(hiddenIndex: HeaderIndex): string;
 }
 declare class RowResizer extends AbstractResizer {
     static template: string;
@@ -7499,7 +7508,7 @@ declare class RowResizer extends AbstractResizer {
     _getActiveElements(): Set<HeaderIndex>;
     _getPreviousVisibleElement(index: HeaderIndex): HeaderIndex;
     unhide(hiddenElements: HeaderIndex[]): void;
-    unhideStyleValue(hiddenIndex: HeaderIndex): Pixel;
+    getUnhideButtonStyle(hiddenIndex: HeaderIndex): string;
 }
 declare class HeadersOverlay extends Component<any, SpreadsheetChildEnv> {
     static template: string;
@@ -7866,6 +7875,7 @@ declare const components: {
     FigureComponent: typeof FigureComponent;
     Menu: typeof Menu;
     SelectionInput: typeof SelectionInput;
+    ValidationMessages: typeof ValidationMessages;
 };
 declare const hooks: {
     useDragAndDropListItems: typeof useDragAndDropListItems;