@odoo/o-spreadsheet 17.0.84 → 17.0.96

package/dist/types/components/side_panel/conditional_formatting/conditional_formatting.d.ts

@@ -0,0 +1,23 @@
+import { Component } from "@odoo/owl";
+import { ConditionalFormat, SpreadsheetChildEnv, Zone } from "../../../types";
+import { ConditionalFormattingEditor } from "./cf_editor/cf_editor";
+import { ConditionalFormatPreviewList } from "./cf_preview_list/cf_preview_list";
+interface Props {
+    selection?: Zone[];
+    onCloseSidePanel: () => void;
+}
+export declare class ConditionalFormattingPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        ConditionalFormatPreviewList: typeof ConditionalFormatPreviewList;
+        ConditionalFormattingEditor: typeof ConditionalFormattingEditor;
+    };
+    private activeSheetId;
+    private state;
+    setup(): void;
+    get conditionalFormats(): ConditionalFormat[];
+    private switchToList;
+    addConditionalFormat(): void;
+    editConditionalFormat(cf: ConditionalFormat): void;
+}
+export {};

package/dist/types/components/side_panel/custom_currency/custom_currency.d.ts

@@ -0,0 +1,27 @@
+import { Component } from "@odoo/owl";
+import { Currency, SpreadsheetChildEnv } from "../../../types";
+interface CurrencyProposal {
+    format: string;
+    example: string;
+}
+interface Props {
+    onCloseSidePanel: () => void;
+}
+export declare class CustomCurrencyPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    private availableCurrencies;
+    private state;
+    setup(): void;
+    get formatProposals(): CurrencyProposal[];
+    get isSameFormat(): boolean;
+    updateAvailableCurrencies(): Promise<void>;
+    updateSelectCurrency(ev: InputEvent): void;
+    updateCode(ev: InputEvent): void;
+    updateSymbol(ev: InputEvent): void;
+    updateSelectFormat(ev: InputEvent): void;
+    apply(): void;
+    private initAvailableCurrencies;
+    private getCommonFormat;
+    currencyDisplayName(currency: Currency): string;
+}
+export {};

package/dist/types/components/side_panel/data_validation/data_validation_panel.d.ts

@@ -0,0 +1,25 @@
+import { Component } from "@odoo/owl";
+import { DataValidationRule, SpreadsheetChildEnv, UID } from "../../../types";
+import { DataValidationEditor } from "./dv_editor/dv_editor";
+import { DataValidationPreview } from "./dv_preview/dv_preview";
+interface Props {
+    onCloseSidePanel: () => void;
+}
+interface State {
+    mode: "list" | "edit";
+    activeRule: DataValidationRule | undefined;
+}
+export declare class DataValidationPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        DataValidationPreview: typeof DataValidationPreview;
+        DataValidationEditor: typeof DataValidationEditor;
+    };
+    state: State;
+    onPreviewClick(id: UID): void;
+    addDataValidationRule(): void;
+    onExitEditMode(): void;
+    localizeDVRule(rule?: DataValidationRule): DataValidationRule | undefined;
+    get validationRules(): DataValidationRule[];
+}
+export {};

package/dist/types/components/side_panel/data_validation/data_validation_panel_helper.d.ts

@@ -0,0 +1,14 @@
+import { ComponentConstructor } from "@odoo/owl";
+import { Action } from "../../../actions/action";
+import { Registry } from "../../../registries/registry";
+import { DataValidationCriterionType } from "../../../types";
+export type DVCriterionCategory = "text" | "date" | "number" | "misc" | "list";
+export declare const dvCriterionCategoriesSequences: Record<DVCriterionCategory, number>;
+export type DataValidationCriterionItem = {
+    type: DataValidationCriterionType;
+    component: ComponentConstructor | undefined;
+    sequence: number;
+    category: DVCriterionCategory;
+};
+export declare const dataValidationPanelCriteriaRegistry: Registry<DataValidationCriterionItem>;
+export declare function getDataValidationCriterionMenuItems(callback: (type: DataValidationCriterionType) => void): Action[];

package/dist/types/components/side_panel/data_validation/dv_criterion_form/dv_criterion_form.d.ts

@@ -0,0 +1,11 @@
+import { Component } from "@odoo/owl";
+import { DataValidationCriterion, SpreadsheetChildEnv } from "../../../../types";
+interface Props<T extends DataValidationCriterion> {
+    criterion: T;
+    onCriterionChanged: (criterion: DataValidationCriterion) => void;
+}
+export declare abstract class DataValidationCriterionForm<T extends DataValidationCriterion = DataValidationCriterion> extends Component<Props<T>, SpreadsheetChildEnv> {
+    setup(): void;
+    updateCriterion(criterion: Partial<T>): void;
+}
+export {};

package/dist/types/components/side_panel/data_validation/dv_criterion_form/dv_date_criterion/dv_date_criterion.d.ts

@@ -0,0 +1,16 @@
+import { DataValidationDateCriterion } from "../../../../../types";
+import { DataValidationCriterionForm } from "../dv_criterion_form";
+import { DataValidationInput } from "../dv_input/dv_input";
+export declare class DataValidationDateCriterionForm extends DataValidationCriterionForm<DataValidationDateCriterion> {
+    static template: string;
+    static components: {
+        DataValidationInput: typeof DataValidationInput;
+    };
+    setup(): void;
+    onValueChanged(value: string): void;
+    onDateValueChanged(ev: Event): void;
+    get dateValues(): {
+        value: string;
+        title: any;
+    }[];
+}

package/dist/types/components/side_panel/data_validation/dv_criterion_form/dv_double_input_criterion/dv_double_input_criterion.d.ts

@@ -0,0 +1,10 @@
+import { DataValidationCriterionForm } from "../dv_criterion_form";
+import { DataValidationInput } from "../dv_input/dv_input";
+export declare class DataValidationDoubleInputCriterionForm extends DataValidationCriterionForm {
+    static template: string;
+    static components: {
+        DataValidationInput: typeof DataValidationInput;
+    };
+    onFirstValueChanged(value: string): void;
+    onSecondValueChanged(value: string): void;
+}

package/dist/types/components/side_panel/data_validation/dv_criterion_form/dv_input/dv_input.d.ts

@@ -0,0 +1,30 @@
+import { Component } from "@odoo/owl";
+import { DataValidationCriterionType, SpreadsheetChildEnv } from "../../../../../types";
+interface Props {
+    value: string;
+    criterionType: DataValidationCriterionType;
+    onValueChanged: (value: string) => void;
+    onKeyDown?: (ev: KeyboardEvent) => void;
+    focused: boolean;
+    onBlur: () => void;
+}
+export declare class DataValidationInput extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static defaultProps: {
+        value: string;
+        onKeyDown: () => void;
+        focused: boolean;
+        onBlur: () => void;
+    };
+    inputRef: {
+        el: HTMLElement | null;
+    };
+    setup(): void;
+    state: {
+        shouldDisplayError: boolean;
+    };
+    onValueChanged(ev: Event): void;
+    get placeholder(): string;
+    get errorMessage(): string | undefined;
+}
+export {};

package/dist/types/components/side_panel/data_validation/dv_criterion_form/dv_single_input_criterion/dv_single_input_criterion.d.ts

@@ -0,0 +1,9 @@
+import { DataValidationCriterionForm } from "../dv_criterion_form";
+import { DataValidationInput } from "../dv_input/dv_input";
+export declare class DataValidationSingleInputCriterionForm extends DataValidationCriterionForm {
+    static template: string;
+    static components: {
+        DataValidationInput: typeof DataValidationInput;
+    };
+    onValueChanged(value: string): void;
+}

package/dist/types/components/side_panel/data_validation/dv_criterion_form/dv_value_in_list_criterion/dv_value_in_list_criterion.d.ts

@@ -0,0 +1,23 @@
+import { IsValueInListCriterion } from "../../../../../types";
+import { DataValidationCriterionForm } from "../dv_criterion_form";
+import { DataValidationInput } from "../dv_input/dv_input";
+interface State {
+    numberOfValues: number;
+    focusedValueIndex?: number;
+}
+export declare class DataValidationListCriterionForm extends DataValidationCriterionForm<IsValueInListCriterion> {
+    static template: string;
+    static components: {
+        DataValidationInput: typeof DataValidationInput;
+    };
+    state: State;
+    setup(): void;
+    onValueChanged(value: string, index: number): void;
+    onAddAnotherValue(): void;
+    removeItem(index: number): void;
+    onChangedDisplayStyle(ev: Event): void;
+    onKeyDown(ev: KeyboardEvent, index: number): void;
+    onBlurInput(): void;
+    get displayedValues(): string[];
+}
+export {};

package/dist/types/components/side_panel/data_validation/dv_criterion_form/dv_value_in_range_criterion/dv_value_in_range_criterion.d.ts

@@ -0,0 +1,12 @@
+import { IsValueInRangeCriterion } from "../../../../../types";
+import { SelectionInput } from "../../../../selection_input/selection_input";
+import { DataValidationCriterionForm } from "../dv_criterion_form";
+export declare class DataValidationValueInRangeCriterionForm extends DataValidationCriterionForm<IsValueInRangeCriterion> {
+    static template: string;
+    static components: {
+        SelectionInput: typeof SelectionInput;
+    };
+    setup(): void;
+    onRangeChanged(rangeXc: string): void;
+    onChangedDisplayStyle(ev: Event): void;
+}

package/dist/types/components/side_panel/data_validation/dv_editor/dv_editor.d.ts

@@ -0,0 +1,34 @@
+import { Component, ComponentConstructor } from "@odoo/owl";
+import { Action } from "../../../../actions/action";
+import { AddDataValidationCommand, DataValidationCriterion, DataValidationCriterionType, DataValidationRule, DataValidationRuleData, SpreadsheetChildEnv } from "../../../../types";
+import { SelectionInput } from "../../../selection_input/selection_input";
+import { SelectMenu } from "../../select_menu/select_menu";
+interface Props {
+    rule: DataValidationRule | undefined;
+    onExit: () => void;
+}
+interface State {
+    rule: DataValidationRuleData;
+}
+export declare class DataValidationEditor extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        SelectionInput: typeof SelectionInput;
+        SelectMenu: typeof SelectMenu;
+    };
+    state: State;
+    private editingSheetId;
+    setup(): void;
+    onCriterionTypeChanged(type: DataValidationCriterionType): void;
+    onRangesChanged(ranges: string[]): void;
+    onCriterionChanged(criterion: DataValidationCriterion): void;
+    changeRuleIsBlocking(ev: Event): void;
+    onSave(): void;
+    get canSave(): boolean;
+    get dispatchPayload(): Omit<AddDataValidationCommand, "type">;
+    get dvCriterionMenuItems(): Action[];
+    get selectedCriterionName(): string;
+    get defaultDataValidationRule(): DataValidationRuleData;
+    get criterionComponent(): ComponentConstructor | undefined;
+}
+export {};

package/dist/types/components/side_panel/data_validation/dv_preview/dv_preview.d.ts

@@ -0,0 +1,13 @@
+import { Component } from "@odoo/owl";
+import { DataValidationRule, SpreadsheetChildEnv } from "../../../../types";
+interface Props {
+    onClick: () => void;
+    rule: DataValidationRule;
+}
+export declare class DataValidationPreview extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    deleteDataValidation(): void;
+    get rangesString(): string;
+    get descriptionString(): string;
+}
+export {};

package/dist/types/components/side_panel/find_and_replace/find_and_replace.d.ts

@@ -0,0 +1,27 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../../types/index";
+interface Props {
+    onCloseSidePanel: () => void;
+}
+export declare class FindAndReplacePanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    private state;
+    private debounceTimeoutId;
+    private showFormulaState;
+    private searchInput;
+    get hasSearchResult(): boolean;
+    get pendingSearch(): boolean;
+    setup(): void;
+    onInput(ev: any): void;
+    onKeydownSearch(ev: KeyboardEvent): void;
+    onKeydownReplace(ev: KeyboardEvent): void;
+    searchFormulas(): void;
+    onSelectPreviousCell(): void;
+    onSelectNextCell(): void;
+    updateSearch(): void;
+    debouncedUpdateSearch(): void;
+    replace(): void;
+    replaceAll(): void;
+    private initialState;
+}
+export {};

package/dist/types/components/side_panel/more_formats/more_formats.d.ts

@@ -0,0 +1,10 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../../types";
+interface Props {
+    onCloseSidePanel: () => void;
+}
+export declare class MoreFormatsPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    get dateFormatsActions(): import("../../../actions/action").Action[];
+}
+export {};

package/dist/types/components/side_panel/remove_duplicates/remove_duplicates.d.ts

@@ -0,0 +1,32 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../../types/index";
+import { ValidationMessages } from "../../validation_messages/validation_messages";
+interface Props {
+    onCloseSidePanel: () => void;
+}
+interface RemoveDuplicatesState {
+    hasHeader: boolean;
+    columns: {
+        [colIndex: number]: boolean;
+    };
+}
+export declare class RemoveDuplicatesPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        ValidationMessages: typeof ValidationMessages;
+    };
+    state: RemoveDuplicatesState;
+    setup(): void;
+    toggleHasHeader(): void;
+    toggleAllColumns(): void;
+    toggleColumn(colIndex: number): void;
+    onRemoveDuplicates(): void;
+    getColLabel(colKey: string): string;
+    get isEveryColumnSelected(): boolean;
+    get errorMessages(): string[];
+    get selectionStatisticalInformation(): string;
+    get canConfirm(): boolean;
+    private updateColumns;
+    private getColsToAnalyze;
+}
+export {};

package/dist/types/components/side_panel/select_menu/select_menu.d.ts

@@ -0,0 +1,29 @@
+import { Component } from "@odoo/owl";
+import { Action } from "../../../actions/action";
+import { DOMCoordinates, MenuMouseEvent, SpreadsheetChildEnv } from "../../../types";
+import { Menu } from "../../menu/menu";
+export interface SelectMenuProps {
+    menuItems: Action[];
+    selectedValue: string;
+    class?: string;
+}
+interface State {
+    isMenuOpen: boolean;
+}
+/** This component looks like a select input, but on click it opens a Menu with the items given as props instead of a dropdown */
+export declare class SelectMenu extends Component<SelectMenuProps, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        Menu: typeof Menu;
+    };
+    menuId: string;
+    selectRef: {
+        el: HTMLElement | null;
+    };
+    selectRect: import("../../../types").Rect;
+    state: State;
+    onClick(ev: MenuMouseEvent): void;
+    onMenuClosed(): void;
+    get menuPosition(): DOMCoordinates;
+}
+export {};

package/dist/types/components/side_panel/settings/settings_panel.d.ts

@@ -0,0 +1,18 @@
+import { Component } from "@odoo/owl";
+import { Locale, LocaleCode, SpreadsheetChildEnv } from "../../../types";
+interface Props {
+    onCloseSidePanel: () => void;
+}
+export declare class SettingsPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    loadedLocales: Locale[];
+    setup(): void;
+    onLocaleChange(code: LocaleCode): void;
+    private loadLocales;
+    get numberFormatPreview(): import("../../../types").FormattedValue;
+    get dateFormatPreview(): import("../../../types").FormattedValue;
+    get dateTimeFormatPreview(): import("../../../types").FormattedValue;
+    get currentLocale(): Locale;
+    get supportedLocales(): Locale[];
+}
+export {};

package/dist/types/components/side_panel/side_panel/side_panel.d.ts

@@ -0,0 +1,18 @@
+import { Component } from "@odoo/owl";
+import { SidePanelContent } from "../../../registries/side_panel_registry";
+import { SpreadsheetChildEnv } from "../../../types";
+interface Props {
+    component: string;
+    panelProps: any;
+    onCloseSidePanel: () => void;
+}
+interface State {
+    panel: SidePanelContent;
+}
+export declare class SidePanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    state: State;
+    setup(): void;
+    getTitle(): string;
+}
+export {};

package/dist/types/components/side_panel/split_to_columns_panel/split_to_columns_panel.d.ts

@@ -0,0 +1,35 @@
+import { Component } from "@odoo/owl";
+import { NEWLINE } from "../../../constants";
+import { SpreadsheetChildEnv } from "../../../types/index";
+import { ValidationMessages } from "../../validation_messages/validation_messages";
+type SeparatorValue = "auto" | "custom" | " " | "," | ";" | typeof NEWLINE;
+interface Separator {
+    name: string;
+    value: SeparatorValue;
+}
+interface Props {
+    onCloseSidePanel: () => void;
+}
+interface State {
+    separatorValue: SeparatorValue;
+    customSeparator: string;
+    addNewColumns: boolean;
+}
+export declare class SplitIntoColumnsPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        ValidationMessages: typeof ValidationMessages;
+    };
+    state: State;
+    setup(): void;
+    onSeparatorChange(value: SeparatorValue): void;
+    updateCustomSeparator(ev: InputEvent): void;
+    updateAddNewColumnsCheckbox(ev: Event): void;
+    confirm(): void;
+    get errorMessages(): string[];
+    get warningMessages(): string[];
+    get separatorValue(): string;
+    get separators(): Separator[];
+    get isConfirmDisabled(): boolean;
+}
+export {};

package/dist/types/components/spreadsheet/spreadsheet.d.ts

@@ -0,0 +1,64 @@
+import { Component } from "@odoo/owl";
+import { Model } from "../../model";
+import { ComposerSelection } from "../../plugins/ui_stateful/edition";
+import { HeaderGroup, Pixel, SpreadsheetChildEnv } from "../../types";
+import { BottomBar } from "../bottom_bar/bottom_bar";
+import { SpreadsheetDashboard } from "../dashboard/dashboard";
+import { Grid } from "../grid/grid";
+import { HeaderGroupContainer } from "../header_group/header_group_container";
+import { SidePanel } from "../side_panel/side_panel/side_panel";
+import { TopBar } from "../top_bar/top_bar";
+export type ComposerFocusType = "inactive" | "cellFocus" | "contentFocus";
+export interface SpreadsheetProps {
+    model: Model;
+}
+interface SidePanelState {
+    isOpen: boolean;
+    component?: string;
+    panelProps: any;
+}
+interface ComposerState {
+    topBarFocus: Exclude<ComposerFocusType, "cellFocus">;
+    gridFocusMode: ComposerFocusType;
+}
+export declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        TopBar: typeof TopBar;
+        Grid: typeof Grid;
+        BottomBar: typeof BottomBar;
+        SidePanel: typeof SidePanel;
+        SpreadsheetDashboard: typeof SpreadsheetDashboard;
+        HeaderGroupContainer: typeof HeaderGroupContainer;
+    };
+    sidePanel: SidePanelState;
+    composer: ComposerState;
+    private _focusGrid?;
+    private keyDownMapping;
+    private isViewportTooSmall;
+    get model(): Model;
+    getStyle(): "grid-template-rows: auto;" | "grid-template-rows: 63px auto 37px";
+    setup(): void;
+    get focusTopBarComposer(): Omit<ComposerFocusType, "cellFocus">;
+    get focusGridComposer(): ComposerFocusType;
+    private bindModelEvents;
+    private unbindModelEvents;
+    private checkViewportSize;
+    openSidePanel(panel: string, panelProps: any): void;
+    closeSidePanel(): void;
+    toggleSidePanel(panel: string, panelProps: any): void;
+    focusGrid(): void;
+    onKeydown(ev: KeyboardEvent): void;
+    onTopBarComposerFocused(selection: ComposerSelection): void;
+    onGridComposerContentFocused(selection: ComposerSelection): void;
+    onGridComposerCellFocused(content?: string, selection?: ComposerSelection): void;
+    /**
+     * Start the edition or update the content if it's already started.
+     */
+    private setComposerContent;
+    get gridHeight(): Pixel;
+    get gridContainerStyle(): string;
+    get rowLayers(): HeaderGroup[][];
+    get colLayers(): HeaderGroup[][];
+}
+export {};

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

@@ -0,0 +1,65 @@
+import { Component } from "@odoo/owl";
+import { Action, ActionSpec } from "../../actions/action";
+import * as ACTION_EDIT from "../../actions/edit_actions";
+import * as ACTION_FORMAT from "../../actions/format_actions";
+import * as ACTION_VIEW from "../../actions/view_actions";
+import { ComposerSelection } from "../../plugins/ui_stateful/edition";
+import { Color, Pixel, SpreadsheetChildEnv } from "../../types/index";
+import { ActionButton } from "../action_button/action_button";
+import { BorderEditorWidget } from "../border_editor/border_editor_widget";
+import { ColorPicker } from "../color_picker/color_picker";
+import { ColorPickerWidget } from "../color_picker/color_picker_widget";
+import { TopBarComposer } from "../composer/top_bar_composer/top_bar_composer";
+import { FontSizeEditor } from "../font_size_editor/font_size_editor";
+import { Menu, MenuState } from "../menu/menu";
+import { ComposerFocusType } from "../spreadsheet/spreadsheet";
+import { PaintFormatButton } from "./../paint_format_button/paint_format_button";
+interface State {
+    menuState: MenuState;
+    activeTool: string;
+    fillColor: string;
+    textColor: string;
+}
+interface Props {
+    onClick: () => void;
+    focusComposer: Omit<ComposerFocusType, "cellFocus">;
+    onComposerContentFocused: (selection: ComposerSelection) => void;
+    dropdownMaxHeight: Pixel;
+}
+export declare class TopBar extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    get dropdownStyle(): string;
+    static components: {
+        ColorPickerWidget: typeof ColorPickerWidget;
+        ColorPicker: typeof ColorPicker;
+        Menu: typeof Menu;
+        TopBarComposer: typeof TopBarComposer;
+        FontSizeEditor: typeof FontSizeEditor;
+        ActionButton: typeof ActionButton;
+        PaintFormatButton: typeof PaintFormatButton;
+        BorderEditorWidget: typeof BorderEditorWidget;
+    };
+    state: State;
+    isSelectingMenu: boolean;
+    openedEl: HTMLElement | null;
+    menus: Action[];
+    EDIT: typeof ACTION_EDIT;
+    FORMAT: typeof ACTION_FORMAT;
+    VIEW: typeof ACTION_VIEW;
+    formatNumberMenuItemSpec: ActionSpec;
+    isntToolbarMenu: boolean;
+    setup(): void;
+    get topbarComponents(): import("../../registries/topbar_component_registry").TopbarComponent[];
+    onExternalClick(ev: MouseEvent): void;
+    onClick(): void;
+    onMenuMouseOver(menu: Action, ev: MouseEvent): void;
+    toggleDropdownTool(tool: string, ev: MouseEvent): void;
+    toggleContextMenu(menu: Action, ev: MouseEvent): void;
+    toggleToolbarContextMenu(menuSpec: ActionSpec, ev: MouseEvent): void;
+    private openMenu;
+    closeMenus(): void;
+    updateCellState(): void;
+    getMenuName(menu: Action): string;
+    setColor(target: string, color: Color): void;
+}
+export {};