@odoo/o-spreadsheet 17.2.0-alpha.0 → 17.2.0-alpha.2

package/dist/o-spreadsheet.d.ts

@@ -2,17 +2,6 @@ import * as _odoo_owl from '@odoo/owl';
 import { ComponentConstructor, Component } from '@odoo/owl';
 import { ChartConfiguration, ChartData, ChartDataset, ChartOptions } from 'chart.js';
 
-declare enum CellErrorLevel {
-    silent = 0,
-    error = 1
-}
-declare class EvaluationError extends Error {
-    readonly errorType: string;
-    readonly logLevel: number;
-    constructor(errorType: string, message: string, logLevel?: number);
-    get isVerbose(): boolean;
-}
-
 declare const functionCache: {
     [key: string]: Omit<CompiledFormula, "dependencies" | "tokens">;
 };
@@ -457,6 +446,11 @@ type PieChartRuntime = {
     background: Color;
 };
 
+interface ScatterChartDefinition extends Omit<LineChartDefinition, "type" | "stacked" | "cumulative"> {
+    readonly type: "scatter";
+}
+type ScatterChartRuntime = LineChartRuntime;
+
 interface ScorecardChartDefinition {
     readonly type: "scorecard";
     readonly title: string;
@@ -483,9 +477,9 @@ interface ScorecardChartRuntime {
     readonly baselineStyle?: Style;
 }
 
-type ChartType = "line" | "bar" | "pie" | "scorecard" | "gauge";
-type ChartDefinition = LineChartDefinition | PieChartDefinition | BarChartDefinition | ScorecardChartDefinition | GaugeChartDefinition;
-type ChartJSRuntime = LineChartRuntime | PieChartRuntime | BarChartRuntime | GaugeChartRuntime;
+type ChartType = "line" | "bar" | "pie" | "scorecard" | "gauge" | "scatter";
+type ChartDefinition = LineChartDefinition | PieChartDefinition | BarChartDefinition | ScorecardChartDefinition | GaugeChartDefinition | ScatterChartDefinition;
+type ChartJSRuntime = LineChartRuntime | PieChartRuntime | BarChartRuntime | GaugeChartRuntime | ScatterChartRuntime;
 type ChartRuntime = ChartJSRuntime | ScorecardChartRuntime;
 interface ExcelChartDataset {
     readonly label?: string;
@@ -664,13 +658,23 @@ interface ExcelCellData extends CellData {
     isFormula: Boolean;
     computedFormat?: Format;
 }
-interface ExcelSheetData extends Omit<SheetData, "figureTables"> {
+interface ExcelSheetData extends Omit<SheetData, "figureTables" | "cols" | "rows"> {
     cells: {
         [key: string]: ExcelCellData | undefined;
     };
     charts: FigureData<ExcelChartDefinition>[];
     images: FigureData<Image>[];
     filterTables: ExcelFilterTableData[];
+    cols: {
+        [key: number]: ExcelHeaderData;
+    };
+    rows: {
+        [key: number]: ExcelHeaderData;
+    };
+}
+interface ExcelHeaderData extends HeaderData {
+    outlineLevel?: number;
+    collapsed?: boolean;
 }
 interface FilterTableData {
     range: string;
@@ -2459,7 +2463,8 @@ declare const enum CommandResult {
     InvalidNumberOfCriterionValues = "InvalidNumberOfCriterionValues",
     BlockingValidationRule = "BlockingValidationRule",
     InvalidCopyPasteSelection = "InvalidCopyPasteSelection",
-    NoChanges = "NoChanges"
+    NoChanges = "NoChanges",
+    InvalidInputId = "InvalidInputId"
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -2606,9 +2611,9 @@ interface Border$1 {
     bottom?: BorderDescr;
     right?: BorderDescr;
 }
-type ReferenceDenormalizer = (range: Range, isMeta: boolean, functionName: string, paramNumber: number) => any | any[][];
-type EnsureRange = (range: Range) => Matrix<ValueAndFormat>;
-type _CompiledFormula = (deps: Range[], refFn: ReferenceDenormalizer, range: EnsureRange, ctx: {}) => Matrix<ValueAndFormat> | ValueAndFormat;
+type ReferenceDenormalizer = (range: Range, isMeta: boolean, functionName: string, paramNumber: number) => FPayload;
+type EnsureRange = (range: Range) => Matrix<FPayload>;
+type _CompiledFormula = (deps: Range[], refFn: ReferenceDenormalizer, range: EnsureRange, ctx: {}) => Matrix<FPayload> | FPayload;
 interface CompiledFormula {
     execute: _CompiledFormula;
     tokens: Token[];
@@ -2618,12 +2623,12 @@ interface RangeCompiledFormula extends Omit<CompiledFormula, "dependencies"> {
     dependencies: Range[];
 }
 type Matrix<T = unknown> = T[][];
-type ValueAndFormat = {
+type FPayload = {
     value: CellValue;
     format?: Format;
+    message?: string;
 };
-type Arg = Maybe<ValueAndFormat> | Matrix<ValueAndFormat>;
-type ArgValue = Maybe<CellValue> | Matrix<CellValue>;
+type Arg = Maybe<FPayload> | Matrix<FPayload>;
 declare function isMatrix(x: any): x is Matrix<any>;
 interface HeaderDimensions {
     start: Pixel;
@@ -2806,7 +2811,7 @@ interface EmptyCell extends EvaluatedCellProperties {
 interface ErrorCell extends EvaluatedCellProperties {
     readonly type: CellValueType.error;
     readonly value: string;
-    readonly error: EvaluationError;
+    readonly message?: string;
 }
 declare enum CellValueType {
     boolean = "boolean",
@@ -3274,6 +3279,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
     adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID): void;
     allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
+    private clearZones;
     /**
      * Set a format to all the cells in a zone
      */
@@ -3684,6 +3690,7 @@ declare class HeaderGroupingPlugin extends CorePlugin<State$7> {
     private getGroupIndex;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
+    exportForExcel(data: ExcelWorkbookData): void;
 }
 
 interface HeaderSizeState$1 {
@@ -3920,7 +3927,6 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
      */
     private clearPosition;
     private setGridLinesVisibility;
-    private clearZones;
     private createSheet;
     private moveSheet;
     private findIndexOfTargetSheet;
@@ -4126,6 +4132,7 @@ declare class EvaluationDataValidationPlugin extends UIPlugin {
     static getters: readonly ["getDataValidationInvalidCriterionValueMessage", "getDataValidationCheckBoxCellPositions", "getDataValidationListCellsPositions", "getInvalidDataValidationMessage", "getValidationResultForCellValue", "isCellValidCheckbox", "isDataValidationInvalid"];
     validationResults: Record<UID, SheetValidationResult>;
     handle(cmd: CoreViewCommand): void;
+    private setContentToBooleanCells;
     isDataValidationInvalid(cellPosition: CellPosition): boolean;
     getInvalidDataValidationMessage(cellPosition: CellPosition): string | undefined;
     /**
@@ -4559,14 +4566,13 @@ interface RangeInputValue {
  * This plugin handles this internal state.
  */
 declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<SelectionEvent> {
-    private readonly inputHasSingleRange;
+    readonly inputHasSingleRange: boolean;
     static layers: LAYERS[];
     static getters: never[];
     ranges: RangeInputValue[];
     focusedRangeIndex: number | null;
     private inputSheetId;
     constructor(config: UIPluginConfig, initialRanges: string[], inputHasSingleRange: boolean);
-    allowDispatch(cmd: LocalCommand): CommandResult;
     handleEvent(event: SelectionEvent): void;
     handle(cmd: Command): void;
     getSelectionInputValue(): string[];
@@ -5192,33 +5198,22 @@ type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RAN
 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 {
+type ComputeFunction<R> = (this: EvalContext, ...args: Arg[]) => R;
+interface AddFunctionDescription {
+    compute: ComputeFunction<FPayload | Matrix<FPayload> | CellValue | Matrix<CellValue>>;
     description: string;
     category?: string;
     args: ArgDefinition[];
-    returns: [ArgType];
+    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;
@@ -5226,7 +5221,6 @@ type FunctionDescription = AddFunctionDescription & {
     getArgToFocus: (argPosition: number) => number;
 };
 type EvalContext = {
-    __lastFnCalled?: string;
     __originSheetId: UID;
     __originCellXC: () => string | undefined;
     locale: Locale;
@@ -5601,7 +5595,7 @@ interface Props$L {
         name: string;
         label: string;
         value: boolean;
-        update: (value: boolean) => void;
+        onChange: (value: boolean) => void;
     }>;
 }
 declare class ChartLabelRange extends Component<Props$L, SpreadsheetChildEnv> {
@@ -5917,7 +5911,6 @@ interface Props$H {
 declare class ChartTitle extends Component<Props$H, SpreadsheetChildEnv> {
     static template: string;
     static components: {
-        ColorPickerWidget: typeof ColorPickerWidget;
         Section: typeof Section;
     };
     static props: {
@@ -5937,7 +5930,6 @@ declare class LineBarPieDesignPanel extends Component<Props$G, SpreadsheetChildE
     static template: string;
     static components: {
         ChartColor: typeof ChartColor;
-        ColorPickerWidget: typeof ColorPickerWidget;
         ChartTitle: typeof ChartTitle;
         Section: typeof Section;
     };
@@ -5962,7 +5954,6 @@ interface Props$F {
 declare class GaugeChartConfigPanel extends Component<Props$F, SpreadsheetChildEnv> {
     static template: string;
     static components: {
-        SelectionInput: typeof SelectionInput;
         ChartErrorSection: typeof ChartErrorSection;
         ChartDataSeries: typeof ChartDataSeries;
     };
@@ -6047,7 +6038,6 @@ declare class ScorecardChartConfigPanel extends Component<Props$D, SpreadsheetCh
     static template: string;
     static components: {
         SelectionInput: typeof SelectionInput;
-        ValidationMessages: typeof ValidationMessages;
         ChartErrorSection: typeof ChartErrorSection;
         Section: typeof Section;
     };
@@ -8494,13 +8484,27 @@ declare class ChartPanel extends Component<Props, SpreadsheetChildEnv> {
     activatePanel(panel: "configuration" | "design"): void;
 }
 
-declare function toNumber(value: string | number | boolean | null | undefined, locale: Locale): number;
-declare function toString(value: string | number | boolean | null | undefined): string;
-declare function toBoolean(value: string | number | boolean | null | undefined): boolean;
-declare function toJsDate(value: string | number | boolean | null | undefined, locale: Locale): DateTime;
+declare function isEvaluationError(error: Maybe<CellValue>): boolean;
+declare function toNumber(data: FPayload | CellValue | undefined, locale: Locale): number;
+declare function toString(data: FPayload | CellValue | undefined): string;
+declare function toBoolean(data: FPayload | CellValue | undefined): boolean;
+declare function toJsDate(data: FPayload | CellValue | undefined, locale: Locale): DateTime;
 
 declare function arg(definition: string, description?: string): ArgDefinition;
 
+interface FunctionRegistry extends Registry<FunctionDescription> {
+    add(functionName: string, addDescr: AddFunctionDescription): FunctionRegistry;
+    get(functionName: string): FunctionDescription;
+    mapping: {
+        [functionName: string]: ComputeFunction<Matrix<FPayload> | FPayload>;
+    };
+}
+declare class FunctionRegistry extends Registry<FunctionDescription> {
+    mapping: {
+        [key: string]: ComputeFunction<Matrix<FPayload> | FPayload>;
+    };
+}
+
 declare class ChartColors {
     private graphColorIndex;
     next(): string;
@@ -8543,6 +8547,19 @@ type TranslationFunction = (string: string, ...values: SprintfValues) => string;
  */
 declare function setTranslationMethod(tfn: TranslationFunction, loaded?: () => boolean): void;
 
+declare const CellErrorType: {
+    readonly NotAvailable: "#N/A";
+    readonly InvalidReference: "#REF";
+    readonly BadExpression: "#BAD_EXPR";
+    readonly CircularDependency: "#CYCLE";
+    readonly UnknownFunction: "#NAME?";
+    readonly GenericError: "#ERROR";
+};
+declare class EvaluationError extends Error {
+    readonly value: string;
+    constructor(message?: string, value?: string);
+}
+
 /**
  * We export here all entities that needs to be accessed publicly by Odoo.
  *
@@ -8567,21 +8584,9 @@ declare const registries: {
     autofillRulesRegistry: Registry<AutofillRule>;
     cellMenuRegistry: MenuItemRegistry;
     colMenuRegistry: MenuItemRegistry;
+    errorTypes: Set<string>;
     linkMenuRegistry: MenuItemRegistry;
-    functionRegistry: {
-        mapping: {
-            [key: string]: ComputeFunction<Arg, ValueAndFormat | Matrix<ValueAndFormat>>;
-        };
-        add(name: string, addDescr: AddFunctionDescription): any;
-        content: {
-            [key: string]: FunctionDescription;
-        };
-        get(key: string): FunctionDescription;
-        contains(key: string): boolean;
-        getAll(): FunctionDescription[];
-        getKeys(): string[];
-        remove(key: string): void;
-    };
+    functionRegistry: FunctionRegistry;
     featurePluginRegistry: Registry<UIPluginConstructor>;
     statefulUIPluginRegistry: Registry<UIPluginConstructor>;
     coreViewsPluginRegistry: Registry<UIPluginConstructor>;
@@ -8619,6 +8624,7 @@ declare const registries: {
 };
 declare const helpers: {
     arg: typeof arg;
+    isEvaluationError: typeof isEvaluationError;
     toBoolean: typeof toBoolean;
     toJsDate: typeof toJsDate;
     toNumber: typeof toNumber;
@@ -8639,8 +8645,6 @@ declare const helpers: {
     getDefaultChartJsRuntime: typeof getDefaultChartJsRuntime;
     chartFontColor: typeof chartFontColor;
     ChartColors: typeof ChartColors;
-    EvaluationError: typeof EvaluationError;
-    CellErrorLevel: typeof CellErrorLevel;
     getFillingMode: typeof getFillingMode;
     rgbaToHex: typeof rgbaToHex;
     colorToRGBA: typeof colorToRGBA;
@@ -8661,6 +8665,13 @@ declare const links: {
     urlRepresentation: typeof urlRepresentation;
 };
 declare const components: {
+    Checkbox: typeof Checkbox;
+    Section: typeof Section;
+    ChartColor: typeof ChartColor;
+    ChartDataSeries: typeof ChartDataSeries;
+    ChartErrorSection: typeof ChartErrorSection;
+    ChartLabelRange: typeof ChartLabelRange;
+    ChartTitle: typeof ChartTitle;
     ChartPanel: typeof ChartPanel;
     ChartFigure: typeof ChartFigure;
     ChartJsComponent: typeof ChartJsComponent;
@@ -8690,4 +8701,4 @@ declare const constants: {
     DEFAULT_LOCALE: Locale;
 };
 
-export { AbstractChart, CancelledReason, Client, ClientJoinedMessage, ClientLeftMessage, ClientMovedMessage, CollaborationMessage, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, Registry, RemoteRevisionMessage, Revision, RevisionRedoneMessage, RevisionUndoneMessage, SPREADSHEET_DIMENSIONS, Spreadsheet, TransportService, UIPlugin, __info__, addFunction, astToFormula, compile, compileTokens, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, parseTokens, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };
+export { AST, ASTFuncall, AbstractChart, AddFunctionDescription, Arg, CancelledReason, Cell, CellErrorType, CellPosition, Client, ClientJoinedMessage, ClientLeftMessage, ClientMovedMessage, CollaborationMessage, CommandResult, CorePlugin, DispatchResult, EnrichedToken, EvalContext, EvaluationError, FPayload, FunctionRegistry, Model, Registry, RemoteRevisionMessage, Revision, RevisionRedoneMessage, RevisionUndoneMessage, SPREADSHEET_DIMENSIONS, Spreadsheet, Token, TransportService, UIPlugin, __info__, addFunction, astToFormula, compile, compileTokens, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, parseTokens, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };