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

package/dist/o-spreadsheet.d.ts

@@ -446,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;
@@ -472,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;
@@ -653,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;
@@ -2448,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[];
@@ -3263,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
      */
@@ -3673,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 {
@@ -3909,7 +3927,6 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
      */
     private clearPosition;
     private setGridLinesVisibility;
-    private clearZones;
     private createSheet;
     private moveSheet;
     private findIndexOfTargetSheet;
@@ -4115,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;
     /**
@@ -4548,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[];
@@ -5193,7 +5210,7 @@ interface AddFunctionDescription {
     description: string;
     category?: string;
     args: ArgDefinition[];
-    returns: [ArgType];
+    returns: ArgType[];
     isExported?: boolean;
     hidden?: boolean;
 }
@@ -5578,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> {
@@ -5894,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: {
@@ -5914,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;
     };
@@ -5939,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;
     };
@@ -6024,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;
     };
@@ -8479,6 +8492,19 @@ declare function toJsDate(data: FPayload | CellValue | undefined, locale: Locale
 
 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;
@@ -8560,20 +8586,7 @@ declare const registries: {
     colMenuRegistry: MenuItemRegistry;
     errorTypes: Set<string>;
     linkMenuRegistry: MenuItemRegistry;
-    functionRegistry: {
-        mapping: {
-            [key: string]: ComputeFunction<FPayload | Matrix<FPayload>>;
-        };
-        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>;
@@ -8652,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;
@@ -8681,4 +8701,4 @@ declare const constants: {
     DEFAULT_LOCALE: Locale;
 };
 
-export { AbstractChart, CancelledReason, CellErrorType, 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 };