@odoo/o-spreadsheet 16.5.0-alpha.2 → 16.5.0-alpha.4

package/dist/o-spreadsheet.d.ts

@@ -1,6 +1,6 @@
 import * as _odoo_owl from '@odoo/owl';
 import { ComponentConstructor, Component } from '@odoo/owl';
-import { ChartConfiguration, ChartData, ChartDataSets, ChartOptions } from 'chart.js';
+import { ChartConfiguration, ChartData, ChartDataset, ChartOptions } from 'chart.js';
 
 declare enum CellErrorLevel {
     silent = 0,
@@ -374,7 +374,7 @@ interface SectionThreshold {
 }
 interface GaugeChartConfiguration extends Omit<ChartConfiguration, "data" | "options"> {
     data?: GaugeChartData;
-    options?: GaugeChartOptions;
+    options: GaugeChartOptions;
 }
 interface GaugeChartRuntime {
     chartJsConfig: GaugeChartConfiguration;
@@ -383,32 +383,40 @@ interface GaugeChartRuntime {
 interface GaugeChartData extends Omit<ChartData, "datasets"> {
     datasets: GaugeChartDataSets[];
 }
-interface GaugeChartDataSets extends ChartDataSets {
+interface GaugeChartDataSets extends ChartDataset<"doughnut"> {
     readonly minValue?: number;
     readonly value?: number | undefined;
     readonly backgroundColor?: string[];
 }
 interface GaugeChartOptions extends ChartOptions {
-    needle?: {
-        radiusPercentage: number;
-        widthPercentage: number;
-        lengthPercentage: number;
-        color: Color;
+    needle?: NeedleOptions;
+    valueLabel?: ValueLabelOptions;
+}
+interface NeedleOptions {
+    display?: boolean;
+    borderColor?: Color;
+    backgroundColor?: Color;
+    /**
+     * Needle width as the percentage of the chart area width
+     */
+    width?: number;
+}
+interface ValueLabelOptions {
+    display?: boolean;
+    formatter?: (value: any) => string;
+    font?: {
+        size?: number;
+        family?: string;
+        color?: Color;
     };
-    valueLabel?: {
-        formatter: (() => string) | null;
-        display: boolean;
-        color: Color;
-        backgroundColor: Color;
-        borderRadius: number;
-        fontSize: number;
-        padding: {
-            top: number;
-            right: number;
-            bottom: number;
-            left: number;
-        };
-        bottomMarginPercentage: number;
+    backgroundColor?: Color;
+    borderColor?: Color;
+    borderRadius?: number;
+    padding?: {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
     };
 }
 
@@ -1083,11 +1091,6 @@ interface ImageProviderInterface {
     getImageOriginalSize(path: string): Promise<FigureSize>;
 }
 
-interface NotifyUIEvent {
-    type: "ERROR";
-    text: string;
-}
-
 /**
  * Model
  *
@@ -1133,7 +1136,8 @@ interface ModelConfig {
     readonly transportService: TransportService;
     readonly client: Client;
     readonly snapshotRequested: boolean;
-    readonly notifyUI: (payload: NotifyUIEvent) => void;
+    readonly notifyUI: (payload: InformationNotification) => void;
+    readonly raiseBlockingErrorUI: (text: string) => void;
 }
 interface ModelExternalConfig {
     readonly fileStore?: FileStore;
@@ -1363,7 +1367,7 @@ declare class BasePlugin<State = any, C = any> implements CommandHandler<C>, Val
     checkValidations<T>(command: T, ...validations: Validation<T>[]): CommandResult | CommandResult[];
 }
 
-type UIActions = Pick<ModelConfig, "notifyUI">;
+type UIActions = Pick<ModelConfig, "notifyUI" | "raiseBlockingErrorUI">;
 interface UIPluginConfig {
     readonly getters: Getters;
     readonly stateObserver: StateObserver;
@@ -2828,16 +2832,19 @@ type TranslationFunction = (string: string, ...values: string[] | [{
 /***
  * Allow to inject a translation function from outside o-spreadsheet.
  * @param tfn the function that will do the translation
+ * @param loaded a function that returns true when the translation is loaded
  */
-declare function setTranslationMethod(tfn: TranslationFunction): void;
+declare function setTranslationMethod(tfn: TranslationFunction, loaded?: () => boolean): void;
 
 interface EditTextOptions {
     error?: string;
     placeholder?: string;
 }
+type NotificationType = "danger" | "info" | "success" | "warning";
 interface InformationNotification {
     text: string;
-    tag: string;
+    type: NotificationType;
+    sticky: boolean;
 }
 interface SpreadsheetEnv {
     notifyUser: (notification: InformationNotification) => any;
@@ -6693,7 +6700,7 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     onCompositionEnd(): void;
     onKeydown(ev: KeyboardEvent): void;
     onInput(ev: InputEvent): void;
-    onKeyup(): void;
+    onKeyup(ev: KeyboardEvent): void;
     showAutocomplete(searchTerm: string): void;
     /**
      * This is required to ensure the content helper selection is
@@ -6863,7 +6870,6 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
     private bindModelEvents;
     private unbindModelEvents;
     private checkViewportSize;
-    private onNotifyUI;
     openSidePanel(panel: string, panelProps: any): void;
     closeSidePanel(): void;
     toggleSidePanel(panel: string, panelProps: any): void;
@@ -7184,7 +7190,7 @@ declare function chartFontColor(backgroundColor: Color | undefined): Color;
 /**
  * Get a default chart js configuration
  */
-declare function getDefaultChartJsRuntime(chart: AbstractChart, labels: string[], fontColor: Color, { format, locale }: LocaleFormat): ChartConfiguration;
+declare function getDefaultChartJsRuntime(chart: AbstractChart, labels: string[], fontColor: Color, { format, locale }: LocaleFormat): Required<ChartConfiguration>;
 /** See https://www.chartjs.org/docs/latest/charts/area.html#filling-modes */
 declare function getFillingMode(index: number): "origin" | number;