@odoo/o-spreadsheet 18.0.55 → 18.0.67

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

@@ -0,0 +1,13 @@
+import { InformationNotification } from "../types";
+export interface NotificationStoreMethods {
+    notifyUser: (notification: InformationNotification) => void;
+    raiseError: (text: string, callback?: () => void) => void;
+    askConfirmation: (content: string, confirm: () => void, cancel?: () => void) => void;
+}
+export declare class NotificationStore {
+    mutators: readonly ["notifyUser", "raiseError", "askConfirmation", "updateNotificationCallbacks"];
+    notifyUser: NotificationStoreMethods["notifyUser"];
+    askConfirmation: NotificationStoreMethods["askConfirmation"];
+    raiseError: NotificationStoreMethods["raiseError"];
+    updateNotificationCallbacks(methods: Partial<NotificationStoreMethods>): void;
+}

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

@@ -0,0 +1,12 @@
+import { GridRenderingContext, LayerName } from "../types";
+export interface Renderer {
+    drawLayer(ctx: GridRenderingContext, layer: LayerName): void;
+    renderingLayers: Readonly<LayerName[]>;
+}
+export declare class RendererStore {
+    mutators: readonly ["register", "unRegister", "drawLayer"];
+    private renderers;
+    register(renderer: Renderer): void;
+    unRegister(renderer: Renderer): void;
+    drawLayer(context: GridRenderingContext, layer: LayerName): string;
+}

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

@@ -0,0 +1,13 @@
+import { Model } from "../model";
+import { DisposableStore, Get } from "../store_engine";
+import { Command, GridRenderingContext, LayerName } from "../types";
+export declare class SpreadsheetStore extends DisposableStore {
+    protected model: Model;
+    protected getters: import("..").Getters;
+    private renderer;
+    constructor(get: Get);
+    get renderingLayers(): Readonly<LayerName[]>;
+    protected handle(cmd: Command): void;
+    protected finalize(): void;
+    drawLayer(ctx: GridRenderingContext, layer: LayerName): void;
+}

package/dist/types/translation.d.ts

@@ -0,0 +1,21 @@
+type SprintfValues = (string | String | number)[] | [{
+    [key: string]: string | number;
+}];
+export type TranslationFunction = (string: string, ...values: SprintfValues) => string;
+/***
+ * Allow to inject a translation function from outside o-spreadsheet. This should be called before instantiating
+ * a model.
+ * @param tfn the function that will do the translation
+ * @param loaded a function that returns true when the translation is loaded
+ */
+export declare function setTranslationMethod(tfn: TranslationFunction, loaded?: () => boolean): void;
+/**
+ * If no translation function has been set, this will mark the translation are loaded.
+ *
+ * By default, the translations should not be set as loaded, otherwise top-level translated constants will never be
+ * translated. But if by the time the model is instantiated no custom translation function has been set, we can set
+ * the default translation function as loaded so o-spreadsheet can be run in standalone with no translations.
+ */
+export declare function setDefaultTranslationMethod(): void;
+export declare const _t: TranslationFunction;
+export {};

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

@@ -0,0 +1,71 @@
+/**
+ * An AutofillModifier describe the possible operations to apply to the
+ * content of a cell when we autofill this cell.
+ *
+ * It could be:
+ *  - Increment: increment the content by a given step
+ *  - Copy: simply copy the content
+ *  - Formula: update the formula, with the same behavior than paste
+ */
+import { Getters } from ".";
+import { Cell } from "./cells";
+import { Border, DIRECTION, UID, UpdateCellData } from "./misc";
+export interface IncrementModifier {
+    type: "INCREMENT_MODIFIER";
+    increment: number;
+    current: number;
+}
+export interface AlphanumericIncrementModifier {
+    type: "ALPHANUMERIC_INCREMENT_MODIFIER";
+    increment: number;
+    current: number;
+    prefix: string;
+    numberPostfixLength: number;
+}
+export interface DateIncrementModifier {
+    type: "DATE_INCREMENT_MODIFIER";
+    current: number;
+    increment: {
+        years: number;
+        months: number;
+        days: number;
+    };
+}
+export interface CopyModifier {
+    type: "COPY_MODIFIER";
+}
+export interface FormulaModifier {
+    type: "FORMULA_MODIFIER";
+    increment: number;
+    current: number;
+}
+export type AutofillModifier = IncrementModifier | AlphanumericIncrementModifier | CopyModifier | FormulaModifier | DateIncrementModifier;
+export interface Tooltip {
+    props: any;
+    component?: any;
+}
+export interface AutofillCellData extends UpdateCellData {
+    border?: Border;
+}
+export interface AutofillData {
+    cell?: Cell;
+    col: number;
+    row: number;
+    sheetId: UID;
+    border?: Border;
+}
+export interface AutofillResult {
+    cellData: AutofillCellData;
+    tooltip?: Tooltip;
+    origin: {
+        col: number;
+        row: number;
+    };
+}
+export interface GeneratorCell {
+    data: AutofillData;
+    rule: AutofillModifier;
+}
+export interface AutofillModifierImplementation {
+    apply: (rule: AutofillModifier, data: AutofillData, getters: Getters, direction: DIRECTION) => Omit<AutofillResult, "origin">;
+}

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

@@ -0,0 +1,50 @@
+import { ComponentConstructor } from "@odoo/owl";
+import { Getters } from "./index";
+import { CellPosition, PropsOf } from "./misc";
+import { Rect } from "./rendering";
+export type CellPopoverType = "ErrorToolTip" | "LinkDisplay" | "FilterMenu" | "LinkEditor";
+export type PopoverPropsPosition = "TopRight" | "BottomLeft";
+type MaxSizedComponentConstructor = ComponentConstructor & {
+    maxSize?: {
+        maxWidth?: number;
+        maxHeight?: number;
+    };
+};
+/**
+ * If the cell at the given position have an associated component (linkDisplay, errorTooltip, ...),
+ * returns the parameters to display the component
+ */
+type CellPopoverBuilder = (position: CellPosition, getters: Getters) => CellPopoverComponent<MaxSizedComponentConstructor>;
+export interface PopoverBuilders {
+    onOpen?: CellPopoverBuilder;
+    onHover?: CellPopoverBuilder;
+}
+export interface ClosedCellPopover {
+    isOpen: false;
+}
+export interface OpenCellPopover {
+    isOpen: true;
+    type: CellPopoverType;
+    col: number;
+    row: number;
+}
+/**
+ * Description of a cell component.
+ * i.e. which component class, which props and where to
+ * display it relative to the cell
+ */
+type OpenCellPopoverComponent<C extends ComponentConstructor> = {
+    isOpen: true;
+    Component: C;
+    props: PropsOf<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>;
+    anchorRect: Rect;
+    cellCorner: PopoverPropsPosition;
+};
+export {};

package/dist/types/types/cells.d.ts

@@ -0,0 +1,64 @@
+import { Format, FormattedValue } from "./format";
+import { FunctionResultObject, Link, RangeCompiledFormula, Style, UID } from "./misc";
+interface CellAttributes {
+    readonly id: UID;
+    /**
+     * Raw cell content
+     */
+    readonly content: string;
+    readonly style?: Style;
+    readonly format?: Format;
+}
+export interface LiteralCell extends CellAttributes {
+    readonly isFormula: false;
+    readonly parsedValue: CellValue;
+}
+export interface FormulaCell extends CellAttributes {
+    readonly isFormula: true;
+    readonly compiledFormula: RangeCompiledFormula;
+}
+export type Cell = LiteralCell | FormulaCell;
+interface EvaluatedCellProperties extends FunctionResultObject {
+    readonly format?: Format;
+    /**
+     * Cell value formatted based on the format
+     */
+    readonly formattedValue: FormattedValue;
+    readonly defaultAlign: "right" | "center" | "left";
+    /**
+     * Can the cell appear in an automatic sum zone.
+     */
+    readonly isAutoSummable: boolean;
+    readonly link?: Link;
+}
+export type CellValue = string | number | boolean | null;
+export type EvaluatedCell = NumberCell | TextCell | BooleanCell | EmptyCell | ErrorCell;
+export interface NumberCell extends EvaluatedCellProperties {
+    readonly type: CellValueType.number;
+    readonly value: number;
+}
+export interface TextCell extends EvaluatedCellProperties {
+    readonly type: CellValueType.text;
+    readonly value: string;
+}
+export interface BooleanCell extends EvaluatedCellProperties {
+    readonly type: CellValueType.boolean;
+    readonly value: boolean;
+}
+export interface EmptyCell extends EvaluatedCellProperties {
+    readonly type: CellValueType.empty;
+    readonly value: null;
+}
+export interface ErrorCell extends EvaluatedCellProperties {
+    readonly type: CellValueType.error;
+    readonly value: string;
+    readonly message?: string;
+}
+export declare enum CellValueType {
+    boolean = "boolean",
+    number = "number",
+    text = "text",
+    empty = "empty",
+    error = "error"
+}
+export {};

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

@@ -0,0 +1,12 @@
+import { ChartConfiguration } from "chart.js";
+import { Color } from "../misc";
+import { ComboBarChartDefinition } from "./common_bar_combo";
+export interface BarChartDefinition extends ComboBarChartDefinition {
+    readonly type: "bar";
+    readonly stacked: boolean;
+    readonly horizontal?: boolean;
+}
+export type BarChartRuntime = {
+    chartJsConfig: ChartConfiguration;
+    background: Color;
+};

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

@@ -0,0 +1,114 @@
+import { Align, Color, Range } from "../../types";
+import { XlsxHexColor } from "../xlsx";
+import { BarChartDefinition, BarChartRuntime } from "./bar_chart";
+import { ComboChartDefinition, ComboChartRuntime } from "./combo_chart";
+import { LegendPosition } from "./common_chart";
+import { GaugeChartDefinition, GaugeChartRuntime } from "./gauge_chart";
+import { LineChartDefinition, LineChartRuntime } from "./line_chart";
+import { PieChartDefinition, PieChartRuntime } from "./pie_chart";
+import { PyramidChartDefinition, PyramidChartRuntime } from "./pyramid_chart";
+import { ScatterChartDefinition, ScatterChartRuntime } from "./scatter_chart";
+import { ScorecardChartDefinition, ScorecardChartRuntime } from "./scorecard_chart";
+import { WaterfallChartDefinition, WaterfallChartRuntime } from "./waterfall_chart";
+export declare const CHART_TYPES: readonly ["line", "bar", "pie", "scorecard", "gauge", "scatter", "combo", "waterfall", "pyramid"];
+export type ChartType = (typeof CHART_TYPES)[number];
+export type ChartDefinition = LineChartDefinition | PieChartDefinition | BarChartDefinition | ScorecardChartDefinition | GaugeChartDefinition | ScatterChartDefinition | ComboChartDefinition | WaterfallChartDefinition | PyramidChartDefinition;
+export type ChartWithAxisDefinition = Extract<ChartDefinition, {
+    dataSets: CustomizedDataSet[];
+    labelRange?: string;
+}>;
+export type ChartJSRuntime = LineChartRuntime | PieChartRuntime | BarChartRuntime | ComboChartRuntime | ScatterChartRuntime | WaterfallChartRuntime | PyramidChartRuntime;
+export type ChartRuntime = ChartJSRuntime | ScorecardChartRuntime | GaugeChartRuntime;
+export interface LabelValues {
+    readonly values: string[];
+    readonly formattedValues: string[];
+}
+export interface DatasetValues {
+    readonly label?: string;
+    readonly data: any[];
+    readonly hidden?: boolean;
+}
+export interface DatasetDesign {
+    readonly backgroundColor?: string;
+    readonly yAxisId?: string;
+    readonly label?: string;
+}
+export interface AxisDesign {
+    readonly title?: TitleDesign;
+}
+export interface AxesDesign {
+    readonly x?: AxisDesign;
+    readonly y?: AxisDesign;
+    readonly y1?: AxisDesign;
+}
+export interface TitleDesign {
+    readonly text?: string;
+    readonly bold?: boolean;
+    readonly italic?: boolean;
+    readonly align?: Align;
+    readonly color?: Color;
+}
+export type TrendType = "polynomial" | "exponential" | "logarithmic";
+export interface TrendConfiguration {
+    type?: TrendType;
+    order?: number;
+    color?: Color;
+    display?: boolean;
+}
+export type CustomizedDataSet = {
+    readonly dataRange: string;
+    readonly trend?: TrendConfiguration;
+} & DatasetDesign;
+export type AxisType = "category" | "linear" | "time";
+export interface DataSet {
+    readonly labelCell?: Range;
+    readonly dataRange: Range;
+    readonly rightYAxis?: boolean;
+    readonly backgroundColor?: Color;
+    readonly customLabel?: string;
+}
+export interface ExcelChartDataset {
+    readonly label?: {
+        text?: string;
+    } | {
+        reference?: string;
+    };
+    readonly range: string;
+    readonly backgroundColor?: Color;
+    readonly rightYAxis?: boolean;
+}
+export type ExcelChartType = "line" | "bar" | "pie" | "combo" | "scatter";
+export interface ExcelChartDefinition {
+    readonly title?: TitleDesign;
+    readonly type: ExcelChartType;
+    readonly dataSets: ExcelChartDataset[];
+    readonly labelRange?: string;
+    readonly backgroundColor: XlsxHexColor;
+    readonly fontColor: XlsxHexColor;
+    readonly legendPosition: LegendPosition;
+    readonly stacked?: boolean;
+    readonly cumulative?: boolean;
+    readonly verticalAxis?: {
+        useLeftAxis?: boolean;
+        useRightAxis?: boolean;
+    };
+    readonly axesDesign?: AxesDesign;
+}
+export interface ChartCreationContext {
+    readonly range?: CustomizedDataSet[];
+    readonly title?: TitleDesign;
+    readonly background?: string;
+    readonly auxiliaryRange?: string;
+    readonly aggregated?: boolean;
+    readonly stacked?: boolean;
+    readonly cumulative?: boolean;
+    readonly dataSetsHaveTitle?: boolean;
+    readonly labelsAsText?: boolean;
+    readonly showSubTotals?: boolean;
+    readonly showConnectorLines?: boolean;
+    readonly firstValueAsSubtotal?: boolean;
+    readonly legendPosition?: LegendPosition;
+    readonly axesDesign?: AxesDesign;
+    readonly fillArea?: boolean;
+    readonly showValues?: boolean;
+}

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

@@ -0,0 +1,15 @@
+import { ChartConfiguration } from "chart.js";
+import { Color } from "../misc";
+import { CustomizedDataSet } from "./chart";
+import { ComboBarChartDefinition } from "./common_bar_combo";
+export interface ComboChartDefinition extends ComboBarChartDefinition {
+    readonly dataSets: ComboChartDataSet[];
+    readonly type: "combo";
+}
+export type ComboChartDataSet = CustomizedDataSet & {
+    type?: "bar" | "line";
+};
+export type ComboChartRuntime = {
+    chartJsConfig: ChartConfiguration;
+    background: Color;
+};

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

@@ -0,0 +1,14 @@
+import { Color } from "../misc";
+import { AxesDesign, CustomizedDataSet, TitleDesign } from "./chart";
+import { LegendPosition } from "./common_chart";
+export interface ComboBarChartDefinition {
+    readonly dataSets: CustomizedDataSet[];
+    readonly dataSetsHaveTitle: boolean;
+    readonly labelRange?: string;
+    readonly title: TitleDesign;
+    readonly background?: Color;
+    readonly legendPosition: LegendPosition;
+    readonly aggregated?: boolean;
+    readonly axesDesign?: AxesDesign;
+    readonly showValues?: boolean;
+}

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

@@ -0,0 +1,2 @@
+export type VerticalAxisPosition = "left" | "right";
+export type LegendPosition = "top" | "bottom" | "left" | "right" | "none";

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

@@ -0,0 +1,83 @@
+import type { ChartOptions } from "chart.js";
+import { Color } from "../misc";
+import { TitleDesign } from "./chart";
+export interface GaugeChartDefinition {
+    readonly type: "gauge";
+    readonly title: TitleDesign;
+    readonly dataRange?: string;
+    readonly sectionRule: SectionRule;
+    readonly background?: Color;
+}
+export interface SectionRule {
+    readonly colors: ColorSet;
+    readonly rangeMin: string;
+    readonly rangeMax: string;
+    readonly lowerInflectionPoint: SectionThreshold;
+    readonly upperInflectionPoint: SectionThreshold;
+}
+interface ColorSet {
+    readonly lowerColor: Color;
+    readonly middleColor: Color;
+    readonly upperColor: Color;
+}
+export interface SectionThreshold {
+    readonly type: "number" | "percentage";
+    readonly value: string;
+    readonly operator: "<" | "<=";
+}
+export interface GaugeValue {
+    value: number;
+    label: string;
+}
+export interface GaugeInflectionValue extends GaugeValue {
+    operator: "<" | "<=";
+}
+export interface GaugeChartRuntime {
+    background: Color;
+    title: TitleDesign;
+    minValue: GaugeValue;
+    maxValue: GaugeValue;
+    gaugeValue?: GaugeValue;
+    inflectionValues: GaugeInflectionValue[];
+    colors: Color[];
+}
+export interface GaugeChartOptions extends ChartOptions {
+    needle?: NeedleOptions;
+    valueLabel?: ValueLabelOptions;
+    inflectionValues: InflectionValuesOptions[];
+    minValue: string;
+    maxValue: string;
+}
+export interface NeedleOptions {
+    display?: boolean;
+    borderColor?: Color;
+    backgroundColor?: Color;
+    /**
+     * Needle width as the percentage of the chart area width
+     */
+    width?: number;
+}
+export interface InflectionValuesOptions {
+    value: number;
+    color: Color;
+    label: string;
+}
+export interface ValueLabelOptions {
+    display?: boolean;
+    formatter?: (value: any) => string;
+    font?: {
+        size?: number;
+        family?: string;
+        color?: Color;
+    };
+    backgroundColor?: Color;
+    borderColor?: Color;
+    borderRadius?: number;
+    padding?: {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
+}
+export {};

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

@@ -0,0 +1,7 @@
+export type * from "./bar_chart";
+export * from "./chart";
+export type * from "./common_chart";
+export type * from "./gauge_chart";
+export type * from "./line_chart";
+export type * from "./pie_chart";
+export type * from "./scorecard_chart";

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

@@ -0,0 +1,24 @@
+import type { ChartConfiguration } from "chart.js";
+import { Color } from "../misc";
+import { AxesDesign, CustomizedDataSet, TitleDesign } from "./chart";
+import { LegendPosition } from "./common_chart";
+export interface LineChartDefinition {
+    readonly type: "line";
+    readonly dataSets: CustomizedDataSet[];
+    readonly dataSetsHaveTitle: boolean;
+    readonly labelRange?: string;
+    readonly title: TitleDesign;
+    readonly background?: Color;
+    readonly legendPosition: LegendPosition;
+    readonly labelsAsText: boolean;
+    readonly stacked: boolean;
+    readonly aggregated?: boolean;
+    readonly cumulative: boolean;
+    readonly axesDesign?: AxesDesign;
+    readonly fillArea?: boolean;
+    readonly showValues?: boolean;
+}
+export type LineChartRuntime = {
+    chartJsConfig: ChartConfiguration;
+    background: Color;
+};

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

@@ -0,0 +1,21 @@
+import type { ChartConfiguration } from "chart.js";
+import { Color } from "../misc";
+import { AxesDesign, CustomizedDataSet, TitleDesign } from "./chart";
+import { LegendPosition } from "./common_chart";
+export interface PieChartDefinition {
+    readonly type: "pie";
+    readonly dataSets: CustomizedDataSet[];
+    readonly dataSetsHaveTitle: boolean;
+    readonly labelRange?: string;
+    readonly title: TitleDesign;
+    readonly background?: Color;
+    readonly legendPosition: LegendPosition;
+    readonly aggregated?: boolean;
+    readonly axesDesign?: AxesDesign;
+    readonly isDoughnut?: boolean;
+    readonly showValues?: boolean;
+}
+export type PieChartRuntime = {
+    chartJsConfig: ChartConfiguration;
+    background: Color;
+};

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

@@ -0,0 +1,10 @@
+import { ChartConfiguration } from "chart.js";
+import { Color } from "../misc";
+import { BarChartDefinition } from "./bar_chart";
+export interface PyramidChartDefinition extends Omit<BarChartDefinition, "type"> {
+    readonly type: "pyramid";
+}
+export type PyramidChartRuntime = {
+    chartJsConfig: ChartConfiguration;
+    background: Color;
+};

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

@@ -0,0 +1,5 @@
+import { LineChartDefinition, LineChartRuntime } from "./line_chart";
+export interface ScatterChartDefinition extends Omit<LineChartDefinition, "type" | "stacked" | "cumulative"> {
+    readonly type: "scatter";
+}
+export type ScatterChartRuntime = LineChartRuntime;

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

@@ -0,0 +1,33 @@
+import { Color, Style } from "../misc";
+import { TitleDesign } from "./chart";
+export interface ScorecardChartDefinition {
+    readonly type: "scorecard";
+    readonly title: TitleDesign;
+    readonly keyValue?: string;
+    readonly baseline?: string;
+    readonly baselineMode: BaselineMode;
+    readonly baselineDescr?: string;
+    readonly background?: Color;
+    readonly baselineColorUp: Color;
+    readonly baselineColorDown: Color;
+    readonly humanize?: boolean;
+}
+export type BaselineMode = "text" | "difference" | "percentage" | "progress";
+export type BaselineArrowDirection = "neutral" | "up" | "down";
+export interface ProgressBar {
+    readonly value: number;
+    readonly color: Color;
+}
+export interface ScorecardChartRuntime {
+    readonly title: TitleDesign;
+    readonly keyValue: string;
+    readonly baselineDisplay: string;
+    readonly baselineColor?: string;
+    readonly baselineArrow: BaselineArrowDirection;
+    readonly baselineDescr?: string;
+    readonly background: Color;
+    readonly fontColor: Color;
+    readonly keyValueStyle?: Style;
+    readonly baselineStyle?: Style;
+    readonly progressBar?: ProgressBar;
+}

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

@@ -0,0 +1,27 @@
+import type { ChartConfiguration } from "chart.js";
+import { Color } from "../misc";
+import { AxesDesign, CustomizedDataSet, TitleDesign } from "./chart";
+import { LegendPosition, VerticalAxisPosition } from "./common_chart";
+export interface WaterfallChartDefinition {
+    readonly type: "waterfall";
+    readonly dataSets: CustomizedDataSet[];
+    readonly dataSetsHaveTitle: boolean;
+    readonly labelRange?: string;
+    readonly title: TitleDesign;
+    readonly background?: Color;
+    readonly verticalAxisPosition: VerticalAxisPosition;
+    readonly legendPosition: LegendPosition;
+    readonly aggregated?: boolean;
+    readonly showSubTotals: boolean;
+    readonly showConnectorLines: boolean;
+    readonly firstValueAsSubtotal?: boolean;
+    readonly positiveValuesColor?: Color;
+    readonly negativeValuesColor?: Color;
+    readonly subTotalValuesColor?: Color;
+    readonly axesDesign?: AxesDesign;
+    readonly showValues?: boolean;
+}
+export type WaterfallChartRuntime = {
+    chartJsConfig: ChartConfiguration;
+    background: Color;
+};