@odoo/o-spreadsheet 19.4.0-alpha.6 → 19.4.0

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

@@ -1,3 +1,3 @@
-import { Component } from "@odoo/owl";
 import { Registry } from "./registry";
+import { Component } from "../owl3_compatibility_layer";
 export declare const chartComponentRegistry: Registry<new (...args: any) => Component>;

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

@@ -1,3 +1,4 @@
+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";
@@ -20,7 +21,8 @@ export interface ChartDataSourceBuilder<TExternal, TInternal> {
     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: unknown, items: unknown, chartJsChart: unknown, getters: Getters) => void;
+    onDataSetClick?: (chartType: ChartType, chartId: UID, event: ChartJS.ChartEvent, items: ChartJS.ActiveElement[], chartJsChart: ChartJS.Chart, getters: Getters) => void;
+    onDataSetHover?: (chartType: ChartType, chartId: UID, event: ChartJS.ChartEvent, items: ChartJS.ActiveElement[], chartJsChart: ChartJS.Chart) => void;
 }
 export interface ChartDataSourceRegistry extends Registry<ChartDataSourceBuilder<unknown, unknown>> {
     add<T extends ChartDataSourceType>(type: T, builder: ChartDataSourceBuilder<unknown, unknown>): this;

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

@@ -1,3 +1,4 @@
+import { CoreChartOptions } from "chart.js";
 import { ChartCreationContext, ChartData, ChartRuntime, ChartType, ChartTypeDefinition, ExcelChartDefinition } from "../types/chart/chart";
 import { CommandResult } from "../types/commands";
 import { CoreGetters } from "../types/core_getters";
@@ -54,10 +55,7 @@ interface ChartDataExtractors {
     extractData(): ChartData;
     extractHierarchicalData(): ChartData;
 }
-interface ChartJsEventHandlers {
-    onClick?: (event: unknown, items: unknown, chartJsChart: unknown) => void;
-    onHover?: (event: unknown, items: unknown, chartJsChart: unknown) => void;
-}
+export type ChartJsEventHandlers = Pick<CoreChartOptions<any>, "onClick" | "onHover">;
 export interface ChartTypeRegistry extends Registry<ChartTypeBuilder<any>> {
     add<T extends ChartType>(type: T, builder: ChartTypeBuilder<T>): this;
 }

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

@@ -1,7 +1,7 @@
-import { ComponentConstructor } from "@odoo/owl";
 import { GenericCriterionType } from "../types/generic_criterion";
 import { ValueAndLabel } from "../types/misc";
 import { Registry } from "./registry";
+import { ComponentConstructor } from "../owl3_compatibility_layer";
 export type CriterionCategory = "text" | "date" | "number" | "misc" | "list" | "relative";
 export declare const criterionCategoriesSequences: Record<CriterionCategory, number>;
 export type DataValidationCriterionItem = {

package/dist/types/registries/menus/sheet_menu_registry.d.ts

@@ -1,5 +1,6 @@
 import { MenuItemRegistry } from "../menu_items_registry";
 export declare function getSheetMenuRegistry(args: {
     renameSheetCallback: () => void;
-    openSheetColorPickerCallback: () => void;
+    openSheetTabColorPickerCallback: () => void;
+    openSheetBackgroundColorPickerCallback: () => void;
 }): MenuItemRegistry;

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

@@ -1,19 +1,20 @@
-import { ComponentConstructor } from "@odoo/owl";
 import { PropsOf } from "../types/props_of";
 import { SpreadsheetChildEnv } from "../types/spreadsheet_env";
+import { ComponentConstructor } from "../owl3_compatibility_layer";
+import { Registry } from "./registry";
 type ToolBarItem<C extends ComponentConstructor = ComponentConstructor> = {
+    name: string;
     component: C;
     props: PropsOf<C>;
     sequence: number;
     isVisible?: (env: SpreadsheetChildEnv) => boolean;
 };
-export declare class ToolBarRegistry {
-    content: {
-        [key: string]: ToolBarItem[];
-    };
+export declare class ToolBarRegistry extends Registry<ToolBarItem[]> {
     add(key: string): this;
-    addChild(key: string, value: ToolBarItem): this;
-    getEntries(id: string): ToolBarItem[];
+    addChild(category: string, item: ToolBarItem): this;
+    replaceChild(category: string, item: ToolBarItem): this;
+    removeChild(category: string, itemName: string): this;
+    getEntries(category: string): ToolBarItem[];
     getCategories(): string[];
 }
 export {};

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

@@ -11,6 +11,7 @@ declare class TopBarComponentRegistry extends Registry<TopbarComponent> {
     mapping: {
         [key: string]: Function;
     };
+    add(name: string, value: Omit<TopbarComponent, "id">): this;
     replace(name: string, value: Omit<TopbarComponent, "id">): this;
     getAllOrdered(): TopbarComponent[];
 }

package/dist/types/selection_stream/selection_stream_processor.d.ts

@@ -38,7 +38,7 @@ export declare class SelectionStreamProcessorImpl implements SelectionStreamProc
     /**
      * Select a single cell as the new anchor.
      */
-    selectCell(col: HeaderIndex, row: HeaderIndex): DispatchResult;
+    selectCell(col: HeaderIndex, row: HeaderIndex, options?: SelectionEventOptions): DispatchResult;
     /**
      * Set the selection to one of the cells adjacent to the current anchor cell.
      */

package/dist/types/store_engine/store_hooks.d.ts

@@ -1,9 +1,8 @@
 import { LocalStoreConstructor, Store, StoreConstructor, StoreParams } from "../types/store_engine";
-import { DependencyContainer } from "./dependency_container";
 /**
  * This hook should be used at the root of your app to provide the store container.
  */
-export declare function useStoreProvider(): DependencyContainer;
+export declare function useStoreProvider(): any;
 /**
  * Get the instance of a store.
  */

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

@@ -41,4 +41,5 @@ export declare class GridRenderer extends DisposableStore {
     private updateBoxesWithAnimations;
     private updateAnimationsProgress;
     private addNewAnimations;
+    private getBackgroundColor;
 }

package/dist/types/types/autofill.d.ts

@@ -8,8 +8,9 @@
  *  - Formula: update the formula, with the same behavior than paste
  */
 import { Cell } from "./cells";
+import { Format } from "./format";
 import { Getters } from "./getters";
-import { Border, DIRECTION, UID, UpdateCellData } from "./misc";
+import { Border, DIRECTION, Style, UID, UpdateCellData } from "./misc";
 export interface IncrementModifier {
     type: "INCREMENT_MODIFIER";
     increment: number;
@@ -53,6 +54,8 @@ export interface AutofillData {
     row: number;
     sheetId: UID;
     border?: Border;
+    style?: Style;
+    format?: Format;
 }
 export interface AutofillResult {
     cellData: AutofillCellData;

package/dist/types/types/cell_popovers.d.ts

@@ -1,8 +1,8 @@
-import { ComponentConstructor } from "@odoo/owl";
 import { Getters } from "./getters";
 import { CellPosition } from "./misc";
 import { PropsOf } from "./props_of";
 import { Rect } from "./rendering";
+import { ComponentConstructor } from "../owl3_compatibility_layer";
 export type CellPopoverType = "ErrorToolTip" | "LinkDisplay" | "FilterMenu" | "LinkEditor";
 export type PopoverPropsPosition = "top-right" | "bottom-left";
 type MaxSizedComponentConstructor = ComponentConstructor & {
@@ -37,14 +37,14 @@ export interface OpenCellPopover {
 type OpenCellPopoverComponent<C extends ComponentConstructor> = {
     isOpen: true;
     Component: C;
-    props: PropsOf<C>;
+    props: PropsOf<InstanceType<C>>;
     cellCorner: PopoverPropsPosition;
 };
 export type CellPopoverComponent<C extends MaxSizedComponentConstructor = MaxSizedComponentConstructor> = ClosedCellPopover | OpenCellPopoverComponent<C>;
 export type PositionedCellPopoverComponent<C extends MaxSizedComponentConstructor = MaxSizedComponentConstructor> = {
     isOpen: true;
     Component: C;
-    props: PropsOf<C>;
+    props: PropsOf<InstanceType<C>>;
     anchorRect: Rect;
     cellCorner: PopoverPropsPosition;
 };

package/dist/types/types/chart/bar_chart.d.ts

@@ -1,11 +1,12 @@
 import { ChartConfiguration } from "chart.js";
 import { Range } from "../range";
-import { CommonChartDefinition } from "./common_chart";
-export interface BarChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+import { DataSourceChartDefinition } from "./common_chart";
+export interface BarChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "bar";
     readonly stacked: boolean;
     readonly horizontal?: boolean;
     readonly zoomable?: boolean;
+    readonly showTotalLine?: boolean;
 }
 export type BarChartRuntime = {
     chartJsConfig: ChartConfiguration<"bar" | "line">;

package/dist/types/types/chart/calendar_chart.d.ts

@@ -2,10 +2,10 @@ import { ChartConfiguration } from "chart.js";
 import { Color } from "../misc";
 import { Range } from "../range";
 import { ChartColorScale } from "./chart";
-import { CommonChartDefinition } from "./common_chart";
+import { DataSourceChartDefinition } from "./common_chart";
 export declare const CALENDAR_CHART_GRANULARITIES: ("year" | "second_number" | "minute_number" | "hour_number" | "day_of_week" | "day_of_month" | "iso_week_number" | "month_number" | "quarter_number")[];
 export type CalendarChartGranularity = (typeof CALENDAR_CHART_GRANULARITIES)[number];
-export interface CalendarChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+export interface CalendarChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "calendar";
     readonly horizontalGroupBy: CalendarChartGranularity;
     readonly verticalGroupBy: CalendarChartGranularity;

package/dist/types/types/chart/chart.d.ts

@@ -161,6 +161,7 @@ export interface ExcelChartDefinition {
     readonly isDoughnut?: boolean;
     readonly pieHolePercentage?: number;
     readonly maxValue?: number;
+    readonly slicesColors?: Color[];
 }
 export interface ChartCreationContext {
     readonly dataSetStyles?: DataSetStyle;
@@ -182,6 +183,7 @@ export interface ChartCreationContext {
     readonly axesDesign?: AxesDesign;
     readonly fillArea?: boolean;
     readonly showValues?: boolean;
+    readonly showTotalLine?: boolean;
     readonly funnelColors?: FunnelChartColors;
     readonly showLabels?: boolean;
     readonly hideDataMarkers?: boolean;
@@ -199,6 +201,8 @@ export interface ChartCreationContext {
     readonly bubbleLabelRange?: string;
     readonly bubbleSizeRange?: string;
     readonly bubbleColorMode?: BubbleColorMode;
+    readonly annotationText?: string;
+    readonly annotationLink?: string;
 }
 export type ChartAxisFormats = {
     [axisId: string]: Format | undefined;

package/dist/types/types/chart/combo_chart.d.ts

@@ -2,8 +2,8 @@ import { ChartConfiguration } from "chart.js";
 import { UID } from "../misc";
 import { Range } from "../range";
 import { CustomizedDataSet } from "./chart";
-import { CommonChartDefinition } from "./common_chart";
-export interface ComboChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+import { DataSourceChartDefinition } from "./common_chart";
+export interface ComboChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly dataSetStyles: ComboChartDataSetStyle;
     readonly type: "combo";
     readonly hideDataMarkers?: boolean;

package/dist/types/types/chart/common_chart.d.ts

@@ -3,20 +3,21 @@ import { Range } from "../range";
 import { AxesDesign, ChartDataSource, DataSetStyle, TitleDesign } from "./chart";
 export type VerticalAxisPosition = "left" | "right";
 export type LegendPosition = "top" | "bottom" | "left" | "right" | "none";
-export interface CommonChartDefinition<T extends string | Range = Range> {
-    readonly dataSetStyles: DataSetStyle;
-    readonly dataSource: ChartDataSource<T>;
+export interface BaseChartDefinition {
     readonly title: TitleDesign;
     readonly background?: Color;
+    readonly annotationText?: string;
+    readonly annotationLink?: string;
+    readonly humanize?: boolean;
+}
+export interface DataSourceChartDefinition<T extends string | Range = Range> extends BaseChartDefinition {
+    readonly dataSetStyles: DataSetStyle;
+    readonly dataSource: ChartDataSource<T>;
     readonly legendPosition: LegendPosition;
     readonly aggregated?: boolean;
     readonly axesDesign?: AxesDesign;
     readonly showValues?: boolean;
-    readonly humanize?: boolean;
 }
-export interface NonDataSourceBaseChartDefinition {
-    readonly title: TitleDesign;
-    readonly background?: Color;
-    readonly humanize?: boolean;
+export interface NonDataSourceBaseChartDefinition extends BaseChartDefinition {
     readonly dataSource?: undefined;
 }

package/dist/types/types/chart/funnel_chart.d.ts

@@ -1,22 +1,12 @@
 import { ChartConfiguration } from "chart.js";
 import { Color } from "../misc";
 import { Range } from "../range";
-import { AxesDesign, ChartDataSource, DataSetStyle, TitleDesign } from "./chart";
-import { LegendPosition } from "./common_chart";
-export interface FunnelChartDefinition<T extends string | Range = Range> {
+import { DataSourceChartDefinition } from "./common_chart";
+export interface FunnelChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "funnel";
-    readonly dataSetStyles: DataSetStyle;
-    readonly dataSource: ChartDataSource<T>;
-    readonly title: TitleDesign;
-    readonly background?: Color;
-    readonly legendPosition: LegendPosition;
     readonly horizontal?: boolean;
-    readonly axesDesign?: AxesDesign;
-    readonly aggregated?: boolean;
-    readonly showValues?: boolean;
     readonly funnelColors?: FunnelChartColors;
     readonly cumulative?: boolean;
-    readonly humanize?: boolean;
 }
 export type FunnelChartRuntime = {
     chartJsConfig: ChartConfiguration;

package/dist/types/types/chart/geo_chart.d.ts

@@ -2,8 +2,8 @@ import { ChartConfiguration } from "chart.js";
 import { Color } from "../misc";
 import { Range } from "../range";
 import { ChartColorScale, ChartRuntimeGenerationArgs } from "./chart";
-import { CommonChartDefinition } from "./common_chart";
-export interface GeoChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+import { DataSourceChartDefinition } from "./common_chart";
+export interface GeoChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "geo";
     readonly colorScale?: ChartColorScale;
     readonly missingValueColor?: Color;

package/dist/types/types/chart/line_chart.d.ts

@@ -1,7 +1,7 @@
 import type { ChartConfiguration } from "chart.js";
 import { Range } from "../range";
-import { CommonChartDefinition } from "./common_chart";
-export interface LineChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+import { DataSourceChartDefinition } from "./common_chart";
+export interface LineChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "line";
     readonly labelsAsText: boolean;
     readonly stacked: boolean;

package/dist/types/types/chart/pie_chart.d.ts

@@ -1,8 +1,8 @@
 import type { ChartConfiguration } from "chart.js";
 import { Color } from "../misc";
 import { Range } from "../range";
-import { CommonChartDefinition } from "./common_chart";
-export interface PieChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+import { DataSourceChartDefinition } from "./common_chart";
+export interface PieChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "pie";
     readonly slicesColors?: Color[];
     readonly aggregated?: boolean;

package/dist/types/types/chart/radar_chart.d.ts

@@ -1,7 +1,7 @@
 import { ChartConfiguration } from "chart.js";
 import { Range } from "../range";
-import { CommonChartDefinition } from "./common_chart";
-export interface RadarChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+import { DataSourceChartDefinition } from "./common_chart";
+export interface RadarChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "radar";
     readonly aggregated?: boolean;
     readonly stacked: boolean;

package/dist/types/types/chart/sunburst_chart.d.ts

@@ -1,21 +1,18 @@
 import { ChartConfiguration, ChartDataset } from "chart.js";
 import { Color } from "../misc";
 import { Range } from "../range";
-import { ChartDataSource, ChartStyle, DataSetStyle, TitleDesign } from "./chart";
-import { LegendPosition } from "./common_chart";
-export interface SunburstChartDefinition<T extends string | Range = Range> {
+import { ChartDataSource, ChartStyle, DataSetStyle } from "./chart";
+import { BaseChartDefinition, LegendPosition } from "./common_chart";
+export interface SunburstChartDefinition<T extends string | Range = Range> extends BaseChartDefinition {
     readonly type: "sunburst";
     readonly dataSetStyles: DataSetStyle;
     readonly dataSource: ChartDataSource<T>;
-    readonly title: TitleDesign;
-    readonly background?: Color;
     readonly legendPosition: LegendPosition;
     readonly showValues?: boolean;
     readonly showLabels?: boolean;
     readonly valuesDesign?: ChartStyle;
     readonly groupColors?: (Color | undefined | null)[];
     readonly pieHolePercentage?: number;
-    readonly humanize?: boolean;
 }
 export type SunburstChartRuntime = {
     chartJsConfig: ChartConfiguration<"doughnut">;

package/dist/types/types/chart/tree_map_chart.d.ts

@@ -3,13 +3,11 @@ import { Color } from "../misc";
 import { Range } from "../range";
 import { ChartDataSource, DataSetStyle, TitleDesign } from "./chart";
 import { TreemapDataPoint } from "./chartjs_tree_map_type";
-import { LegendPosition } from "./common_chart";
-export interface TreeMapChartDefinition<T extends string | Range = Range> {
+import { BaseChartDefinition, LegendPosition } from "./common_chart";
+export interface TreeMapChartDefinition<T extends string | Range = Range> extends BaseChartDefinition {
     readonly type: "treemap";
     readonly dataSetStyles: DataSetStyle;
     readonly dataSource: ChartDataSource<T>;
-    readonly title: TitleDesign;
-    readonly background?: Color;
     readonly legendPosition: LegendPosition;
     readonly showHeaders?: boolean;
     readonly headerDesign?: TitleDesign;

package/dist/types/types/chart/waterfall_chart.d.ts

@@ -1,8 +1,8 @@
 import { ChartConfiguration } from "chart.js";
 import { Color } from "../misc";
 import { Range } from "../range";
-import { CommonChartDefinition, VerticalAxisPosition } from "./common_chart";
-export interface WaterfallChartDefinition<T extends string | Range = Range> extends CommonChartDefinition<T> {
+import { DataSourceChartDefinition, VerticalAxisPosition } from "./common_chart";
+export interface WaterfallChartDefinition<T extends string | Range = Range> extends DataSourceChartDefinition<T> {
     readonly type: "waterfall";
     readonly verticalAxisPosition: VerticalAxisPosition;
     readonly aggregated?: boolean;