@odoo/o-spreadsheet 19.2.12 → 19.3.3

package/dist/types/helpers/figures/charts/runtime/chart_data_extractor.d.ts

@@ -0,0 +1,22 @@
+import { Point } from "chart.js";
+import { Format, FunctionResultObject, GenericDefinition, Getters, Locale } from "../../../../types";
+import { AxisType, BarChartDefinition, ChartData, ChartRuntimeGenerationArgs, DatasetValues, FunnelChartDefinition, LabelValues, LineChartDefinition, PieChartDefinition, PyramidChartDefinition, SunburstChartDefinition, TrendConfiguration } from "../../../../types/chart";
+import { CalendarChartDefinition } from "../../../../types/chart/calendar_chart";
+import { GeoChartDefinition, GeoChartRuntimeGenerationArgs } from "../../../../types/chart/geo_chart";
+import { RadarChartDefinition } from "../../../../types/chart/radar_chart";
+import { TreeMapChartDefinition } from "../../../../types/chart/tree_map_chart";
+export declare function getBarChartData(definition: GenericDefinition<BarChartDefinition>, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getCalendarChartData(definition: GenericDefinition<CalendarChartDefinition>, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getPyramidChartData(definition: PyramidChartDefinition, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getLineChartData(definition: GenericDefinition<LineChartDefinition>, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getPieChartData(definition: GenericDefinition<PieChartDefinition>, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getRadarChartData(definition: GenericDefinition<RadarChartDefinition>, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getGeoChartData(definition: GeoChartDefinition, { labelValues, dataSetsValues }: ChartData, getters: Getters): GeoChartRuntimeGenerationArgs;
+export declare function getFunnelChartData(definition: GenericDefinition<FunnelChartDefinition>, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getHierarchalChartData(definition: SunburstChartDefinition | TreeMapChartDefinition, { labelValues, dataSetsValues }: ChartData, getters: Getters): ChartRuntimeGenerationArgs;
+export declare function getTrendDatasetForBarChart(config: TrendConfiguration, data: FunctionResultObject[]): Point[] | undefined;
+export declare function getTrendDatasetForLineChart(config: TrendConfiguration, data: FunctionResultObject[], labels: string[], axisType: AxisType, locale: Locale): Point[] | undefined;
+export declare function canChartParseLabels(chartData: ChartData): boolean;
+export declare function getChartLabelFormat(labelValues: LabelValues): Format | undefined;
+export declare function makeDatasetsCumulative(datasets: DatasetValues[], order: "asc" | "desc"): DatasetValues[];
+export declare function getTopPaddingForDashboard(definition: GenericDefinition<PieChartDefinition | LineChartDefinition | BarChartDefinition>, getters: Getters): 0 | 30;

package/dist/types/helpers/figures/charts/runtime/chart_zoom.d.ts

@@ -0,0 +1,2 @@
+import { ChartConfiguration } from "chart.js";
+export declare function generateMasterChartConfig(chartJsConfig: ChartConfiguration<any>): ChartConfiguration<any>;

package/dist/types/helpers/figures/charts/runtime/chartjs_dataset.d.ts

@@ -0,0 +1,30 @@
+import { ChartDataset } from "chart.js";
+import { ChartRuntimeGenerationArgs, Color, GenericDefinition } from "../../../../types";
+import { BarChartDefinition, DataSetStyle, DatasetValues, FunnelChartColors, FunnelChartDefinition, LineChartDefinition, PieChartDefinition, ScatterChartDefinition, SunburstChartDefinition, SunburstChartJSDataset, WaterfallChartDefinition } from "../../../../types/chart";
+import { CalendarChartDefinition } from "../../../../types/chart/calendar_chart";
+import { ComboChartDefinition } from "../../../../types/chart/combo_chart";
+import { GeoChartDefinition, GeoChartRuntimeGenerationArgs } from "../../../../types/chart/geo_chart";
+import { RadarChartDefinition } from "../../../../types/chart/radar_chart";
+import { TreeMapChartDefinition } from "../../../../types/chart/tree_map_chart";
+import { ColorGenerator } from "../../../color";
+export declare const GHOST_SUNBURST_VALUE = "nullValue";
+export declare function getBarChartDatasets(definition: GenericDefinition<BarChartDefinition>, args: ChartRuntimeGenerationArgs): ChartDataset<"bar" | "line">[];
+export declare function getCalendarChartDatasetAndLabels(definition: CalendarChartDefinition, args: ChartRuntimeGenerationArgs): {
+    datasets: ChartDataset<"calendar">[];
+    labels: string[];
+};
+export declare function getWaterfallDatasetAndLabels(definition: GenericDefinition<WaterfallChartDefinition>, args: ChartRuntimeGenerationArgs): {
+    datasets: ChartDataset[];
+    labels: string[];
+};
+export declare function getLineChartDatasets(definition: GenericDefinition<LineChartDefinition>, args: ChartRuntimeGenerationArgs): ChartDataset<"line">[];
+export declare function getScatterChartDatasets(definition: GenericDefinition<ScatterChartDefinition>, args: ChartRuntimeGenerationArgs): ChartDataset<"line">[];
+export declare function getPieChartDatasets(definition: GenericDefinition<PieChartDefinition>, args: ChartRuntimeGenerationArgs): ChartDataset<"pie">[];
+export declare function getComboChartDatasets(definition: GenericDefinition<ComboChartDefinition>, args: ChartRuntimeGenerationArgs): ChartDataset<"bar" | "line">[];
+export declare function getRadarChartDatasets(definition: GenericDefinition<RadarChartDefinition>, args: ChartRuntimeGenerationArgs): ChartDataset<"radar">[];
+export declare function getGeoChartDatasets(definition: GenericDefinition<GeoChartDefinition>, args: GeoChartRuntimeGenerationArgs): ChartDataset[];
+export declare function getFunnelChartDatasets(definition: FunnelChartDefinition, args: ChartRuntimeGenerationArgs): ChartDataset<"bar">[];
+export declare function getFunnelLabelColors(labels: string[], colors?: FunnelChartColors): Color[];
+export declare function getSunburstChartDatasets(definition: GenericDefinition<SunburstChartDefinition>, args: ChartRuntimeGenerationArgs): SunburstChartJSDataset[];
+export declare function getTreeMapChartDatasets(definition: TreeMapChartDefinition, args: ChartRuntimeGenerationArgs): ChartDataset<"treemap">[];
+export declare function getChartColorsGenerator(dataSetStyles: DataSetStyle | undefined, dataSetValues: Pick<DatasetValues, "dataSetId">[]): ColorGenerator;

package/dist/types/helpers/figures/charts/runtime/chartjs_layout.d.ts

@@ -0,0 +1,6 @@
+import { ChartOptions } from "chart.js";
+import { ChartDefinitionWithDataSource, ChartRuntimeGenerationArgs, GenericDefinition } from "../../../../types/chart";
+type ChartLayout = ChartOptions["layout"];
+export declare function getChartLayout(definition: GenericDefinition<ChartDefinitionWithDataSource>, args: ChartRuntimeGenerationArgs): ChartLayout;
+export declare function getCalendarChartLayout(definition: GenericDefinition<ChartDefinitionWithDataSource>, args: ChartRuntimeGenerationArgs): ChartLayout;
+export {};

package/dist/types/helpers/figures/charts/runtime/chartjs_legend.d.ts

@@ -0,0 +1,20 @@
+import { LegendOptions } from "chart.js";
+import { DeepPartial } from "../../../../types";
+import { BarChartDefinition, ChartRuntimeGenerationArgs, GenericDefinition, LineChartDefinition, PieChartDefinition, SunburstChartDefinition, WaterfallChartDefinition } from "../../../../types/chart";
+import { ComboChartDefinition } from "../../../../types/chart/combo_chart";
+import { RadarChartDefinition } from "../../../../types/chart/radar_chart";
+type ChartLegend = DeepPartial<LegendOptions<any>>;
+export declare function getBarChartLegend(definition: GenericDefinition<BarChartDefinition>, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare function getLineChartLegend(definition: GenericDefinition<LineChartDefinition>, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare function getPieChartLegend(definition: GenericDefinition<PieChartDefinition>, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare function getScatterChartLegend(definition: GenericDefinition<LineChartDefinition>, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare function getComboChartLegend(definition: GenericDefinition<ComboChartDefinition>, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare function getWaterfallChartLegend(definition: WaterfallChartDefinition, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare function getRadarChartLegend(definition: GenericDefinition<RadarChartDefinition>, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare function getSunburstChartLegend(definition: SunburstChartDefinition, args: ChartRuntimeGenerationArgs): ChartLegend;
+export declare const INTERACTIVE_LEGEND_CONFIG: {
+    onHover: (event: any) => void;
+    onLeave: (event: any) => void;
+    onClick: (event: any, legendItem: any, legend: any) => void;
+};
+export {};

package/dist/types/helpers/figures/charts/runtime/chartjs_scales.d.ts

@@ -0,0 +1,21 @@
+import { ChartDataset, ScaleChartOptions } from "chart.js";
+import { ChartColorScalePluginOptions } from "../../../../components/figures/chart/chartJs/chartjs_colorscale_plugin";
+import { Color, DeepPartial } from "../../../../types";
+import { BarChartDefinition, ChartColorScale, ChartRuntimeGenerationArgs, FunnelChartDefinition, GenericDefinition, LineChartDefinition, PyramidChartDefinition, ScatterChartDefinition, WaterfallChartDefinition } from "../../../../types/chart";
+import { CalendarChartDefinition } from "../../../../types/chart/calendar_chart";
+import { GeoChartDefinition, GeoChartRuntimeGenerationArgs } from "../../../../types/chart/geo_chart";
+import { RadarChartDefinition } from "../../../../types/chart/radar_chart";
+type ChartScales = DeepPartial<ScaleChartOptions<"line" | "bar" | "radar">["scales"]>;
+type GeoChartScales = DeepPartial<ScaleChartOptions<"choropleth">["scales"]>;
+export declare function getBarChartScales(definition: GenericDefinition<BarChartDefinition>, args: ChartRuntimeGenerationArgs): DeepPartial<ScaleChartOptions<"line" | "bar">["scales"]>;
+export declare function getCalendarChartScales(definition: GenericDefinition<BarChartDefinition>, datasets: ChartDataset[]): DeepPartial<ScaleChartOptions<"calendar">["scales"]>;
+export declare function getCalendarColorScale(definition: CalendarChartDefinition, args: ChartRuntimeGenerationArgs): ChartColorScalePluginOptions | undefined;
+export declare function getLineChartScales(definition: GenericDefinition<LineChartDefinition>, args: ChartRuntimeGenerationArgs): DeepPartial<ScaleChartOptions<"line">["scales"]>;
+export declare function getScatterChartScales(definition: GenericDefinition<ScatterChartDefinition>, args: ChartRuntimeGenerationArgs): DeepPartial<ScaleChartOptions<"line">["scales"]>;
+export declare function getWaterfallChartScales(definition: WaterfallChartDefinition, args: ChartRuntimeGenerationArgs): ChartScales;
+export declare function getPyramidChartScales(definition: PyramidChartDefinition, args: ChartRuntimeGenerationArgs): ChartScales;
+export declare function getRadarChartScales(definition: GenericDefinition<RadarChartDefinition>, args: ChartRuntimeGenerationArgs): ChartScales;
+export declare function getGeoChartScales(definition: GeoChartDefinition, args: GeoChartRuntimeGenerationArgs): GeoChartScales;
+export declare function getFunnelChartScales(definition: FunnelChartDefinition, args: ChartRuntimeGenerationArgs): ChartScales;
+export declare function getRuntimeColorScale(colorScale: ChartColorScale, minValue?: number, maxValue?: number): (value: number) => Color;
+export {};

package/dist/types/helpers/figures/charts/runtime/chartjs_show_values.d.ts

@@ -0,0 +1,9 @@
+import { ChartShowValuesPluginOptions } from "../../../../components/figures/chart/chartJs/chartjs_show_values_plugin";
+import { ChartSunburstLabelsPluginOptions } from "../../../../components/figures/chart/chartJs/chartjs_sunburst_labels_plugin";
+import { ChartDefinitionWithDataSource, ChartRuntimeGenerationArgs, SunburstChartDefinition, WaterfallChartDefinition } from "../../../../types/chart";
+import { CalendarChartDefinition } from "../../../../types/chart/calendar_chart";
+export declare function getChartShowValues(definition: ChartDefinitionWithDataSource, args: ChartRuntimeGenerationArgs): ChartShowValuesPluginOptions;
+export declare function getCalendarChartShowValues(definition: CalendarChartDefinition, args: ChartRuntimeGenerationArgs): ChartShowValuesPluginOptions;
+export declare function getSunburstShowValues(definition: SunburstChartDefinition, args: ChartRuntimeGenerationArgs): ChartSunburstLabelsPluginOptions;
+export declare function getPyramidChartShowValues(definition: ChartDefinitionWithDataSource, args: ChartRuntimeGenerationArgs): ChartShowValuesPluginOptions;
+export declare function getWaterfallChartShowValues(definition: WaterfallChartDefinition, args: ChartRuntimeGenerationArgs): ChartShowValuesPluginOptions;

package/dist/types/helpers/figures/charts/runtime/chartjs_title.d.ts

@@ -0,0 +1,4 @@
+import { TitleOptions } from "chart.js";
+import { ChartDefinitionWithDataSource, DeepPartial } from "../../../../types";
+import { Getters } from "../../../../types/getters";
+export declare function getChartTitle(definition: ChartDefinitionWithDataSource, getters: Getters): DeepPartial<TitleOptions>;

package/dist/types/helpers/figures/charts/runtime/chartjs_tooltip.d.ts

@@ -0,0 +1,20 @@
+import { TooltipOptions } from "chart.js";
+import { DeepPartial } from "../../../../types";
+import { BarChartDefinition, ChartRuntimeGenerationArgs, GenericDefinition, LineChartDefinition, PieChartDefinition, PyramidChartDefinition, SunburstChartDefinition, WaterfallChartDefinition } from "../../../../types/chart";
+import { CalendarChartDefinition } from "../../../../types/chart/calendar_chart";
+import { GeoChartDefinition } from "../../../../types/chart/geo_chart";
+import { RadarChartDefinition } from "../../../../types/chart/radar_chart";
+import { TreeMapChartDefinition } from "../../../../types/chart/tree_map_chart";
+type ChartTooltip = DeepPartial<TooltipOptions<any>>;
+export declare function getBarChartTooltip(definition: GenericDefinition<BarChartDefinition>, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getCalendarChartTooltip(definition: CalendarChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getLineChartTooltip(definition: GenericDefinition<LineChartDefinition>, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getPieChartTooltip(definition: PieChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getWaterfallChartTooltip(definition: WaterfallChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getPyramidChartTooltip(definition: PyramidChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getRadarChartTooltip(definition: RadarChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getGeoChartTooltip(definition: GeoChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getFunnelChartTooltip(definition: GenericDefinition<BarChartDefinition>, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getSunburstChartTooltip(definition: SunburstChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export declare function getTreeMapChartTooltip(definition: TreeMapChartDefinition, args: ChartRuntimeGenerationArgs): ChartTooltip;
+export {};

package/dist/types/helpers/figures/charts/runtime/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./chart_data_extractor";
+export * from "./chartjs_dataset";
+export * from "./chartjs_layout";
+export * from "./chartjs_legend";
+export * from "./chartjs_scales";
+export * from "./chartjs_show_values";
+export * from "./chartjs_title";
+export * from "./chartjs_tooltip";

package/dist/types/helpers/figures/charts/scatter_chart.d.ts

@@ -0,0 +1,2 @@
+import { ChartTypeBuilder } from "../../../registries/chart_registry";
+export declare const ScatterChart: ChartTypeBuilder<"scatter">;

package/dist/types/helpers/figures/charts/scorecard_chart.d.ts

@@ -0,0 +1,4 @@
+import { ChartTypeBuilder } from "../../../registries/chart_registry";
+import { ScorecardChartConfig } from "./scorecard_chart_config_builder";
+export declare const ScorecardChart: ChartTypeBuilder<"scorecard">;
+export declare function drawScoreChart(structure: ScorecardChartConfig, canvas: HTMLCanvasElement | OffscreenCanvas, zoom?: number): void;

package/dist/types/helpers/figures/charts/scorecard_chart_config_builder.d.ts

@@ -0,0 +1,45 @@
+import { BaselineArrowDirection, ScorecardChartRuntime } from "../../../types/chart";
+import { Color, Pixel, PixelPosition } from "../../../types/misc";
+import { DOMDimension } from "../../../types/rendering";
+type ScorecardChartElement = {
+    text: string;
+    style: {
+        font: string;
+        color: Color;
+        strikethrough?: boolean;
+        underline?: boolean;
+    };
+    position: PixelPosition;
+};
+export type ScorecardChartConfig = {
+    canvas: {
+        width: number;
+        height: number;
+        backgroundColor: Color;
+    };
+    title?: ScorecardChartElement;
+    baselineArrow?: {
+        direction: BaselineArrowDirection;
+        style: {
+            size: Pixel;
+            color: Color;
+        };
+        position: PixelPosition;
+    };
+    baseline?: ScorecardChartElement;
+    baselineDescr?: ScorecardChartElement;
+    key?: ScorecardChartElement;
+    keyDescr?: ScorecardChartElement;
+    progressBar?: {
+        position: PixelPosition;
+        dimension: DOMDimension;
+        style: {
+            color: Color;
+            backgroundColor: Color;
+        };
+        value: number;
+    };
+};
+export declare function formatBaselineDescr(baselineDescr: string | undefined, baseline: string | undefined): string;
+export declare function getScorecardConfiguration({ width, height }: DOMDimension, runtime: ScorecardChartRuntime): ScorecardChartConfig;
+export {};

package/dist/types/helpers/figures/charts/smart_chart_engine.d.ts

@@ -0,0 +1,5 @@
+import { ChartDefinition, Getters, Zone } from "../../../types";
+/**
+ * Analyzes selected zones and intelligently determines the most suitable chart.
+ */
+export declare function getSmartChartDefinition(zones: Zone[], getters: Getters): ChartDefinition;

package/dist/types/helpers/figures/charts/sunburst_chart.d.ts

@@ -0,0 +1,2 @@
+import { ChartTypeBuilder } from "../../../registries/chart_registry";
+export declare const SunburstChart: ChartTypeBuilder<"sunburst">;

package/dist/types/helpers/figures/charts/tree_map_chart.d.ts

@@ -0,0 +1,2 @@
+import { ChartTypeBuilder } from "../../../registries/chart_registry";
+export declare const TreeMapChart: ChartTypeBuilder<"treemap">;

package/dist/types/helpers/figures/charts/waterfall_chart.d.ts

@@ -0,0 +1,2 @@
+import { ChartTypeBuilder } from "../../../registries/chart_registry";
+export declare const WaterfallChart: ChartTypeBuilder<"waterfall">;

package/dist/types/helpers/figures/figure/figure.d.ts

@@ -0,0 +1,4 @@
+import { AnchorOffset, FigureSize } from "../../../types/figure";
+import { Getters } from "../../../types/getters";
+export declare function centerFigurePosition(getters: Getters, size: FigureSize): AnchorOffset;
+export declare function getMaxFigureSize(getters: Getters, figureSize: FigureSize): FigureSize;

package/dist/types/helpers/figures/images/image_provider.d.ts

@@ -0,0 +1,11 @@
+import { FigureSize } from "../../../types";
+import { FileStore, ImageProviderInterface } from "../../../types/files";
+import { type Image } from "../../../types/image";
+export declare class ImageProvider implements ImageProviderInterface {
+    private fileStore;
+    constructor(fileStore: FileStore);
+    requestImage(): Promise<Image>;
+    uploadFile(file: File): Promise<Image>;
+    private userImageUpload;
+    getImageOriginalSize(path: string): Promise<FigureSize>;
+}

package/dist/types/helpers/format/format.d.ts

@@ -0,0 +1,53 @@
+import { CellValue } from "../../types/cells";
+import { Currency } from "../../types/currency";
+import { Format, FormattedValue, LocaleFormat } from "../../types/format";
+import { Locale } from "../../types/locale";
+import { FunctionResultObject, Maybe } from "../../types/misc";
+export declare const MONTHS: Readonly<Record<number, string>>;
+export declare const DAYS: Readonly<Record<number, string>>;
+interface FormatWidth {
+    availableWidth: number;
+    measureText: (text: string) => number;
+}
+export declare function formatOrHumanizeValue(value: CellValue, format: Format | undefined, locale: Locale, humanize?: boolean): FormattedValue;
+/**
+ * Formats a cell value with its format.
+ */
+export declare function formatValue(value: CellValue, { format, locale, formatWidth }: LocaleFormat & {
+    formatWidth?: FormatWidth;
+}): FormattedValue;
+/** Convert a number into a string, without scientific notation */
+export declare function numberToString(number: number, decimalSeparator: string): string;
+/**
+ * Check if the given format is a time, date or date time format. Only check the first part of a multi-part format.
+ */
+export declare const isDateTimeFormat: (format: Format) => boolean;
+/**
+ * Get a regex matching decimal number based on the locale's thousand separator
+ *
+ * eg. if the locale's thousand separator is a comma, this will return a regex /[0-9]+,[0-9]/
+ */
+export declare const getDecimalNumberRegex: (locale: Locale) => RegExp;
+/**
+ * Create a default format for a number.
+ *
+ * If possible this will try round the number to have less than DEFAULT_FORMAT_NUMBER_OF_DIGITS characters
+ * in the number. This is obviously only possible for number with a big decimal part. For number with a lot
+ * of digits in the integer part, keep the number as it is.
+ */
+export declare function createDefaultFormat(value: number): Format;
+export declare function detectDateFormat(content: string, locale: Locale): Format | undefined;
+/** use this function only if the content corresponds to a number (means that isNumber(content) return true */
+export declare function detectNumberFormat(content: string): Format | undefined;
+export declare function createCurrencyFormat(currency: Partial<Currency>): Format;
+export declare function createAccountingFormat(currency: Partial<Currency>): Format;
+export declare function roundFormat(format: Format): Format;
+export declare function humanizeNumber({ value, format }: FunctionResultObject, locale: Locale): string;
+export declare function formatLargeNumber(arg: Maybe<FunctionResultObject>, unit: Maybe<FunctionResultObject>, locale: Locale): string;
+export declare function changeDecimalPlaces(format: Format, step: number): Format;
+export declare function isExcelCompatible(format: Format): boolean;
+export declare function isTextFormat(format: Format | undefined): boolean;
+export declare function formatHasRepeatedChar(value: CellValue, format: Format | undefined): boolean;
+export declare function isFormatValid(format: Format): boolean;
+export declare function getNumberOfFormatParts(format: Format): number;
+export {};

package/dist/types/helpers/format/format_parser.d.ts

@@ -0,0 +1,39 @@
+import { Format } from "../../types/format";
+import { CharToken, DatePartToken, DigitToken, PercentToken, RepeatCharToken, ScientificToken, StringToken, TextPlaceholderToken, ThousandsSeparatorToken } from "./format_tokenizer";
+/**
+ *  Constant used to indicate the maximum of digits that is possible to display
+ *  in a cell with standard size.
+ */
+export declare const MAX_DECIMAL_PLACES = 20;
+export interface MultiPartInternalFormat {
+    positive: NumberInternalFormat | DateInternalFormat | TextInternalFormat;
+    negative?: NumberInternalFormat | DateInternalFormat;
+    zero?: NumberInternalFormat | DateInternalFormat;
+    text?: TextInternalFormat;
+}
+export interface DateInternalFormat {
+    type: "date";
+    tokens: (DatePartToken | StringToken | CharToken | RepeatCharToken)[];
+}
+export interface NumberInternalFormat {
+    type: "number";
+    readonly integerPart: (DigitToken | StringToken | CharToken | PercentToken | ScientificToken | ThousandsSeparatorToken | RepeatCharToken)[];
+    readonly percentSymbols: number;
+    readonly thousandsSeparator: boolean;
+    readonly scientific: boolean;
+    /** A thousand separator after the last digit in the format means that we divide the number by a thousand */
+    readonly magnitude: number;
+    /**
+     * optional because we need to differentiate a number
+     * with a dot but no decimals with a number without any decimals.
+     * i.e. '5.'  !=== '5' !=== '5.0'
+     */
+    readonly decimalPart?: (DigitToken | StringToken | CharToken | PercentToken | ScientificToken | ThousandsSeparatorToken | RepeatCharToken)[];
+}
+export interface TextInternalFormat {
+    type: "text";
+    tokens: (StringToken | CharToken | TextPlaceholderToken | RepeatCharToken)[];
+}
+export type InternalFormat = NumberInternalFormat | DateInternalFormat | TextInternalFormat;
+export declare function parseFormat(formatString: Format): MultiPartInternalFormat;
+export declare function convertInternalFormatToFormat(internalFormat: MultiPartInternalFormat): Format;

package/dist/types/helpers/format/format_tokenizer.d.ts

@@ -0,0 +1,43 @@
+export interface DigitToken {
+    type: "DIGIT";
+    value: "0" | "#";
+}
+export interface DecimalPointToken {
+    type: "DECIMAL_POINT";
+    value: ".";
+}
+export interface StringToken {
+    type: "STRING";
+    value: string;
+}
+export interface CharToken {
+    type: "CHAR";
+    value: string;
+}
+export interface PercentToken {
+    type: "PERCENT";
+    value: "%";
+}
+export interface ScientificToken {
+    type: "SCIENTIFIC";
+    value: "e";
+}
+export interface ThousandsSeparatorToken {
+    type: "THOUSANDS_SEPARATOR";
+    value: ",";
+}
+export interface TextPlaceholderToken {
+    type: "TEXT_PLACEHOLDER";
+    value: "@";
+}
+export interface DatePartToken {
+    type: "DATE_PART";
+    value: string;
+}
+export interface RepeatCharToken {
+    type: "REPEATED_CHAR";
+    value: string;
+}
+export type FormatToken = DigitToken | DecimalPointToken | StringToken | CharToken | PercentToken | ScientificToken | ThousandsSeparatorToken | TextPlaceholderToken | DatePartToken | RepeatCharToken;
+export declare function tokenizeFormat(str: string): FormatToken[][];
+export declare const alwaysEscapedCharsInFormat: Set<string>;

package/dist/types/helpers/formulas.d.ts

@@ -0,0 +1,5 @@
+import { Token } from "../formulas/tokenizer";
+import { ApplyRangeChangeResult, ApplyRenameNamedRange, RangeAdapter, UID } from "../types/misc";
+export declare function adaptFormulaString(defaultSheetId: string, formula: string, applyChange: RangeAdapter, namedRangeAdapter: ApplyRenameNamedRange): string;
+export declare function canBeNamedRangeToken(tokens: Token[], tokenIndex: number): boolean;
+export declare function adaptStringRange(defaultSheetId: UID, sheetXC: string, rangeAdapter: RangeAdapter): ApplyRangeChangeResult<string>;

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

@@ -0,0 +1,18 @@
+export * from "./color";
+export * from "./coordinates";
+export * from "./criterion_helpers";
+export * from "./data_normalization";
+export * from "./dates";
+export * from "./edge_scrolling";
+export * from "./format/format";
+export * from "./misc";
+export * from "./numbers";
+export * from "./range";
+export * from "./recompute_zones";
+export * from "./references";
+export * from "./search";
+export * from "./sheet";
+export * from "./state_manager_helpers";
+export * from "./text_helper";
+export * from "./uuid";
+export * from "./zones";

package/dist/types/helpers/internal_viewport.d.ts

@@ -0,0 +1,86 @@
+import { RenderingGetters } from "../types/getters";
+import { HeaderIndex, Pixel, Position, UID, Zone } from "../types/misc";
+import { DOMCoordinates, DOMDimension, Rect } from "../types/rendering";
+export declare class InternalViewport {
+    private getters;
+    private sheetId;
+    private boundaries;
+    top: HeaderIndex;
+    bottom: HeaderIndex;
+    left: HeaderIndex;
+    right: HeaderIndex;
+    offsetX: Pixel;
+    offsetY: Pixel;
+    canScrollVertically: boolean;
+    canScrollHorizontally: boolean;
+    viewportWidth: Pixel;
+    viewportHeight: Pixel;
+    offsetCorrectionX: Pixel;
+    offsetCorrectionY: Pixel;
+    constructor(getters: RenderingGetters, sheetId: UID, boundaries: Zone, sizeInGrid: DOMDimension, options: {
+        canScrollVertically: boolean;
+        canScrollHorizontally: boolean;
+    }, offsets: DOMCoordinates);
+    /** Returns the maximum size (in Pixels) of the viewport relative to its allocated client size
+     * When the viewport grid size is smaller than its client width (resp. height), it will return
+     * the client width (resp. height).
+     */
+    getMaxSize(): DOMDimension;
+    /**
+     * Return the index of a column given an offset x, based on the pane left
+     * visible cell.
+     * It returns -1 if no column is found.
+     */
+    getColIndex(x: Pixel): HeaderIndex;
+    /**
+     * Return the index of a row given an offset y, based on the pane top
+     * visible cell.
+     * It returns -1 if no row is found.
+     */
+    getRowIndex(y: Pixel): HeaderIndex;
+    /**
+     * This function will make sure that the provided cell position (or current selected position) is part of
+     * the pane that is actually displayed on the client. We therefore adjust the offset of the pane
+     * until it contains the cell completely.
+     */
+    adjustPosition(position: Position): void;
+    private adjustPositionX;
+    private adjustPositionY;
+    willNewOffsetScrollViewport(offsetX: Pixel, offsetY: Pixel): boolean;
+    setViewportOffset(offsetX: Pixel, offsetY: Pixel): void;
+    adjustViewportZone(): void;
+    /**
+     *
+     * Computes the visible coordinates & dimensions of a given zone inside the viewport
+     *
+     */
+    getVisibleRect(zone: Zone): Rect | undefined;
+    /**
+     *
+     * @returns Computes the absolute coordinates & dimensions of a given zone inside the viewport
+     *
+     */
+    getFullRect(zone: Zone): Rect | undefined;
+    isVisible(col: HeaderIndex, row: HeaderIndex): boolean;
+    private searchHeaderIndex;
+    private setViewportOffsetX;
+    private setViewportOffsetY;
+    /** Corrects the viewport's horizontal offset based on the current structure
+     *  To make sure that at least one column is visible inside the viewport.
+     */
+    private adjustViewportOffsetX;
+    /** Corrects the viewport's vertical offset based on the current structure
+     *  To make sure that at least one row is visible inside the viewport.
+     */
+    private adjustViewportOffsetY;
+    /** Updates the pane zone and snapped offset based on its horizontal
+     * offset (will find Left) and its width (will find Right) */
+    private adjustViewportZoneX;
+    /** Updates the pane zone and snapped offset based on its vertical
+     * offset (will find Top) and its width (will find Bottom) */
+    private adjustViewportZoneY;
+    /** represents the part of the header on the topLeft that could be partially
+     * hidden due to the scroll
+     * */
+    private get snapCorrection();
+}

package/dist/types/helpers/inverse_command.d.ts

@@ -0,0 +1,2 @@
+import { CoreCommand } from "../types/commands";
+export declare function inverseCommand(cmd: CoreCommand): CoreCommand[];

package/dist/types/helpers/links.d.ts

@@ -0,0 +1,31 @@
+import { Registry } from "../registries/registry";
+import { CellValue } from "../types/cells";
+import { CoreGetters } from "../types/core_getters";
+import { Link } from "../types/misc";
+import { SpreadsheetChildEnv } from "../types/spreadsheet_env";
+/**
+ * Add the `https` prefix to the url if it's missing
+ */
+export declare function withHttps(url: string): string;
+export interface LinkSpec {
+    readonly match: (url: string) => boolean;
+    readonly createLink: (url: string, label: string) => Link;
+    /**
+     * String used to display the URL in components.
+     * Particularly useful for special links (sheet, etc.)
+     * - a simple web link displays the raw url
+     * - a link to a sheet displays the sheet name
+     */
+    readonly urlRepresentation: (url: string, getters: CoreGetters) => string;
+    readonly open: (url: string, env: SpreadsheetChildEnv, isMiddleClick?: boolean) => void;
+    readonly sequence: number;
+    readonly title: string;
+    readonly icon?: string;
+    readonly getLinkProposals?: (env: SpreadsheetChildEnv) => (Link & {
+        icon: string;
+    })[];
+}
+export declare const urlRegistry: Registry<LinkSpec>;
+export declare function urlRepresentation(link: Link, getters: CoreGetters): string;
+export declare function openLink(link: Link, env: SpreadsheetChildEnv, isMiddleClick?: boolean): void;
+export declare function detectLink(value: CellValue | null): Link | undefined;

package/dist/types/helpers/locale.d.ts

@@ -0,0 +1,60 @@
+import { ConditionalFormatRule } from "../types/conditional_formatting";
+import { DataValidationRule } from "../types/data_validation";
+import { Locale } from "../types/locale";
+export declare function isValidLocale(locale: any): locale is Locale;
+/**
+ * Change a content string from the given locale to its canonical form (en_US locale). Don't convert date string.
+ *
+ * @example
+ * canonicalizeNumberContent("=SUM(1,5; 02/12/2012)", FR_LOCALE) // "=SUM(1.5, 02/12/2012)"
+ * canonicalizeNumberContent("125,9", FR_LOCALE) // "125.9"
+ * canonicalizeNumberContent("02/12/2012", FR_LOCALE) // "02/12/2012"
+ */
+export declare function canonicalizeNumberContent(content: string, locale: Locale): string;
+/**
+ * Change a content string from the given locale to its canonical form (en_US locale). Also convert date string.
+ * This is destructive and won't preserve the original format.
+ *
+ * @example
+ * canonicalizeContent("=SUM(1,5; 5)", FR_LOCALE) // "=SUM(1.5, 5)"
+ * canonicalizeContent("125,9", FR_LOCALE) // "125.9"
+ * canonicalizeContent("02/12/2012", FR_LOCALE) // "12/02/2012"
+ * canonicalizeContent("02-12-2012", FR_LOCALE) // "12/02/2012"
+ */
+export declare function canonicalizeContent(content: string, locale: Locale): string;
+/**
+ * Change a content string from its canonical form (en_US locale) to the given locale. Don't convert date string.
+ * This is destructive and won't preserve the original format.
+ *
+ * @example
+ * localizeNumberContent("=SUM(1.5, 5)", FR_LOCALE) // "=SUM(1,5; 5)"
+ * localizeNumberContent("125.9", FR_LOCALE) // "125,9"
+ * localizeNumberContent("02/12/2012", FR_LOCALE) // "12/02/2012"
+ * localizeNumberContent("02-12-2012", FR_LOCALE) // "12/02/2012"
+ */
+export declare function localizeNumberContent(content: string, locale: Locale): string;
+/**
+ * Change a content string from its canonical form (en_US locale) to the given locale. Also convert date string.
+ *
+ * @example
+ * localizeContent("=SUM(1.5, 5)", FR_LOCALE) // "=SUM(1,5; 5)"
+ * localizeContent("125.9", FR_LOCALE) // "125,9"
+ * localizeContent("12/02/2012", FR_LOCALE) // "02/12/2012"
+ */
+export declare function localizeContent(content: string, locale: Locale): string;
+/** Change a number string to its canonical form (en_US locale) */
+export declare function canonicalizeNumberValue(content: string, locale: Locale): string;
+/** Change a formula from the canonical form to the given locale */
+export declare function localizeFormula(formula: string, locale: Locale): string;
+/**
+ * Change a literal string from the given locale to its canonical form (en_US locale). Don't convert date string.
+ *
+ * @example
+ * canonicalizeNumberLiteral("125,9", FR_LOCALE) // "125.9"
+ * canonicalizeNumberLiteral("02/12/2012", FR_LOCALE) // "02/12/2012"
+ */
+export declare function canonicalizeNumberLiteral(content: string, locale: Locale): string;
+export declare function canonicalizeCFRule(cf: ConditionalFormatRule, locale: Locale): ConditionalFormatRule;
+export declare function localizeCFRule(cf: ConditionalFormatRule, locale: Locale): ConditionalFormatRule;
+export declare function localizeDataValidationRule(rule: DataValidationRule, locale: Locale): DataValidationRule;
+export declare function getDateTimeFormat(locale: Locale): string;

package/dist/types/helpers/matrix.d.ts

@@ -0,0 +1,3 @@
+import { Locale } from "../types/locale";
+import { FunctionResultObject, Matrix } from "../types/misc";
+export declare function evaluationResultToDisplayString(result: Matrix<FunctionResultObject> | FunctionResultObject, emptyCell: string, locale: Locale): string;