@odoo/o-spreadsheet 18.0.54 → 18.0.67

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

@@ -0,0 +1,19 @@
+import { XLSXBorder, XLSXDxf, XLSXFileStructure, XLSXFill, XLSXFont, XLSXNumFormat, XLSXStyle, XLSXTheme } from "../../types/xlsx";
+import { XLSXImportWarningManager } from "../helpers/xlsx_parser_error_manager";
+import { XlsxBaseExtractor } from "./base_extractor";
+export declare class XlsxStyleExtractor extends XlsxBaseExtractor {
+    theme?: XLSXTheme;
+    constructor(xlsxStructure: XLSXFileStructure, warningManager: XLSXImportWarningManager, theme: XLSXTheme | undefined);
+    getNumFormats(): XLSXNumFormat[];
+    private extractNumFormats;
+    getFonts(): XLSXFont[];
+    private extractFont;
+    getFills(): XLSXFill[];
+    private extractFill;
+    getBorders(): XLSXBorder[];
+    private extractBorder;
+    private extractSingleBorder;
+    private extractAlignment;
+    getDxfs(): XLSXDxf[];
+    getStyles(): XLSXStyle[];
+}

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

@@ -0,0 +1,10 @@
+import { XLSXTable } from "../../types/xlsx";
+import { XlsxBaseExtractor } from "./base_extractor";
+export declare class XlsxTableExtractor extends XlsxBaseExtractor {
+    getTable(): XLSXTable;
+    private extractTableCols;
+    private extractTableStyleInfo;
+    private extractTableAutoFilter;
+    private extractFilterColumns;
+    private extractSimpleFilter;
+}

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

@@ -0,0 +1,11 @@
+import { ExcelCellData } from "../../types";
+import { XMLAttributes, XMLString } from "../../types/xlsx";
+export declare function addFormula(cell: ExcelCellData, formulaSpillRange: string): {
+    attrs: XMLAttributes;
+    node: XMLString;
+};
+export declare function addContent(content: string, sharedStrings: string[], forceString?: boolean): {
+    attrs: XMLAttributes;
+    node: XMLString;
+};
+export declare function adaptFormulaToExcel(formulaText: string): string;

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

@@ -0,0 +1,3 @@
+import { ExcelWorkbookData, FigureData } from "../../types";
+import { ExcelChartDefinition } from "../../types/chart/chart";
+export declare function createChart(chart: FigureData<ExcelChartDefinition>, chartSheetIndex: string, data: ExcelWorkbookData): XMLDocument;

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

@@ -0,0 +1,3 @@
+import { ConditionalFormat } from "../../types";
+import { XLSXDxf, XMLString } from "../../types/xlsx";
+export declare function addConditionalFormatting(dxfs: XLSXDxf[], conditionalFormats: ConditionalFormat[]): XMLString[];

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

@@ -0,0 +1,3 @@
+import { DataValidationRuleData } from "../../types";
+import { XMLString } from "../../types/xlsx";
+export declare function addDataValidationRules(dataValidationRules: DataValidationRuleData[]): XMLString[];

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

@@ -0,0 +1,5 @@
+import { SheetData } from "../../types";
+import { ExcelChartDefinition } from "../../types/chart/chart";
+import { Image } from "./../../types/image";
+import { FigureData } from "./../../types/workbook_data";
+export declare function createDrawing(drawingRelIds: string[], sheet: SheetData, figures: FigureData<ExcelChartDefinition | Image>[]): XMLDocument;

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

@@ -0,0 +1,10 @@
+import { XLSXBorder, XLSXDxf, XLSXFill, XLSXFont, XLSXNumFormat, XLSXStyle, XMLString } from "../../types/xlsx";
+export declare function addNumberFormats(numFmts: XLSXNumFormat[]): XMLString;
+export declare function addFonts(fonts: XLSXFont[]): XMLString;
+export declare function addFills(fills: XLSXFill[]): XMLString;
+export declare function addBorders(borders: XLSXBorder[]): XMLString;
+export declare function addStyles(styles: XLSXStyle[]): XMLString;
+/**
+ * DXFS : Differential Formatting Records - Conditional formats
+ */
+export declare function addCellWiseConditionalFormatting(dxfs: XLSXDxf[]): XMLString;

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

@@ -0,0 +1,2 @@
+import { ExcelSheetData, ExcelTableData } from "../../types";
+export declare function createTable(table: ExcelTableData, tableId: number, sheetData: ExcelSheetData): XMLDocument;

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

@@ -0,0 +1,10 @@
+import { ExcelHeaderData, ExcelSheetData, ExcelWorkbookData } from "../../types";
+import { XLSXStructure, XMLString } from "../../types/xlsx";
+export declare function addColumns(cols: {
+    [key: number]: ExcelHeaderData;
+}): XMLString;
+export declare function addRows(construct: XLSXStructure, data: ExcelWorkbookData, sheet: ExcelSheetData): XMLString;
+export declare function addHyperlinks(construct: XLSXStructure, data: ExcelWorkbookData, sheetIndex: string): XMLString;
+export declare function addMerges(merges: string[]): XMLString;
+export declare function addSheetViews(sheet: ExcelSheetData): XMLString;
+export declare function addSheetProperties(sheet: ExcelSheetData): "" | XMLString;

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

@@ -0,0 +1,8 @@
+import { Color } from "../../types";
+import { XlsxHexColor } from "../../types/xlsx";
+/**
+ * Convert a JS color hexadecimal to an excel compatible color.
+ *
+ * In Excel the color don't start with a '#' and the format is AARRGGBB instead of RRGGBBAA
+ */
+export declare function toXlsxHexColor(color: Color): XlsxHexColor;

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

@@ -0,0 +1,58 @@
+import { ConditionalFormattingOperatorValues, ExcelCellData, ExcelWorkbookData, UID, WorkbookData } from "../../types";
+import { ExtractedStyle, XLSXDataValidationDateOperatorType, XLSXDataValidationOperatorType, XLSXRel, XLSXRelFile, XLSXStructure, XLSXWorksheet } from "../../types/xlsx";
+/**
+ * Convert the conditional formatting o-spreadsheet operator to
+ * the corresponding excel operator.
+ * */
+export declare function convertOperator(operator: ConditionalFormattingOperatorValues): string;
+export declare function getCellType(value: number | string | boolean | null): string | undefined;
+export declare function convertHeightToExcel(height: number): number;
+export declare function convertWidthToExcel(width: number): number;
+export declare function convertHeightFromExcel(height: number | undefined): number | undefined;
+export declare function convertWidthFromExcel(width: number | undefined): number | undefined;
+export declare function extractStyle(cell: ExcelCellData, data: WorkbookData): ExtractedStyle;
+export declare function normalizeStyle(construct: XLSXStructure, styles: ExtractedStyle): number;
+/**
+ * Add a relation to the given file and return its id.
+ */
+export declare function addRelsToFile(relsFiles: XLSXRelFile[], path: string, rel: Omit<XLSXRel, "id">): string;
+export declare function pushElement<T>(property: T, propertyList: T[]): number;
+/**
+ * Convert a chart o-spreadsheet id to a xlsx id which
+ * are unsigned integers (starting from 1).
+ */
+export declare function convertChartId(chartId: UID): number;
+/**
+ * Convert a image o-spreadsheet id to a xlsx id which
+ * are unsigned integers (starting from 1).
+ */
+export declare function convertImageId(imageId: UID): number;
+/**
+ * Convert a value expressed in dot to EMU.
+ * EMU = English Metrical Unit
+ * There are 914400 EMU per inch.
+ *
+ * /!\ A value expressed in EMU cannot be fractional.
+ * See https://docs.microsoft.com/en-us/windows/win32/vml/msdn-online-vml-units#other-units-of-measurement
+ */
+export declare function convertDotValueToEMU(value: number): number;
+export declare function getRangeSize(reference: string, defaultSheetIndex: string, data: ExcelWorkbookData): number;
+export declare function convertEMUToDotValue(value: number): number;
+/**
+ * Get the position of the start of a column in Excel (in px).
+ */
+export declare function getColPosition(colIndex: number, sheetData: XLSXWorksheet): number;
+/**
+ * Get the position of the start of a row in Excel (in px).
+ */
+export declare function getRowPosition(rowIndex: number, sheetData: XLSXWorksheet): number;
+/**
+ * Convert the o-spreadsheet data validation decimal
+ * criterion type to the corresponding excel operator.
+ */
+export declare function convertDecimalCriterionTypeToExcelOperator(operator: string): XLSXDataValidationOperatorType;
+/**
+ * Convert the o-spreadsheet data validation date
+ * criterion type to the corresponding excel operator.
+ */
+export declare function convertDateCriterionTypeToExcelOperator(operator: string): XLSXDataValidationDateOperatorType;

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

@@ -0,0 +1,34 @@
+import { Dimension, ExcelHeaderData, ExcelSheetData } from "../../types";
+/**
+ * Get the relative path between two files
+ *
+ * Eg.:
+ * from "folder1/file1.txt" to "folder2/file2.txt" => "../folder2/file2.txt"
+ */
+export declare function getRelativePath(from: string, to: string): string;
+/**
+ * Convert an array of element into an object where the objects keys were the elements position in the array.
+ * Can give an offset as argument, and all the array indexes will we shifted by this offset in the returned object.
+ *
+ * eg. : ["a", "b"] => {0:"a", 1:"b"}
+ */
+export declare function arrayToObject<T>(array: T[], indexOffset?: number): {
+    [key: number]: T;
+};
+/**
+ * Convert an object whose keys are numbers to an array were the element index was their key in the object.
+ *
+ * eg. : {0:"a", 2:"b"} => ["a", undefined, "b"]
+ */
+export declare function objectToArray<T>(obj: {
+    [key: number]: T;
+}): T[];
+/**
+ * In xlsx we can have string with unicode characters with the format _x00fa_.
+ * Replace with characters understandable by JS
+ */
+export declare function fixXlsxUnicode(str: string): string;
+/** Get a header in the SheetData. Create the header if it doesn't exist in the SheetData */
+export declare function getSheetDataHeader(sheetData: ExcelSheetData, dimension: Dimension, index: number): ExcelHeaderData;
+/** Prefix the string by "=" if the string looks like a formula */
+export declare function prefixFormulaWithEqual(formula: string): string;

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

@@ -0,0 +1,10 @@
+import { XLSXImportFile, XLSXXmlDocuments } from "../../types/xlsx";
+import { XLSXExportFile, XLSXExportXMLFile } from "./../../types/xlsx";
+/**
+ * Return all the xmls converted to XLSXImportFile corresponding to the given content type.
+ */
+export declare function getXLSXFilesOfType(contentType: string, xmls: XLSXXmlDocuments): XLSXImportFile[];
+/**
+ * Return whether an exported file is an XML file or other kinds of file (e.g. image)
+ */
+export declare function isXLSXExportXMLFile(file: XLSXExportFile): file is XLSXExportXMLFile;

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

@@ -0,0 +1,38 @@
+/**
+ * Map of the different types of conversions warnings and their name in error messages
+ */
+export declare enum WarningTypes {
+    DiagonalBorderNotSupported = "Diagonal Borders",
+    BorderStyleNotSupported = "Border style",
+    FillStyleNotSupported = "Fill Style",
+    FontNotSupported = "Font",
+    HorizontalAlignmentNotSupported = "Horizontal Alignment",
+    VerticalAlignmentNotSupported = "Vertical Alignments",
+    MultipleRulesCfNotSupported = "Multiple rules conditional formats",
+    CfTypeNotSupported = "Conditional format type",
+    CfFormatBorderNotSupported = "Borders in conditional formats",
+    CfFormatAlignmentNotSupported = "Alignment in conditional formats",
+    CfFormatNumFmtNotSupported = "Num formats in conditional formats",
+    CfIconSetEmptyIconNotSupported = "IconSets with empty icons",
+    BadlyFormattedHyperlink = "Badly formatted hyperlink",
+    NumFmtIdNotSupported = "Number format",
+    TimeDataValidationNotSupported = "Time data validation rules",
+    TextLengthDataValidationNotSupported = "Text length data validation rules",
+    WholeNumberDataValidationNotSupported = "Whole number data validation rules",
+    NotEqualDateDataValidationNotSupported = "Not equal date data validation rules"
+}
+export declare class XLSXImportWarningManager {
+    _parsingWarnings: Set<string>;
+    _conversionWarnings: Set<string>;
+    addParsingWarning(warning: string): void;
+    addConversionWarning(warning: string): void;
+    get warnings(): string[];
+    /**
+     * Add a warning "... is not supported" to the manager.
+     *
+     * @param type the type of the warning to add
+     * @param name optional, name of the element that was not supported
+     * @param supported optional, list of the supported elements
+     */
+    generateNotSupportedWarning(type: WarningTypes, name?: string, supported?: string[]): void;
+}

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

@@ -0,0 +1,36 @@
+import { ExcelWorkbookData } from "../../types";
+import { XLSXStructure, XMLAttributeValue, XMLAttributes, XMLString } from "../../types/xlsx";
+import { XLSXExportXMLFile } from "./../../types/xlsx";
+export declare function createXMLFile(doc: XMLDocument, path: string, contentType?: string): XLSXExportXMLFile;
+export declare function xmlEscape(str: XMLAttributeValue): string;
+export declare function formatAttributes(attrs: XMLAttributes): XMLString;
+export declare function parseXML(xmlString: XMLString, mimeType?: DOMParserSupportedType): XMLDocument;
+export declare function getDefaultXLSXStructure(data: ExcelWorkbookData): XLSXStructure;
+export declare function createOverride(partName: string, contentType: string): XMLString;
+export declare function createDefaultXMLElement(extension: string, contentType: string): XMLString;
+export declare function joinXmlNodes(xmlNodes: XMLString[]): XMLString;
+/**
+ * Escape interpolated values except if the value is already
+ * a properly escaped XML string.
+ *
+ * ```
+ * escapeXml`<t>${"This will be escaped"}</t>`
+ * ```
+ */
+export declare function escapeXml(strings: TemplateStringsArray, ...expressions: any[]): XMLString;
+/**
+ * Removes the escaped namespace of all the xml tags in the string.
+ *
+ * Eg. : "NAMESPACEnsNAMESPACEtest a" => "test a"
+ */
+export declare function removeTagEscapedNamespaces(tag: string): string;
+/**
+ * Encase the namespaces in the element's tags with NAMESPACE string
+ *
+ * e.g. <x:foo> becomes <NAMESPACExNAMESPACEFoo>
+ *
+ * That's useful because namespaces aren't supported by the HTML specification, so it's arbitrary whether a HTML parser/querySelector
+ * implementation will support namespaces in the tags or not.
+ */
+export declare function escapeTagNamespaces(str: string): string;
+export declare function escapeQueryNameSpaces(query: string): string;

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

@@ -0,0 +1,13 @@
+import { ImportedFiles, XLSXImageFile, XLSXImportData, XLSXXmlDocuments } from "../types/xlsx";
+import { WorkbookData } from "./../types/workbook_data";
+import { XLSXImportWarningManager } from "./helpers/xlsx_parser_error_manager";
+export declare class XlsxReader {
+    warningManager: XLSXImportWarningManager;
+    xmls: XLSXXmlDocuments;
+    images: XLSXImageFile[];
+    constructor(files: ImportedFiles);
+    convertXlsx(): WorkbookData;
+    private getXlsxData;
+    private buildXlsxFileStructure;
+    convertImportedData(data: XLSXImportData): WorkbookData;
+}

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

@@ -0,0 +1,19 @@
+import { ExcelWorkbookData } from "../types";
+import { XLSXExport } from "../types/xlsx";
+/**
+ * Return the spreadsheet data in the Office Open XML file format.
+ * See ECMA-376 standard.
+ * https://www.ecma-international.org/publications-and-standards/standards/ecma-376/
+ */
+export declare function getXLSX(data: ExcelWorkbookData): XLSXExport;
+/**
+ * Excel sheet names are maximum 31 characters while o-spreadsheet do not have this limit.
+ * This method converts the sheet names to be within the 31 characters limit.
+ * The cells/charts referencing this sheet will be updated accordingly.
+ */
+export declare function fixLengthySheetNames(data: ExcelWorkbookData): ExcelWorkbookData;
+/** Excel files do not support tables with a single row the defined range
+ * Since those tables are not really useful (no filtering/limited styling)
+ * This function filters out all tables with a single row.
+ */
+export declare function purgeSingleRowTables(data: ExcelWorkbookData): ExcelWorkbookData;

package/package.json

@@ -1,40 +1,41 @@
 {
   "name": "@odoo/o-spreadsheet",
-  "version": "18.0.54",
+  "version": "18.0.67",
   "description": "A spreadsheet component",
   "type": "module",
   "main": "dist/o-spreadsheet.cjs.js",
   "browser": "dist/o-spreadsheet.iife.js",
   "module": "dist/o-spreadsheet.esm.js",
-  "types": "dist/o-spreadsheet.d.ts",
+  "types": "dist/types/index.d.ts",
   "files": [
     "dist/*.js",
-    "dist/*.d.ts",
+    "dist/types",
     "dist/*.xml"
   ],
   "scripts": {
-    "serve-static": "live-server --open=demo --watch=build/o_spreadsheet.dev.js,build/o_spreadsheet.xml,demo",
+    "serve-static": "live-server --host=127.0.0.1 --open=demo --watch=build/o-spreadsheet.iife.js,build/o_spreadsheet.xml,demo",
     "dev": "npm-run-all --print-label buildDev --parallel server serve-static watch:*",
     "server": "node tools/server/main.cjs",
     "build:js": "tsc --module es6 --incremental",
-    "build:bundleJsDev": "rollup -c -m --configDev",
-    "build:bundleJs": "rollup -c -m --configDist",
+    "build:bundleJsDev": "rolldown -c --format iife",
+    "build:bundleJs": "rolldown -c --format esm",
     "build:bundleXml": "node tools/bundle_xml/main.cjs",
     "buildDev": "npm-run-all build:js build:bundleJsDev \"build:bundleXml -- --outDir build\"",
     "build": "npm-run-all build:js build:bundleJs \"build:bundleXml -- --outDir build\"",
     "precommit": "npm run prettier && npm run doc",
     "monkey": "SPREADSHEET_MONKEY_COUNT=$npm_config_monkey_count jest 'tests/collaborative/collaborative_monkey_party.test.ts'",
-    "test": "tsc --noEmit --project tsconfig.jest.json && jest",
+    "test": "tsc --noEmit --project tests/tsconfig.json && jest",
     "test:watch": "jest --watch",
     "prettier": "prettier . --write",
-    "check-formatting": "prettier . --check",
-    "dist": "tsc --module es6 --declaration --declarationDir dist/types && rollup -c && npm run build:bundleXml -- --outDir dist",
-    "prepare": "husky install",
+    "check-formatting": "prettier . --check && eslint",
+    "dist": "tsc --module es6 --declaration --declarationDir dist/types && rolldown -c && npm run build:bundleXml -- --outDir dist",
+    "postinstall": "husky install",
     "watch:bundle": "npm run build:bundleJsDev -- --watch",
     "watch:ts": "npm run build:js -- --watch",
     "watch:xml": "node tools/bundle_xml/watch_xml_templates.cjs",
     "unzipXlsx": "node tools/bundle_xlsx/unzip_xlsx_demo.cjs",
-    "zipXlsx": "node tools/bundle_xlsx/zip_xlsx_demo.cjs"
+    "zipXlsx": "node tools/bundle_xlsx/zip_xlsx_demo.cjs",
+    "lint": "eslint --fix"
   },
   "browserslist": [
     "last 1 Chrome versions"
@@ -57,15 +58,16 @@
   "homepage": "https://github.com/odoo/o-spreadsheet#readme",
   "devDependencies": {
     "@prettier/plugin-xml": "^2.2.0",
-    "@rollup/plugin-node-resolve": "^15.2.0",
-    "@rollup/plugin-terser": "^0.4.3",
     "@swc/jest": "0.2.36",
     "@swc/core": "1.6.7",
-    "@types/jest": "^27.0.1",
-    "@types/node": "^13.13.23",
+    "@types/jest": "^30.0.0",
+    "@types/jest-image-snapshot": "^6.4.1",
+    "@types/node": "^20.17.24",
     "@types/rbush": "^3.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.30.1",
     "body-parser": "^1.19.0",
     "chart.js": "4.4.1",
+    "canvas": "^3.0.0",
     "chartjs-adapter-luxon": "^1.3.1",
     "cors": "^2.8.5",
     "express": "^4.17.1",
@@ -74,8 +76,9 @@
     "file-saver": "^2.0.5",
     "fs": "^0.0.1-security",
     "husky": "^7.0.4",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "jest-image-snapshot": "^6.5.2",
     "jszip": "^3.6.0",
     "lint-staged": "^12.1.2",
     "live-server": "^1.2.1",
@@ -86,11 +89,10 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.0",
     "prettier-plugin-organize-imports": "^3.2.2",
-    "rollup": "^3.28.0",
-    "rollup-plugin-dts": "^5.3.1",
-    "rollup-plugin-typescript2": "^0.35.0",
+    "rolldown": "^1.0.0-rc.15",
     "seedrandom": "^3.0.5",
-    "typescript": "^5.4.3",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.30.1",
     "xml-formatter": "^2.4.0"
   },
   "optionalDependencies": {
@@ -103,7 +105,22 @@
     "@swc/core-linux-x64-musl": "1.6.7",
     "@swc/core-win32-arm64-msvc": "1.6.7",
     "@swc/core-win32-ia32-msvc": "1.6.7",
-    "@swc/core-win32-x64-msvc": "1.6.7"
+    "@swc/core-win32-x64-msvc": "1.6.7",
+    "@rolldown/binding-android-arm64": "1.0.0-rc.15",
+    "@rolldown/binding-darwin-arm64": "1.0.0-rc.15",
+    "@rolldown/binding-darwin-x64": "1.0.0-rc.15",
+    "@rolldown/binding-freebsd-x64": "1.0.0-rc.15",
+    "@rolldown/binding-linux-arm-gnueabihf": "1.0.0-rc.15",
+    "@rolldown/binding-linux-arm64-gnu": "1.0.0-rc.15",
+    "@rolldown/binding-linux-arm64-musl": "1.0.0-rc.15",
+    "@rolldown/binding-linux-ppc64-gnu": "1.0.0-rc.15",
+    "@rolldown/binding-linux-s390x-gnu": "1.0.0-rc.15",
+    "@rolldown/binding-linux-x64-gnu": "1.0.0-rc.15",
+    "@rolldown/binding-linux-x64-musl": "1.0.0-rc.15",
+    "@rolldown/binding-openharmony-arm64": "1.0.0-rc.15",
+    "@rolldown/binding-wasm32-wasi": "1.0.0-rc.15",
+    "@rolldown/binding-win32-arm64-msvc": "1.0.0-rc.15",
+    "@rolldown/binding-win32-x64-msvc": "1.0.0-rc.15"
   },
   "prettier": {
     "printWidth": 100,
@@ -146,7 +163,10 @@
     ]
   },
   "lint-staged": {
-    "*": "prettier --write"
+    "*": [
+      "eslint --fix",
+      "prettier --write"
+    ]
   },
   "publishConfig": {
     "tag": "18-0"