@odoo/o-spreadsheet 19.2.11 → 19.4.0-alpha.4

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

@@ -0,0 +1,61 @@
+import { ConditionalFormattingOperatorValues } from "../../types/conditional_formatting";
+import { UID } from "../../types/misc";
+import { ExcelWorkbookData, WorkbookData } from "../../types/workbook_data";
+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(data: WorkbookData, content: string | undefined, styleId: number | undefined, formatId: number | undefined, borderId: number | undefined): ExtractedStyle;
+export declare function rotationFromXLSX(deg: number): number;
+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, construct: XLSXStructure): 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,27 @@
+import { Dimension } from "../../types/misc";
+import { ExcelHeaderData, ExcelSheetData } from "../../types/workbook_data";
+/**
+ * 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;
+};
+/**
+ * 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,9 @@
+import { XLSXExportFile, XLSXExportXMLFile, XLSXImportFile, XLSXXmlDocuments } 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,35 @@
+import { ExcelWorkbookData } from "../../types/workbook_data";
+import { XLSXExportXMLFile, XLSXStructure, XMLAttributes, XMLAttributeValue, XMLString } 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 { WorkbookData } from "../types/workbook_data";
+import { ImportedFiles, XLSXImageFile, XLSXImportData, XLSXXmlDocuments } from "../types/xlsx";
+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/workbook_data";
+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,15 +1,15 @@
 {
   "name": "@odoo/o-spreadsheet",
-  "version": "19.2.11",
+  "version": "19.4.0-alpha.4",
   "description": "A spreadsheet component",
   "type": "module",
-  "main": "dist/o-spreadsheet.cjs.js",
-  "browser": "dist/o-spreadsheet.iife.js",
-  "module": "dist/o-spreadsheet.esm.js",
+  "main": "dist/o_spreadsheet.cjs",
+  "browser": "dist/o_spreadsheet.iife.js",
+  "module": "dist/o_spreadsheet.esm.js",
   "types": "dist/types/index.d.ts",
   "files": [
     "dist/*.js",
-    "dist/*.d.ts",
+    "dist/types",
     "dist/*.xml",
     "dist/*.css"
   ],
@@ -24,13 +24,14 @@
     "predev": "node tools/clean_build_files.cjs",
     "dev": "npm-run-all --print-label --parallel build:watch server serve-static:wait",
     "build": "npm-run-all transpile-js bundle:esm bundle:iife \"bundle:xml -- --outDir build\" \"bundle:css -- --out build\"",
-    "build:watch": "npm-run-all --parallel transpile-js:watch bundle:iife:watch bundle:xml:watch bundle:css:watch",
+    "build:watch": "npm-run-all --parallel  type-check:watch bundle:iife:watch bundle:xml:watch bundle:css:watch",
     "transpile-js": "tsc --build --incremental --preserveWatchOutput",
-    "transpile-js:watch": "npm run transpile-js -- --watch",
+    "type-check:watch": "npm run transpile-js -- --watch --noEmit",
+    "perf": "tsc --module es6 --declaration --declarationDir dist/types && rolldown -c --perf",
     "bundle:cjs": "rolldown -c --format cjs",
     "bundle:esm": "rolldown -c --format esm",
     "bundle:iife": "rolldown -c --format iife",
-    "bundle:iife:watch": "wait-on build/js/src/index.js && npm run bundle:iife -- --watch",
+    "bundle:iife:watch": "npm run bundle:iife -- --watch",
     "bundle:xml": "node tools/bundle_xml/main.cjs",
     "bundle:xml:watch": "node tools/bundle_xml/watch_xml_templates.cjs",
     "bundle:css": "node tools/bundle_css/main.cjs",
@@ -74,12 +75,10 @@
     "@types/rbush": "^3.0.3",
     "@typescript-eslint/eslint-plugin": "^8.30.1",
     "babel-eslint": "^10.1.0",
-    "body-parser": "^1.19.0",
     "canvas": "^3.0.0",
     "chart.js": "4.5.0",
     "chartjs-adapter-luxon": "^1.3.1",
     "chartjs-chart-geo": "^4.3.2",
-    "cors": "^2.8.5",
     "express": "^4.17.1",
     "express-form-data": "^2.0.19",
     "express-ws": "^4.0.0",
@@ -94,12 +93,11 @@
     "live-server": "^1.2.1",
     "luxon": "^3.7.2",
     "minimist": "^1.2.8",
-    "mockdate": "^3.0.2",
     "node-watch": "^0.7.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.0",
     "prettier-plugin-organize-imports": "^3.2.2",
-    "rolldown": "^1.0.0-rc.15",
+    "rolldown": "^1.0.0-rc.12",
     "seedrandom": "^3.0.5",
     "typescript": "^6.0.2",
     "typescript-eslint": "^8.30.1",
@@ -151,7 +149,7 @@
       "<rootDir>/tests"
     ],
     "transform": {
-      "^.+\\.ts?$": [
+      "^.+\\.(ts|js)?$": [
         "@swc/jest"
       ]
     },
@@ -167,6 +165,9 @@
       "node"
     ],
     "workerIdleMemoryLimit": "800MB",
+    "transformIgnorePatterns": [
+      "/node_modules/(?!chartjs-adapter-luxon)"
+    ],
     "globalSetup": "<rootDir>/tests/setup/jest_global_setup.ts",
     "globalTeardown": "<rootDir>/tests/setup/jest_global_teardown.ts",
     "setupFilesAfterEnv": [
@@ -180,6 +181,6 @@
     ]
   },
   "publishConfig": {
-    "tag": "19-2"
+    "tag": "alpha"
   }
 }