@odoo/o-spreadsheet 17.0.85 → 17.0.97

package/dist/types/types/xlsx.d.ts

@@ -0,0 +1,441 @@
+import { Alias, ExcelChartDefinition, Format, PaneDivision } from ".";
+import { ExcelImage } from "../types/image";
+/**
+ * Most of the times we tried to create Objects that matched quite closely with the data in the XLSX files.
+ * The most notable exceptions are graphs and charts, as their definition are complex and we won't use most of it.
+ *
+ * Used the specification of the OpenXML file formats
+ * https://www.ecma-international.org/publications-and-standards/standards/ecma-376/
+ *
+ * Or XLSX extension of OpenXml
+ * https://docs.microsoft.com/en-us/openspecs/office_standards/ms-xlsx/2c5dee00-eff2-4b22-92b6-0738acd4475e
+ *
+ *
+ * Quick reference :
+ * [OpenXml] :
+ *  - border (XLSXBorder): §18.8.4 (border)
+ *  - cells (XLSXCell): §18.3.1.4 (c)
+ *  - color (XLSXColor): §18.3.1.15 (color)
+ *  - columns (XLSXColumn): §18.3.1.13 (col)
+ *  - conditional format (XLSXConditionalFormat): §18.3.1.18 (conditionalFormatting)
+ *  - chart (ExcelChartDefinition): §21.2.2.27 (chart)
+ *  - cf rule (XLSXCfRule): §18.3.1.10 (cfRule)
+ *  - cf rule icon set (XLSXIconSet) : §18.3.1.49 (iconSet)
+ *  - cf value object (XLSXCfValueObject): §18.3.1.11 (cfvo)
+ *  - data filter (XLSXSimpleFilter): §18.3.2.6 (filter)
+ *  - data filter column (XLSXFilterColumn): §18.3.2.7 (filterColumns)
+ *  - data filter zone (XLSXAutoFilter): §18.3.1.2 (autoFilter)
+ *  - external workbook (XLSXExternalBook): $18.14.7 (externalBook)
+ *  - fills (XLSXFill): §18.8.20 (fill)
+ *  - figure (XLSXFigure): §20.5.2.35 (wsDr (Worksheet Drawing))
+ *  - fonts (XLSXFont): §18.8.22 (font)
+ *  - images (XLSXImageFile): §20.2.2.5 (pic)
+ *  - merge (string): §18.3.1.55 (mergeCell)
+ *  - number format (XLSXNumFormat) : §18.8.30 (numFmt)
+ *  - rows (XLSXRow): §18.3.1.73 (row)
+ *  - sheet (XLSXWorksheet): §18.3.1.99 (worksheet)
+ *  - sheet format (XLSXSheetFormat): §18.3.1.81 (sheetFormatPr)
+ *  - sheet view (XLSXSheetView): §18.3.1.87 (sheetFormatPr)
+ *  - sheet workbook info (XLSXSheetWorkbookInfo): §18.2.19 (sheet)
+ *  - style, for cell (XLSXStyle): §18.8.45 (xf)
+ *  - style, for non-cell (eg. conditional format) (XLSXDxf): §18.8.14 (dxf)
+ *  - table (XLSXTable) : §18.5.1.2 (table)
+ *  - table column (XLSXTableCol) : §18.5.1.3 (tableColumn)
+ *  - table style (XLSXTableStyleInfo) : §18.5.1.5 (tableStyleInfo)
+ *  - theme color : §20.1.2.3.32 (srgbClr/sysClr)
+ *
+ * [XLSX]: :
+ * - cf rule (XLSXCfRule): §2.6.2 (CT_ConditionalFormatting)
+ * - cf rule icon set (XLSXIconSet): §2.6.28 (CT_IconSet)
+ * - cf icon (XLSXCfIcon): §2.6.36 (CT_CfIcon)
+ *
+ * Simple Types :
+ * [OpenXml] :
+ *  - border style (XLSXBorderStyle):  §18.18.3 (Border Line Styles)
+ *  - cell type (XLSXCellType):  §18.18.11 (Cell Type) (mapped with xlsxCellTypeMap to be human readable)
+ *  - cf type (XLSXCfType):  §18.18.12 (Conditional Format Type)
+ *  - cf value object type (XLSXCfValueObjectType):  §18.18.13 (Conditional Format Value Object Type)
+ *  - cf operator type (XLSXCfOperatorType):  §18.18.15 (Conditional Format Operators)
+ *  - fill pattern types (XLSXFillPatternType):  §18.18.55 (Pattern Type)
+ *  - horizontal alignment (XLSXHorizontalAlignment):  §18.18.40 (Horizontal Alignment Type)
+ *  - vertical alignment (XLSXVerticalAlignment):  §18.18.88 (Horizontal Alignment Type)
+ *
+ * [XLSX] :
+ *  - icon set types (ExcelIconSet):  §2.7.10 (ST_IconSetType)
+ */
+/**
+ * This structure covers all the necessary "assets" to generate an XLSX file.
+ * Those assets consist of:
+ *  - a rel file including metadata specifying how the others files form the final document
+ *    (this currently includes sheets, styles, shared content (string))
+ *  - a sharedStrings file that regroups all static string values found in the cells
+ *  - a style file including all the normalized style elements for cells,
+ *    including cell-specific conditional formatting
+ *
+ * @param rels: a list of files and their specific type/role in the final document
+ * @param sharedStrings: regroups all static string values found in the cells.
+ * @param fonts: All normalized fonts
+ * @param fills: " normalized fills
+ * @param borders: " normalized borders
+ * @param NumFmts: " normalized number formats
+ * @param styles: " combinations of font-fill-border, number format found in the cells
+ * @param dxf: " Conditional Formatting of type "CellIsRule"
+ */
+export interface XLSXStructure {
+    relsFiles: XLSXRelFile[];
+    sharedStrings: string[];
+    fonts: XLSXFont[];
+    fills: XLSXFill[];
+    borders: XLSXBorder[];
+    numFmts: XLSXNumFormat[];
+    styles: XLSXStyle[];
+    dxfs: XLSXDxf[];
+}
+export interface XLSXImportData extends Omit<XLSXStructure, "relsFiles"> {
+    sheets: XLSXWorksheet[];
+    externalBooks: XLSXExternalBook[];
+}
+export interface XLSXFileStructure {
+    sheets: XLSXImportFile[];
+    workbook: XLSXImportFile;
+    styles: XLSXImportFile;
+    sharedStrings: XLSXImportFile;
+    theme?: XLSXImportFile;
+    charts: XLSXImportFile[];
+    figures: XLSXImportFile[];
+    tables: XLSXImportFile[];
+    externalLinks: XLSXImportFile[];
+    images: XLSXImageFile[];
+}
+export type XMLAttributeValue = string | number | boolean;
+type XMLAttribute = [string, XMLAttributeValue];
+export type XMLAttributes = XMLAttribute[];
+/**
+ * Represent a raw XML string
+ */
+export declare class XMLString {
+    private xmlString;
+    /**
+     * @param xmlString should be a well formed, properly escaped XML string
+     */
+    constructor(xmlString: string);
+    toString(): string;
+}
+export interface XLSXDxf {
+    font?: XLSXFont;
+    fill?: XLSXFill;
+    numFmt?: XLSXNumFormat;
+    alignment?: XLSXCellAlignment;
+    border?: XLSXBorder;
+}
+export interface XLSXRel {
+    id: string;
+    type: string;
+    target: string;
+    targetMode?: "External";
+}
+export interface XLSXRelFile {
+    path: string;
+    rels: XLSXRel[];
+}
+export type XLSXExportFile = XLSXExportImageFile | XLSXExportXMLFile;
+export interface XLSXExportXMLFile {
+    path: string;
+    content: string;
+    contentType?: string;
+}
+export interface XLSXExportImageFile {
+    path: string;
+    imageSrc: string;
+}
+export interface XLSXExport {
+    name: string;
+    files: XLSXExportFile[];
+}
+export interface XLSXFont {
+    size?: number;
+    family?: number;
+    color?: XLSXColor;
+    name?: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strike?: boolean;
+}
+export interface XLSXCellAlignment {
+    horizontal?: XLSXHorizontalAlignment;
+    vertical?: XLSXVerticalAlignment;
+    textRotation?: number;
+    wrapText?: boolean;
+    indent?: number;
+    relativeIndent?: number;
+    justifyLastLine?: boolean;
+    shrinkToFit?: boolean;
+    readingOrder?: number;
+}
+export interface XLSXFill {
+    patternType?: XLSXFillPatternType;
+    reservedAttribute?: string;
+    fgColor?: XLSXColor;
+    bgColor?: XLSXColor;
+}
+export interface XLSXStyle {
+    fontId: number;
+    fillId: number;
+    borderId: number;
+    numFmtId: number;
+    alignment?: XLSXCellAlignment;
+}
+export interface ExtractedStyle {
+    font: XLSXFont;
+    fill: XLSXFill;
+    border: number;
+    numFmt: XLSXNumFormat | undefined;
+    alignment: XLSXCellAlignment;
+}
+export interface XLSXWorksheet {
+    sheetName: string;
+    isVisible: boolean;
+    sheetViews: XLSXSheetView[];
+    sheetFormat?: XLSXSheetFormat;
+    cols: XLSXColumn[];
+    rows: XLSXRow[];
+    cfs: XLSXConditionalFormat[];
+    sharedFormulas: string[];
+    merges: string[];
+    figures: XLSXFigure[];
+    hyperlinks: XLSXHyperLink[];
+    tables: XLSXTable[];
+}
+export interface XLSXSheetView {
+    /** True if this is the sheet currently selected */
+    tabSelected: boolean;
+    showFormulas: boolean;
+    showGridLines: boolean;
+    showRowColHeaders: boolean;
+    pane: PaneDivision;
+}
+export interface XLSXSheetFormat {
+    defaultColWidth: number;
+    defaultRowHeight: number;
+}
+export interface XLSXColumn {
+    min: number;
+    max: number;
+    width?: number;
+    customWidth?: boolean;
+    bestFit?: boolean;
+    hidden?: boolean;
+    styleIndex?: number;
+}
+export interface XLSXRow {
+    index: number;
+    height?: number;
+    customHeight?: boolean;
+    hidden?: boolean;
+    cells: XLSXCell[];
+    styleIndex?: number;
+}
+export interface XLSXFormula {
+    content?: string;
+    sharedIndex?: number;
+    ref?: string;
+}
+export interface XLSXCell {
+    xc: string;
+    styleIndex?: number;
+    type: XLSXCellType;
+    value?: string;
+    formula?: XLSXFormula;
+}
+export interface XLSXTheme {
+    clrScheme?: XLSXColorScheme[];
+}
+export interface XLSXColorScheme {
+    name: string;
+    value: string;
+    lastClr?: string;
+}
+export interface XLSXNumFormat {
+    id: number;
+    format: Format;
+}
+export interface XLSXBorder {
+    top?: XLSXBorderDescr;
+    left?: XLSXBorderDescr;
+    bottom?: XLSXBorderDescr;
+    right?: XLSXBorderDescr;
+    diagonal?: XLSXBorderDescr;
+    diagonalUp?: boolean;
+    diagonalDown?: boolean;
+}
+export interface XLSXBorderDescr {
+    style: XLSXBorderStyle;
+    color: XLSXColor;
+}
+export type ExcelIconSet = "NoIcons" | "3Arrows" | "3ArrowsGray" | "3Symbols" | "3Symbols2" | "3Signs" | "3Flags" | "3TrafficLights1" | "3TrafficLights2" | "4Arrows" | "4ArrowsGray" | "4RedToBlack" | "4Rating" | "4TrafficLights" | "5Arrows" | "5ArrowsGray" | "5Rating" | "5Quarters" | "3Stars" | "3Triangles" | "5Boxes";
+/**
+ * Standardized XLSX hexadecimal color (with or without alpha channel).
+ * Note that the alpha channel goes first! AARRGGBB
+ * e.g. "1E5010" or "331E5010"
+ */
+export type XlsxHexColor = string & Alias;
+export interface ImportedFiles {
+    [path: string]: string | {
+        imageSrc: string;
+    };
+}
+export interface XLSXXmlDocuments {
+    [path: string]: XMLDocument;
+}
+export interface XLSXImageFile {
+    fileName: string;
+    imageSrc: string;
+}
+type XLSXFillPatternType = "none" | "solid" | "gray0625" | "gray125" | "lightGray" | "mediumGray" | "darkGray" | "darkHorizontal" | "darkVertical" | "darkUp" | "darkDown" | "darkGrid" | "darkTrellis" | "lightHorizontal" | "lightVertical" | "lightDown" | "lightUp" | "lightGrid" | "lightTrellis";
+export type XLSXBorderStyle = "dashDot" | "dashDotDot" | "dashed" | "dotted" | "double" | "hair" | "medium" | "mediumDashDot" | "mediumDashDotDot" | "mediumDashed" | "none" | "slantDashDot" | "thick" | "thin";
+export type XLSXCellType = "boolean" | "date" | "error" | "inlineStr" | "number" | "sharedString" | "str";
+export type XLSXCfType = "aboveAverage" | "expression" | "cellIs" | "colorScale" | "dataBar" | "iconSet" | "top10" | "uniqueValues" | "duplicateValues" | "containsText" | "notContainsText" | "beginsWith" | "endsWith" | "containsBlanks" | "notContainsBlanks" | "containsErrors" | "notContainsErrors" | "timePeriod";
+export type XLSXCfOperatorType = "beginsWith" | "between" | "containsText" | "endsWith" | "equal" | "greaterThan" | "greaterThanOrEqual" | "lessThan" | "lessThanOrEqual" | "notBetween" | "notContains" | "notEqual";
+export type XLSXHorizontalAlignment = "general" | "left" | "center" | "right" | "fill" | "justify" | "centerContinuous" | "distributed";
+export type XLSXVerticalAlignment = "top" | "center" | "bottom" | "justify" | "distributed";
+export type XLSXCfValueObjectType = "num" | "percent" | "max" | "min" | "percentile" | "formula";
+export interface XLSXCfValueObject {
+    type: XLSXCfValueObjectType;
+    gte?: boolean;
+    value?: string;
+}
+export interface XLSXColorScale {
+    colors: XLSXColor[];
+    cfvos: XLSXCfValueObject[];
+}
+export interface XLSXIconSet {
+    iconSet: ExcelIconSet;
+    cfvos: XLSXCfValueObject[];
+    cfIcons?: XLSXCfIcon[];
+    showValue?: boolean;
+    percent?: boolean;
+    reverse?: boolean;
+    custom?: boolean;
+}
+export interface XLSXCfIcon {
+    iconSet: ExcelIconSet;
+    iconId: number;
+}
+export interface XLSXConditionalFormat {
+    cfRules: XLSXCfRule[];
+    sqref: string[];
+    pivot?: boolean;
+}
+export interface XLSXCfRule {
+    type: XLSXCfType;
+    priority: number;
+    formula?: string[];
+    colorScale?: XLSXColorScale;
+    dataBar?: any;
+    iconSet?: XLSXIconSet;
+    dxfId?: number;
+    stopIfTrue?: boolean;
+    aboveAverage?: boolean;
+    percent?: boolean;
+    bottom?: boolean;
+    operator?: XLSXCfOperatorType;
+    text?: string;
+    timePeriod?: any;
+    rank?: number;
+    stdDev?: number;
+    equalAverage?: boolean;
+}
+export interface XLSXSharedFormula {
+    formula: string;
+    refCellXc: string;
+}
+export interface XLSXColor {
+    auto?: boolean;
+    indexed?: number;
+    rgb?: string;
+    tint?: number;
+}
+export interface XLSXFigureAnchor {
+    col: number;
+    colOffset: number;
+    row: number;
+    rowOffset: number;
+}
+export interface XLSXFigureSize {
+    cx: number;
+    cy: number;
+}
+export interface XLSXFigure {
+    anchors: XLSXFigureAnchor[];
+    data: ExcelChartDefinition | ExcelImage;
+}
+export declare const XLSX_CHART_TYPES: readonly ["areaChart", "area3DChart", "lineChart", "line3DChart", "stockChart", "radarChart", "scatterChart", "pieChart", "pie3DChart", "doughnutChart", "barChart", "bar3DChart", "ofPieChart", "surfaceChart", "surface3DChart", "bubbleChart"];
+export type XLSXChartType = (typeof XLSX_CHART_TYPES)[number];
+/** An XLSX File is a main XML file and optionally a corresponding rel file */
+export interface XLSXImportFile {
+    file: XMLFile;
+    rels?: XMLFile;
+}
+export interface XMLFile {
+    fileName: string;
+    xml: XMLDocument;
+}
+export interface XLSXHyperLink {
+    xc: string;
+    location?: string;
+    display?: string;
+    relTarget?: string;
+}
+export interface XLSXTableStyleInfo {
+    name?: string;
+    showFirstColumn?: boolean;
+    showLastColumn?: boolean;
+    showRowStripes?: boolean;
+    showColumnStripes?: boolean;
+}
+export interface XLSXTableCol {
+    name: string;
+    id: string;
+    colFormula?: string;
+}
+export interface XLSXTable {
+    displayName: string;
+    name?: string;
+    id: string;
+    ref: string;
+    headerRowCount: number;
+    totalsRowCount: number;
+    cols: XLSXTableCol[];
+    style?: XLSXTableStyleInfo;
+    autoFilter?: XLSXAutoFilter;
+}
+export interface XLSXAutoFilter {
+    zone: string;
+    columns: XLSXFilterColumn[];
+}
+export interface XLSXFilterColumn {
+    colId: number;
+    hiddenButton?: boolean;
+    filters: XLSXSimpleFilter[];
+}
+export interface XLSXSimpleFilter {
+    val: string;
+}
+export interface XLSXExternalBook {
+    rId: string;
+    sheetNames: string[];
+    datasets: XLSXExternalSheetData[];
+}
+export interface XLSXExternalSheetData {
+    sheetId: number;
+    data: Record<string, string>;
+}
+export type XLSXSheetState = "visible" | "hidden" | "veryHidden";
+export interface XLSXSheetWorkbookInfo {
+    relationshipId: string;
+    sheetId: string;
+    sheetName: string;
+    state: XLSXSheetState;
+}
+export {};

package/dist/types/xlsx/constants.d.ts

@@ -0,0 +1,74 @@
+import { IconSetType } from "../components/icons/icons";
+import { ExcelIconSet } from "../types/xlsx";
+/** In XLSX color format (no #)  */
+export declare const AUTO_COLOR = "000000";
+export declare const XLSX_ICONSET_MAP: Record<IconSetType, ExcelIconSet>;
+export declare const NAMESPACE: {
+    styleSheet: string;
+    sst: string;
+    Relationships: string;
+    Types: string;
+    worksheet: string;
+    workbook: string;
+    drawing: string;
+    table: string;
+    revision: string;
+    revision3: string;
+    markupCompatibility: string;
+};
+export declare const DRAWING_NS_A = "http://schemas.openxmlformats.org/drawingml/2006/main";
+export declare const DRAWING_NS_C = "http://schemas.openxmlformats.org/drawingml/2006/chart";
+export declare const CONTENT_TYPES: {
+    readonly workbook: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml";
+    readonly sheet: "application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml";
+    readonly metadata: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheetMetadata+xml";
+    readonly sharedStrings: "application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml";
+    readonly styles: "application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml";
+    readonly drawing: "application/vnd.openxmlformats-officedocument.drawing+xml";
+    readonly chart: "application/vnd.openxmlformats-officedocument.drawingml.chart+xml";
+    readonly themes: "application/vnd.openxmlformats-officedocument.theme+xml";
+    readonly table: "application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml";
+    readonly pivot: "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotTable+xml";
+    readonly externalLink: "application/vnd.openxmlformats-officedocument.spreadsheetml.externalLink+xml";
+};
+export declare const XLSX_RELATION_TYPE: {
+    readonly document: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument";
+    readonly sheet: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet";
+    readonly metadata: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sheetMetadata";
+    readonly sharedStrings: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings";
+    readonly styles: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles";
+    readonly drawing: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing";
+    readonly chart: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart";
+    readonly theme: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme";
+    readonly table: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/table";
+    readonly hyperlink: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink";
+    readonly image: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image";
+};
+export declare const ARRAY_FORMULA_URI = "bdbb8cdc-fa1e-496e-a857-3c3f30c029c3";
+export declare const RELATIONSHIP_NSR = "http://schemas.openxmlformats.org/officeDocument/2006/relationships";
+export declare const HEIGHT_FACTOR = 0.75;
+/**
+ * Excel says its default column width is 8.43 characters (64px)
+ * which makes WIDTH_FACTOR = 0.1317, but it doesn't work well
+ * 0.143 is a value from dev's experiments.
+ */
+export declare const WIDTH_FACTOR = 0.143;
+/** unit : maximum number of characters a column can hold at the standard font size. What. */
+export declare const EXCEL_DEFAULT_COL_WIDTH = 8.43;
+/** unit : points */
+export declare const EXCEL_DEFAULT_ROW_HEIGHT = 12.75;
+export declare const EXCEL_IMPORT_DEFAULT_NUMBER_OF_COLS = 30;
+export declare const EXCEL_IMPORT_DEFAULT_NUMBER_OF_ROWS = 100;
+export declare const FIRST_NUMFMT_ID = 164;
+interface functionDefaultArg {
+    type: "NUMBER";
+    value: number;
+}
+export declare const FORCE_DEFAULT_ARGS_FUNCTIONS: Record<string, functionDefaultArg[]>;
+/**
+ * This list contains all "future" functions that are not compatible with older versions of Excel
+ * For more information, see https://docs.microsoft.com/en-us/openspecs/office_standards/ms-xlsx/5d1b6d44-6fc1-4ecd-8fef-0b27406cc2bf
+ */
+export declare const NON_RETROCOMPATIBLE_FUNCTIONS: string[];
+export declare const CONTENT_TYPES_FILE = "[Content_Types].xml";
+export {};

package/dist/types/xlsx/conversion/cf_conversion.d.ts

@@ -0,0 +1,4 @@
+import { ConditionalFormat } from "../../types";
+import { XLSXConditionalFormat, XLSXDxf } from "../../types/xlsx";
+import { XLSXImportWarningManager } from "../helpers/xlsx_parser_error_manager";
+export declare function convertConditionalFormats(xlsxCfs: XLSXConditionalFormat[], dxfs: XLSXDxf[], warningManager: XLSXImportWarningManager): ConditionalFormat[];

package/dist/types/xlsx/conversion/color_conversion.d.ts

@@ -0,0 +1,24 @@
+import { Color } from "../../types";
+import { XLSXColor } from "../../types/xlsx";
+/**
+ * Most of the functions could stay private, but are exported for testing purposes
+ */
+/**
+ *
+ * Extract the color referenced inside of an XML element and return it as an hex string #RRGGBBAA (or #RRGGBB
+ * if alpha = FF)
+ *
+ *  The color is an attribute of the element that can be :
+ *  - rgb : an rgb string
+ *  - theme : a reference to a theme element
+ *  - auto : automatic coloring. Return const AUTO_COLOR in constants.ts.
+ *  - indexed : a legacy indexing scheme for colors. The only value that should be present in a xlsx is
+ *      64 = System Foreground, that we can replace with AUTO_COLOR.
+ */
+export declare function convertColor(xlsxColor: XLSXColor | undefined): Color | undefined;
+/**
+ * Convert a hex + alpha color string to an integer representation. Also remove the alpha.
+ *
+ * eg. #FF0000FF => 4278190335
+ */
+export declare function hexaToInt(hex: Color): number;