@ricsam/excel-to-formula-engine 0.2.0 → 0.2.2

package/README.md

@@ -150,6 +150,29 @@ await excelToFormulaEngine(file, {
 | Number formats, hyperlinks | Cell metadata | Stored for your UI; the engine does not interpret them. |
 | Merges, frozen panes, column widths, hidden sheets | Sheet metadata | Same — stored for your UI to apply. |
 
+### Effective cell fonts
+
+Existing worksheet cells resolve their formatting in this order: explicit cell
+`s` (including `s="0"`), row `s` when `customFormat` is enabled, column `style`,
+then workbook cell XF 0. Column ranges remain sparse, including full-sheet
+ranges. Named-style font inheritance (`cellStyleXfs` / `xfId`) is resolved;
+`applyFont="0"` selects the base font, while an explicit applied font replaces
+it as a unit. Supported font decorations include explicit false values so a
+plain font can clear inherited bold, italic, or underline.
+
+The resolved XF 0 is also retained as `workbookMetadata.defaultCellStyle`
+(engine units: font sizes are pixels). This is additive metadata for clients;
+actual imported cells receive coalesced direct styles without requiring a new
+engine API. `styles:false` disables both. Empty coordinates not present in the
+worksheet are not materialized. Older imported snapshots do not retain XF 0
+and cannot reconstruct it losslessly from neighboring styles.
+
+Literal Excel font names are retained as `fontFamily` (clients must provide
+those fonts). This is not full Excel rendering fidelity: theme font substitution,
+table style themes, rich-text runs, and named-style inheritance of non-font
+properties are not translated by this change. Double/accounting underline
+variants become a single boolean underline.
+
 ### Formulas the engine cannot evaluate
 
 The engine implements around 40 functions. A formula using anything else — an

package/dist/index.cjs

@@ -280,6 +280,11 @@ function parseWorksheet(pkg, partPath, sharedStrings) {
 function parseCells(worksheet, sharedStrings, result) {
   const sheetData = worksheet["sheetData"];
   const shared = new Map;
+  const columnStyles = asArray(worksheet["cols"]?.["col"]).map((col) => ({
+    min: numAttr(col, "min"),
+    max: numAttr(col, "max"),
+    style: numAttr(col, "style")
+  })).filter((col) => col.min !== undefined && col.max !== undefined && col.style !== undefined);
   for (const rawRow of asArray(sheetData?.["row"])) {
     const row = rawRow;
     const rowNumber = numAttr(row, "r");
@@ -297,11 +302,14 @@ function parseCells(worksheet, sharedStrings, result) {
       if (!address) {
         continue;
       }
-      const styleIndex = numAttr(cell, "s");
+      const explicitStyle = numAttr(cell, "s");
+      const rowStyle = boolAttr(row, "customFormat") ? numAttr(row, "s") : undefined;
+      const columnStyle = columnStyles.findLast((col) => address.colIndex + 1 >= col.min && address.colIndex + 1 <= col.max)?.style;
+      const styleIndex = explicitStyle ?? rowStyle ?? columnStyle ?? 0;
       const type = attr(cell, "t") ?? "n";
       const formula = readFormula(cell, address, shared);
       const { kind, value } = readValue(cell, type, sharedStrings);
-      if (kind === "empty" && formula === undefined && styleIndex === undefined) {
+      if (kind === "empty" && formula === undefined && explicitStyle === undefined && rowStyle === undefined && columnStyle === undefined) {
         continue;
       }
       result.cells.push({
@@ -691,14 +699,19 @@ function parseStyles(pkg) {
   const fills = asArray(styleSheet["fills"]?.["fill"]);
   const borders = asArray(styleSheet["borders"]?.["border"]);
   const cellXfs = asArray(styleSheet["cellXfs"]?.["xf"]);
+  const styleXfs = asArray(styleSheet["cellStyleXfs"]?.["xf"]);
   const formats = cellXfs.map((rawXf) => {
     const xf = rawXf;
     const style = {};
-    if (boolAttr(xf, "applyFont", true)) {
-      const font = fonts[numAttr(xf, "fontId") ?? -1];
-      if (font) {
-        applyFont(style, font, theme, indexedColors);
-      }
+    const baseXf = styleXfs[numAttr(xf, "xfId") ?? -1];
+    const baseFontId = boolAttr(baseXf, "applyFont", true) ? numAttr(baseXf, "fontId") ?? 0 : 0;
+    const fontId = boolAttr(xf, "applyFont", true) ? numAttr(xf, "fontId") ?? baseFontId : baseFontId;
+    const font = fonts[fontId];
+    if (font) {
+      style.bold = false;
+      style.italic = false;
+      style.underline = false;
+      applyFont(style, font, theme, indexedColors);
     }
     if (boolAttr(xf, "applyFill", true)) {
       const fill = fills[numAttr(xf, "fillId") ?? -1];
@@ -743,14 +756,18 @@ function parseStyles(pkg) {
   return { formats, differentialFormats };
 }
 function applyFont(style, font, theme, indexedColors) {
-  if (font["b"] !== undefined && isOn(font["b"])) {
-    style.bold = true;
+  const fontFamily = attr(font["name"], "val");
+  if (fontFamily) {
+    style.fontFamily = fontFamily;
+  }
+  if (font["b"] !== undefined) {
+    style.bold = isOn(font["b"]);
   }
-  if (font["i"] !== undefined && isOn(font["i"])) {
-    style.italic = true;
+  if (font["i"] !== undefined) {
+    style.italic = isOn(font["i"]);
   }
-  if (font["u"] !== undefined && isOn(font["u"])) {
-    style.underline = true;
+  if (font["u"] !== undefined) {
+    style.underline = attr(font["u"], "val") !== "none";
   }
   const size = numAttr(font["sz"], "val");
   if (size !== undefined) {
@@ -1441,6 +1458,7 @@ async function convertWorkbook(source, options = {}) {
     cellStyles: cellStyles.length > 0 ? cellStyles : undefined,
     conditionalStyles: conditionalStyles.length > 0 ? conditionalStyles : undefined,
     workbookMetadata: {
+      defaultCellStyle: importStyles ? styleTable.formats[0]?.style : undefined,
       fileName: options.fileName,
       sheetOrder: sheetEntries.map((entry) => entry.name),
       diagnostics: diagnostics.length > 0 ? diagnostics : undefined
@@ -1862,11 +1880,22 @@ async function spreadsheetToFormulaEngine(source, options) {
 }
 async function spreadsheetToFormulaEngineDetailed(source, options) {
   const bytes = await toBytes2(source);
+  const fileName = options?.fileName ?? (typeof File !== "undefined" && source instanceof File ? source.name : undefined);
   if (looksLikeZip(bytes)) {
     return convertWorkbook(bytes, withFileName(source, options));
   }
+  if (fileName && /\.(xlsx|xlsm)$/i.test(fileName)) {
+    throw new Error(`${fileName} is named as an Excel workbook but is not one — the file is ` + `corrupt, or it is a legacy .xls saved under the wrong extension.`);
+  }
+  assertLooksLikeText(bytes, fileName);
   return csvToFormulaEngineDetailed(bytes, withCsvFileName(source, options));
 }
+function assertLooksLikeText(bytes, fileName) {
+  const sample = bytes.subarray(0, 8192);
+  if (sample.indexOf(0) !== -1) {
+    throw new Error(`${fileName ?? "The file"} is not a spreadsheet: it contains binary data ` + `rather than delimited text.`);
+  }
+}
 function looksLikeZip(bytes) {
   return bytes.length >= 4 && bytes[0] === 80 && bytes[1] === 75 && bytes[2] === 3 && bytes[3] === 4;
 }
@@ -1889,4 +1918,4 @@ function withCsvFileName(source, options) {
   };
 }
 
-//# debugId=E62FBA8DCEBAE6FE64756E2164756E21
+//# debugId=361575F73A84A17764756E2164756E21