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

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">;
 };
@@ -2606,9 +2595,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 +2607,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 +2795,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",
@@ -5192,16 +5181,15 @@ 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[];
@@ -5209,16 +5197,6 @@ interface AddFunctionDescriptionBase {
     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 +5204,6 @@ type FunctionDescription = AddFunctionDescription & {
     getArgToFocus: (argPosition: number) => number;
 };
 type EvalContext = {
-    __lastFnCalled?: string;
     __originSheetId: UID;
     __originCellXC: () => string | undefined;
     locale: Locale;
@@ -8494,10 +8471,11 @@ 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;
 
@@ -8543,6 +8521,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,10 +8558,11 @@ declare const registries: {
     autofillRulesRegistry: Registry<AutofillRule>;
     cellMenuRegistry: MenuItemRegistry;
     colMenuRegistry: MenuItemRegistry;
+    errorTypes: Set<string>;
     linkMenuRegistry: MenuItemRegistry;
     functionRegistry: {
         mapping: {
-            [key: string]: ComputeFunction<Arg, ValueAndFormat | Matrix<ValueAndFormat>>;
+            [key: string]: ComputeFunction<FPayload | Matrix<FPayload>>;
         };
         add(name: string, addDescr: AddFunctionDescription): any;
         content: {
@@ -8619,6 +8611,7 @@ declare const registries: {
 };
 declare const helpers: {
     arg: typeof arg;
+    isEvaluationError: typeof isEvaluationError;
     toBoolean: typeof toBoolean;
     toJsDate: typeof toJsDate;
     toNumber: typeof toNumber;
@@ -8639,8 +8632,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;
@@ -8690,4 +8681,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 { 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 };