@odoo/o-spreadsheet 18.0.55 → 18.0.67

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

@@ -0,0 +1,80 @@
+import { Component } from "@odoo/owl";
+import { ComponentsImportance } from "../../constants";
+import { Pixel, Rect, SpreadsheetChildEnv } from "../../types";
+import { PopoverPropsPosition } from "../../types/cell_popovers";
+export interface PopoverProps {
+    /**
+     * Rectangle around which the popover is displayed.
+     * Coordinates are expressed as absolute DOM position.
+     */
+    anchorRect: Rect;
+    /** The popover can be positioned below the anchor Rectangle, or to the right of the rectangle */
+    positioning: PopoverPropsPosition;
+    maxWidth?: Pixel;
+    maxHeight?: Pixel;
+    /** Offset to apply to the vertical position of the popover.*/
+    verticalOffset: number;
+    onMouseWheel?: () => void;
+    onPopoverMoved?: () => void;
+    onPopoverHidden?: () => void;
+    /** Setting popover to allow dynamic zIndex */
+    zIndex?: Number;
+}
+export declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        anchorRect: ObjectConstructor;
+        containerRect: {
+            type: ObjectConstructor;
+            optional: boolean;
+        };
+        positioning: {
+            type: StringConstructor;
+            optional: boolean;
+        };
+        maxWidth: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        maxHeight: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        verticalOffset: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        onMouseWheel: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        onPopoverHidden: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        onPopoverMoved: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        zIndex: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        slots: ObjectConstructor;
+    };
+    static defaultProps: {
+        positioning: string;
+        verticalOffset: number;
+        onMouseWheel: () => void;
+        onPopoverMoved: () => void;
+        onPopoverHidden: () => void;
+        zIndex: ComponentsImportance;
+    };
+    private popoverRef;
+    private currentPosition;
+    private currentDisplayValue;
+    private spreadsheetRect;
+    private containerRect;
+    setup(): void;
+    get popoverStyle(): string;
+}

package/dist/types/components/popover/popover_builders.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/scrollbar/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./scrollbar_horizontal";
+export * from "./scrollbar_vertical";

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

@@ -0,0 +1,39 @@
+import { Component } from "@odoo/owl";
+import { CSSProperties, Pixel } from "../../types";
+import { ScrollDirection } from "../scrollbar";
+interface Props {
+    width: Pixel;
+    height: Pixel;
+    direction: ScrollDirection;
+    position: CSSProperties;
+    offset: Pixel;
+    onScroll: (offset: Pixel) => void;
+}
+export declare class ScrollBar extends Component<Props> {
+    static props: {
+        width: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        height: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        direction: StringConstructor;
+        position: ObjectConstructor;
+        offset: NumberConstructor;
+        onScroll: FunctionConstructor;
+    };
+    static template: string;
+    static defaultProps: {
+        width: number;
+        height: number;
+    };
+    private scrollbarRef;
+    private scrollbar;
+    setup(): void;
+    get sizeCss(): string;
+    get positionCss(): string;
+    onScroll(ev: any): void;
+}
+export {};

package/dist/types/components/scrollbar/scrollbar_horizontal.d.ts

@@ -0,0 +1,32 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../types";
+import { ScrollBar } from "./scrollbar";
+interface Props {
+    leftOffset: number;
+}
+export declare class HorizontalScrollBar extends Component<Props, SpreadsheetChildEnv> {
+    static props: {
+        leftOffset: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+    };
+    static components: {
+        ScrollBar: typeof ScrollBar;
+    };
+    static template: string;
+    static defaultProps: {
+        leftOffset: number;
+    };
+    get offset(): import("../..").Pixel;
+    get width(): import("../..").Pixel;
+    get isDisplayed(): boolean;
+    get position(): {
+        left: string;
+        bottom: string;
+        height: string;
+        right: string;
+    };
+    onScroll(offset: any): void;
+}
+export {};

package/dist/types/components/scrollbar/scrollbar_vertical.d.ts

@@ -0,0 +1,32 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../types";
+import { ScrollBar } from "./scrollbar";
+interface Props {
+    topOffset: number;
+}
+export declare class VerticalScrollBar extends Component<Props, SpreadsheetChildEnv> {
+    static props: {
+        topOffset: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+    };
+    static components: {
+        ScrollBar: typeof ScrollBar;
+    };
+    static template: string;
+    static defaultProps: {
+        topOffset: number;
+    };
+    get offset(): import("../..").Pixel;
+    get height(): import("../..").Pixel;
+    get isDisplayed(): boolean;
+    get position(): {
+        top: string;
+        right: string;
+        width: string;
+        bottom: string;
+    };
+    onScroll(offset: any): void;
+}
+export {};

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

@@ -0,0 +1,9 @@
+import { Pixel } from "../types";
+export type ScrollDirection = "horizontal" | "vertical";
+export declare class ScrollBar {
+    private direction;
+    el: HTMLElement;
+    constructor(el: HTMLElement | null, direction: ScrollDirection);
+    get scroll(): Pixel;
+    set scroll(value: Pixel);
+}

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

@@ -0,0 +1,81 @@
+import { Component } from "@odoo/owl";
+import { Color, SpreadsheetChildEnv } from "../../types";
+import { RangeInputValue } from "./selection_input_store";
+interface Props {
+    ranges: string[];
+    hasSingleRange?: boolean;
+    required?: boolean;
+    isInvalid?: boolean;
+    class?: string;
+    onSelectionChanged?: (ranges: string[]) => void;
+    onSelectionConfirmed?: () => void;
+    colors?: Color[];
+}
+interface SelectionRange extends Omit<RangeInputValue, "color"> {
+    isFocused: boolean;
+    isValidRange: boolean;
+    color?: Color;
+}
+/**
+ * This component can be used when the user needs to input some
+ * ranges. He can either input the ranges with the regular DOM `<input/>`
+ * displayed or by selecting zones on the grid.
+ *
+ * onSelectionChanged is called every time the input value
+ * changes.
+ */
+export declare class SelectionInput extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        ranges: ArrayConstructor;
+        hasSingleRange: {
+            type: BooleanConstructor;
+            optional: boolean;
+        };
+        required: {
+            type: BooleanConstructor;
+            optional: boolean;
+        };
+        isInvalid: {
+            type: BooleanConstructor;
+            optional: boolean;
+        };
+        class: {
+            type: StringConstructor;
+            optional: boolean;
+        };
+        onSelectionChanged: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        onSelectionConfirmed: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        colors: {
+            type: ArrayConstructor;
+            optional: boolean;
+            default: never[];
+        };
+    };
+    private state;
+    private focusedInput;
+    private store;
+    get ranges(): SelectionRange[];
+    get canAddRange(): boolean;
+    get isInvalid(): boolean;
+    get isConfirmable(): boolean;
+    get isResettable(): boolean;
+    setup(): void;
+    getColor(range: SelectionRange): string;
+    private triggerChange;
+    onKeydown(ev: KeyboardEvent): void;
+    private extractRanges;
+    focus(rangeId: number): void;
+    addEmptyInput(): void;
+    removeInput(rangeId: number): void;
+    onInputChanged(rangeId: number, ev: InputEvent): void;
+    reset(): void;
+    confirm(): void;
+}
+export {};

package/dist/types/components/selection_input/selection_input_store.d.ts

@@ -0,0 +1,96 @@
+import { Get } from "../../store_engine";
+import { SpreadsheetStore } from "../../stores";
+import { SelectionEvent } from "../../types/event_stream";
+import { Color, Command, Highlight } from "../../types/index";
+export interface RangeInputValue {
+    id: number;
+    xc: string;
+    color: Color;
+}
+/**
+ * Selection input Plugin
+ *
+ * The SelectionInput component input and output are both arrays of strings, but
+ * it requires an intermediary internal state to work.
+ * This plugin handles this internal state.
+ */
+export declare class SelectionInputStore extends SpreadsheetStore {
+    private initialRanges;
+    private readonly inputHasSingleRange;
+    private readonly colors;
+    mutators: readonly ["resetWithRanges", "focusById", "unfocus", "addEmptyRange", "removeRange", "changeRange", "reset", "confirm"];
+    ranges: RangeInputValue[];
+    focusedRangeIndex: number | null;
+    private inputSheetId;
+    private focusStore;
+    protected highlightStore: {
+        readonly register: (highlightProvider: import("../../stores/highlight_store").HighlightProvider) => void;
+        readonly unRegister: (highlightProvider: import("../../stores/highlight_store").HighlightProvider) => void;
+        readonly mutators: readonly ["register", "unRegister"];
+        readonly renderingLayers: readonly ["Highlights"];
+        readonly highlights: Highlight[];
+    };
+    constructor(get: Get, initialRanges?: string[], inputHasSingleRange?: boolean, colors?: Color[]);
+    handleEvent(event: SelectionEvent): void;
+    handle(cmd: Command): void;
+    changeRange(rangeId: number, value: string): void;
+    addEmptyRange(): void;
+    removeRange(rangeId: number): void;
+    confirm(): void;
+    reset(): void;
+    get selectionInputValues(): string[];
+    /**
+     * Return a list of all valid XCs.
+     * e.g. ["A1", "Sheet2!B3", "E12"]
+     */
+    get selectionInputs(): (RangeInputValue & {
+        isFocused: boolean;
+        isValidRange: boolean;
+    })[];
+    get isResettable(): boolean;
+    get isConfirmable(): boolean;
+    get hasFocus(): boolean;
+    private get hasMainFocus();
+    get highlights(): Highlight[];
+    focusById(rangeId: number): void;
+    /**
+     * Focus a given range or remove the focus.
+     */
+    private focus;
+    private focusLast;
+    unfocus(): void;
+    private captureSelection;
+    resetWithRanges(ranges: string[]): void;
+    private setContent;
+    /**
+     * Insert new inputs after the given index.
+     */
+    private insertNewRange;
+    /**
+     * Set a new value in a given range input. If more than one value is provided,
+     * new inputs will be added.
+     */
+    private setRange;
+    private removeRangeByIndex;
+    /**
+     * Converts highlights input format to the command format.
+     * The first xc in the input range will keep its color.
+     * Invalid ranges and ranges from other sheets than the active sheets
+     * are ignored.
+     */
+    private inputToHighlights;
+    private cleanInputs;
+    /**
+     * Check if a cell or range reference should be highlighted.
+     * It should be highlighted if it references the current active sheet.
+     * Note that if no sheet name is given in the reference ("A1"), it refers to the
+     * active sheet when the selection input was enabled which might be different from
+     * the current active sheet.
+     */
+    private shouldBeHighlighted;
+    /**
+     * Return the index of a range given its id
+     * or `null` if the range is not found.
+     */
+    getIndex(rangeId: number | null): number | null;
+}

package/dist/types/components/side_panel/chart/bar_chart/bar_chart_config_panel.d.ts

@@ -0,0 +1,7 @@
+import { GenericChartConfigPanel } from "../building_blocks/generic_side_panel/config_panel";
+export declare class BarConfigPanel extends GenericChartConfigPanel {
+    static template: string;
+    get stackedLabel(): string;
+    onUpdateStacked(stacked: boolean): void;
+    onUpdateAggregated(aggregated: boolean): void;
+}

package/dist/types/components/side_panel/chart/building_blocks/axis_design/axis_design_editor.d.ts

@@ -0,0 +1,46 @@
+import { Component } from "@odoo/owl";
+import { ChartWithAxisDefinition, Color, DispatchResult, SpreadsheetChildEnv, TitleDesign, UID } from "../../../../../types";
+import { WaterfallChartDefinition } from "../../../../../types/chart/waterfall_chart";
+import { BadgeSelection } from "../../../components/badge_selection/badge_selection";
+import { Section } from "../../../components/section/section";
+import { ChartTitle } from "../title/title";
+export interface AxisDefinition {
+    id: string;
+    name: string;
+}
+interface Props {
+    figureId: UID;
+    definition: ChartWithAxisDefinition | WaterfallChartDefinition;
+    updateChart: (figureId: UID, definition: Partial<ChartWithAxisDefinition | WaterfallChartDefinition>) => DispatchResult;
+    axesList: AxisDefinition[];
+}
+export declare class AxisDesignEditor extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        Section: typeof Section;
+        ChartTitle: typeof ChartTitle;
+        BadgeSelection: typeof BadgeSelection;
+    };
+    static props: {
+        figureId: StringConstructor;
+        definition: ObjectConstructor;
+        updateChart: FunctionConstructor;
+        axesList: ArrayConstructor;
+    };
+    state: {
+        currentAxis: string;
+    };
+    get axisTitleStyle(): TitleDesign;
+    get badgeAxes(): {
+        value: string;
+        label: string;
+    }[];
+    updateAxisTitleColor(color: Color): void;
+    toggleBoldAxisTitle(): void;
+    toggleItalicAxisTitle(): void;
+    updateAxisTitleAlignment(align: "left" | "center" | "right"): void;
+    updateAxisEditor(ev: any): void;
+    getAxisTitle(): any;
+    updateAxisTitle(text: string): void;
+}
+export {};

package/dist/types/components/side_panel/chart/building_blocks/data_series/data_series.d.ts

@@ -0,0 +1,30 @@
+import { Component } from "@odoo/owl";
+import { Color, CustomizedDataSet, SpreadsheetChildEnv } from "../../../../../types";
+import { SelectionInput } from "../../../../selection_input/selection_input";
+import { Section } from "../../../components/section/section";
+interface Props {
+    ranges: CustomizedDataSet[];
+    hasSingleRange?: boolean;
+    onSelectionChanged: (ranges: string[]) => void;
+    onSelectionConfirmed: () => void;
+}
+export declare class ChartDataSeries extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        SelectionInput: typeof SelectionInput;
+        Section: typeof Section;
+    };
+    static props: {
+        ranges: ArrayConstructor;
+        hasSingleRange: {
+            type: BooleanConstructor;
+            optional: boolean;
+        };
+        onSelectionChanged: FunctionConstructor;
+        onSelectionConfirmed: FunctionConstructor;
+    };
+    get ranges(): string[];
+    get colors(): (Color | undefined)[];
+    get title(): string;
+}
+export {};

package/dist/types/components/side_panel/chart/building_blocks/error_section/error_section.d.ts

@@ -0,0 +1,21 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../../../../types";
+import { ValidationMessages } from "../../../../validation_messages/validation_messages";
+import { Section } from "../../../components/section/section";
+interface Props {
+    messages: string[];
+}
+export declare class ChartErrorSection extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        Section: typeof Section;
+        ValidationMessages: typeof ValidationMessages;
+    };
+    static props: {
+        messages: {
+            type: ArrayConstructor;
+            element: StringConstructor;
+        };
+    };
+}
+export {};

package/dist/types/components/side_panel/chart/building_blocks/general_design/general_design_editor.d.ts

@@ -0,0 +1,41 @@
+import { Component } from "@odoo/owl";
+import { ChartDefinition, Color, DispatchResult, SpreadsheetChildEnv, TitleDesign, UID } from "../../../../../types";
+import { SidePanelCollapsible } from "../../../components/collapsible/side_panel_collapsible";
+import { RoundColorPicker } from "../../../components/round_color_picker/round_color_picker";
+import { Section } from "../../../components/section/section";
+import { ChartTitle } from "../title/title";
+interface Props {
+    figureId: UID;
+    definition: ChartDefinition;
+    updateChart: (figureId: UID, definition: Partial<ChartDefinition>) => DispatchResult;
+}
+export declare class GeneralDesignEditor extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        RoundColorPicker: typeof RoundColorPicker;
+        ChartTitle: typeof ChartTitle;
+        Section: typeof Section;
+        SidePanelCollapsible: typeof SidePanelCollapsible;
+    };
+    static props: {
+        figureId: StringConstructor;
+        definition: ObjectConstructor;
+        updateChart: FunctionConstructor;
+        slots: {
+            type: ObjectConstructor;
+            optional: boolean;
+        };
+    };
+    private state;
+    setup(): void;
+    get title(): TitleDesign;
+    toggleDropdownTool(tool: string, ev: MouseEvent): void;
+    updateBackgroundColor(color: Color): void;
+    updateTitle(newTitle: string): void;
+    get titleStyle(): TitleDesign;
+    updateChartTitleColor(color: Color): void;
+    toggleBoldChartTitle(): void;
+    toggleItalicChartTitle(): void;
+    updateChartTitleAlignment(align: "left" | "center" | "right"): void;
+}
+export {};

package/dist/types/components/side_panel/chart/building_blocks/generic_side_panel/config_panel.d.ts

@@ -0,0 +1,87 @@
+import { Component } from "@odoo/owl";
+import { ChartWithAxisDefinition, CustomizedDataSet, DispatchResult, SpreadsheetChildEnv, UID } from "../../../../../types";
+import { Checkbox } from "../../../components/checkbox/checkbox";
+import { Section } from "../../../components/section/section";
+import { ChartDataSeries } from "../data_series/data_series";
+import { ChartErrorSection } from "../error_section/error_section";
+import { ChartLabelRange } from "../label_range/label_range";
+interface Props {
+    figureId: UID;
+    definition: ChartWithAxisDefinition;
+    canUpdateChart: (figureId: UID, definition: Partial<ChartWithAxisDefinition>) => DispatchResult;
+    updateChart: (figureId: UID, definition: Partial<ChartWithAxisDefinition>) => DispatchResult;
+}
+export declare class GenericChartConfigPanel extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        ChartDataSeries: typeof ChartDataSeries;
+        ChartLabelRange: typeof ChartLabelRange;
+        Section: typeof Section;
+        Checkbox: typeof Checkbox;
+        ChartErrorSection: typeof ChartErrorSection;
+    };
+    static props: {
+        figureId: StringConstructor;
+        definition: ObjectConstructor;
+        updateChart: FunctionConstructor;
+        canUpdateChart: FunctionConstructor;
+    };
+    private state;
+    private dataSeriesRanges;
+    private labelRange;
+    protected chartTerms: {
+        Series: string;
+        BackgroundColor: string;
+        StackedBarChart: string;
+        StackedLineChart: string;
+        StackedAreaChart: string;
+        StackedColumnChart: string;
+        CumulativeData: string;
+        TreatLabelsAsText: string;
+        AggregatedChart: string;
+        Errors: {
+            Unexpected: string;
+            InvalidDataSet: string;
+            InvalidLabelRange: string;
+            InvalidScorecardKeyValue: string;
+            InvalidScorecardBaseline: string;
+            InvalidGaugeDataRange: string;
+            EmptyGaugeRangeMin: string;
+            GaugeRangeMinNaN: string;
+            EmptyGaugeRangeMax: string;
+            GaugeRangeMaxNaN: string;
+            GaugeRangeMinBiggerThanRangeMax: string;
+            GaugeLowerInflectionPointNaN: string;
+            GaugeUpperInflectionPointNaN: string;
+        };
+    };
+    setup(): void;
+    get errorMessages(): string[];
+    get isDatasetInvalid(): boolean;
+    get isLabelInvalid(): boolean;
+    get dataSetsHaveTitleLabel(): string;
+    getLabelRangeOptions(): {
+        name: string;
+        label: string;
+        value: boolean;
+        onChange: (aggregated: boolean) => void;
+    }[];
+    onUpdateDataSetsHaveTitle(dataSetsHaveTitle: boolean): void;
+    /**
+     * Change the local dataSeriesRanges. The model should be updated when the
+     * button "confirm" is clicked
+     */
+    onDataSeriesRangesChanged(ranges: string[]): void;
+    onDataSeriesConfirmed(): void;
+    getDataSeriesRanges(): CustomizedDataSet[];
+    /**
+     * Change the local labelRange. The model should be updated when the
+     * button "confirm" is clicked
+     */
+    onLabelRangeChanged(ranges: string[]): void;
+    onLabelRangeConfirmed(): void;
+    getLabelRange(): string;
+    onUpdateAggregated(aggregated: boolean): void;
+    calculateHeaderPosition(): number | undefined;
+}
+export {};

package/dist/types/components/side_panel/chart/building_blocks/label_range/label_range.d.ts

@@ -0,0 +1,42 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../../../../types";
+import { SelectionInput } from "../../../../selection_input/selection_input";
+import { Checkbox } from "../../../components/checkbox/checkbox";
+import { Section } from "../../../components/section/section";
+interface Props {
+    title?: string;
+    range: string;
+    isInvalid: boolean;
+    onSelectionChanged: (range: string) => void;
+    onSelectionConfirmed: () => void;
+    options?: Array<{
+        name: string;
+        label: string;
+        value: boolean;
+        onChange: (value: boolean) => void;
+    }>;
+}
+export declare class ChartLabelRange extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        SelectionInput: typeof SelectionInput;
+        Checkbox: typeof Checkbox;
+        Section: typeof Section;
+    };
+    static props: {
+        title: {
+            type: StringConstructor;
+            optional: boolean;
+        };
+        range: StringConstructor;
+        isInvalid: BooleanConstructor;
+        onSelectionChanged: FunctionConstructor;
+        onSelectionConfirmed: FunctionConstructor;
+        options: {
+            type: ArrayConstructor;
+            optional: boolean;
+        };
+    };
+    static defaultProps: Partial<Props>;
+}
+export {};