style-xlsx-m 0.1.34 → 0.1.35

package/README.md

@@ -2,6 +2,8 @@
 
 Read and write `.xlsx` files with selected cell styles in Node.js or bundled browser code, and set page setup for printing.
 
+![style-xlsx-m: read a styled Excel template, edit its data, and save it with supported formatting kept](docs/images/style-xlsx-m-cover.png)
+
 Based on [SheetJS Community Edition](https://github.com/SheetJS/sheetjs) (`xlsx` 0.18.5) and [xlsx-js-style](https://github.com/gitbrent/xlsx-js-style).
 
 > **Security note:** this package is built on SheetJS 0.18.5, which has known vulnerabilities fixed upstream in later versions (prototype pollution, CVE-2023-30533, and ReDoS, CVE-2024-22363). **Do not use it to parse untrusted files.** `npm audit` will not flag this, because the SheetJS code is bundled into the package rather than installed as a dependency.
@@ -52,6 +54,10 @@ For everything else (`utils`, `read` options, other formats) see the [SheetJS do
 
 Pass `{ cellStyles: true }` to `readFile` (or `read`). Styled cells expose an `s` object for the writer. The independent openpyxl fixture confirms RGB solid fills, a theme-4 fill with tint, RGB/theme borders, font name/size/colour, bold/italic/single underline, and alignment. Number/date formats, merges, column widths, row heights, and A4 landscape page setup with scale 91 also survive that fixture. This is a partial round trip; see the limitations below.
 
+![Synthetic sales report before and after editing: Product A units change from 100 to 120, revenue from 1,250.00 to 1,500.00, and total revenue from 6,100.00 to 6,350.00, with the same cell formatting](docs/images/template-before-after.png)
+
+The images are real LibreOffice renders of `.xlsx` files created with a locally packed build of this package. Blue outlines mark the three changed values. An independent openpyxl check confirmed that fonts, fills, borders and number formats stayed unchanged in this example.
+
 ```js
 const XLSX = require('style-xlsx-m');
 
@@ -74,7 +80,24 @@ Note: `styles[r]` lists the cells that `sheet_to_json` visits in that row, in or
 
 Reading styles works for `.xlsx` only, not `.xls`.
 
-The `main` and `module` entries use the same style-reading build. In bundled browser code, use `import XLSX from 'style-xlsx-m'` and `XLSX.read(bytes, { type: 'array', cellStyles: true })` with a `Uint8Array` or `ArrayBuffer`. `readFile` requires the Node.js filesystem. Importing, editing and saving a styled template is tested with webpack for browser and Node.js targets.
+The `main` and `module` entries use the same style-reading build. In bundled browser code, use `import XLSX from 'style-xlsx-m'` and `XLSX.read(bytes, { type: 'array', cellStyles: true })` with a `Uint8Array` or `ArrayBuffer`. `readFile` requires the Node.js filesystem. Importing, editing and saving a styled template is tested with webpack for browser and Node.js targets. The corrected local build is also tested in React with Vite in development and production and real Chrome downloads; these corrections have not yet been published to npm.
+
+```js
+import XLSX from 'style-xlsx-m';
+
+async function editTemplateInBrowser() {
+  const response = await fetch('/Book1.xlsx');
+  if (!response.ok) throw new Error(`Template request failed: ${response.status}`);
+  const bytes = await response.arrayBuffer();
+  const wb = XLSX.read(bytes, { type: 'array', cellStyles: true, cellNF: true });
+  const ws = wb.Sheets[wb.SheetNames[0]];
+  ws.B3.v = 'Edited in React';
+  delete ws.B3.w; // discard the cached display text
+  XLSX.writeFile(wb, 'Book1-edited.xlsx');
+}
+```
+
+Call this function from a React button handler. Edit existing cell objects to keep their `s` style; recreating the sheet from values discards those styles. The parser and styled writer are shared with Node.js. Styled blank cells remain blank, and font `family`/`scheme` and theme-index-0 solid fills survive the tested local round trips.
 
 ## Cell styles reference
 
@@ -106,6 +129,8 @@ const style = {
   font: {
     name: 'Calibri',
     sz: 11,                  // points
+    family: 2,
+    scheme: 'minor',
     color: COLOR,
     bold: false,
     italic: false,
@@ -141,14 +166,15 @@ When a file is **read**, `ws['!pageSetup']` is the raw `<pageSetup .../>` XML ta
 
 - Based on SheetJS 0.18.5 (see the security note above). Do not parse untrusted files.
 - Cell styles are read from `.xlsx` only, not `.xls`.
-- Reading is a partial round trip. A theme-4 solid fill with tint is preserved, but a theme-index-0 fill loses its colour. Its `s.fill.fgColor` contains `{ theme: 0 }`; the bundled upstream writer drops that colour.
+- Reading is a partial round trip. RGB and theme-4 solid fills with tint and a theme-index-0 fill are preserved in the tested local fixtures. These fixes are not yet in the published npm version 0.1.34.
+- Excel Table objects and their table styles (for example, Table1 with striped rows in Book1.xlsx) are not preserved. This limitation applies in both Node.js and browsers; table styles are not cell `s` styles.
 - An empty sheet returns `[]` even when `getCellStyles: true` is requested.
 - Indexed border colours are exposed and saved as RGB. The tested indexed red keeps its RGB colour, but loses the indexed palette reference. Theme border colours keep their theme and tint. Custom theme palettes have not been tested.
 - Single underline is confirmed. Other underline variants, gradient fills, conditional formatting, and diagonal border reading are not verified. Do not assume they are preserved.
 - Number formats are preserved in the tested numeric and date cells, but are not part of `s`; use `cellNF: true` to expose them in `cell.z`. Merges, column widths and row heights are worksheet metadata (`!merges`, `!cols`, `!rows`), not cell styles.
 - `!pageSetup` is returned as a raw XML string on read. The original A4/landscape/scale tag is preserved on save. To change it, assign the object shown above with string values. Numeric object values and other print settings are not verified.
 - The TypeScript definitions are inherited from SheetJS with a `getCellStyles` option added. `s` and `!pageSetup` are not fully typed, and the `sheet_to_json` return types do not describe `{ out, styles }`.
-- The `main` and `module` entries share the tested style reader. The separate CDN entries (`unpkg` and `jsdelivr`) remain upstream SheetJS builds and do not provide the same style-reading guarantees. Full Vite and Next.js applications have not been tested.
+- The `main` and `module` entries share the tested style reader. The separate CDN entries (`unpkg` and `jsdelivr`) remain upstream SheetJS builds and do not provide the same style-reading guarantees. The corrected local build is tested in React/Vite; Next.js applications have not been tested.
 - Only these synchronous write functions are delegated to xlsx-js-style: `write`, `writeFile`, `writeFileSync`, `writeXLSX`, `writeFileXLSX`. `writeFileAsync` uses the inherited SheetJS writer and is outside these style guarantees.
 
 ## Credits & License
@@ -161,4 +187,4 @@ Changes in this fork (by Shahrom Shukurov):
 - Page setup for printing (paper size, orientation, scale)
 
 This project is not affiliated with or endorsed by SheetJS LLC.
-Licensed under the Apache License 2.0. See [LICENSE](https://github.com/MOR8T/style-xlsx-m/blob/main/LICENSE) and [NOTICE](https://github.com/MOR8T/style-xlsx-m/blob/main/NOTICE).
+Licensed under the Apache License 2.0. See [LICENSE](https://github.com/MOR8T/style-xlsx-m/blob/main/LICENSE) and [NOTICE](https://github.com/MOR8T/style-xlsx-m/blob/main/NOTICE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "style-xlsx-m",
-  "version": "0.1.34",
+  "version": "0.1.35",
   "author": "Shahrom Shukurov",
   "description": "Fork of SheetJS (xlsx 0.18.5) and xlsx-js-style: read .xlsx files with cell styles, write styled cells, and set page setup for printing.",
   "keywords": [

package/xlsx-js-style/dist/xlsx.bundle.js

@@ -14427,8 +14427,8 @@ function make_xlsx_lib(a) {
             (r = (function (e, t, r, a) {
               if (
                 (e.c && r["!comments"].push([t, e.c]),
-                (void 0 === e.v && "string" != typeof e.f) ||
-                  ("z" === e.t && !e.f))
+                ((void 0 === e.v && "string" != typeof e.f) ||
+                  ("z" === e.t && !e.f)) && !e.s)
               )
                 return "";
               var n = "",
@@ -14458,6 +14458,8 @@ function make_xlsx_lib(a) {
               var o = $t("v", kt(n)),
                 c = { r: t },
                 l = el(a.cellXfs, e, a);
+              if (("z" === e.t && !e.f) || (null == e.v && "string" != typeof e.f))
+                o = "";
               switch ((0 !== l && (c.s = l), e.t)) {
                 case "n":
                   break;
@@ -26277,7 +26279,15 @@ function make_xlsx_lib(a) {
         });
       return (
         (a.prototype.escapeAttributeValue = function (e) {
-          return '"' + e.replace(/\"/g, """) + '"';
+          return (
+            '"' +
+            e
+              .replace(/&(?!(?:amp|lt|gt|quot|apos|#[0-9]+|#x[0-9a-fA-F]+);)/g, "&")
+              .replace(/</g, "&lt;")
+              .replace(/>/g, "&gt;")
+              .replace(/\"/g, "&quot;") +
+            '"'
+          );
         }),
         (a.prototype.toXml = function (e) {
           // in this function make style tag
@@ -26457,12 +26467,15 @@ function make_xlsx_lib(a) {
         },
         _addFont: function (e) {
           if (!e) return 0;
+          var fontColor;
           var t = vu("font")
             .append(vu("sz").attr("val", e.sz || this.defaultStyle.font.sz))
             .append(
               vu("name").attr("val", e.name || this.defaultStyle.font.name)
             );
           e.bold && t.append(vu("b")),
+            e.family != null && t.append(vu("family").attr("val", e.family)),
+            e.scheme != null && t.append(vu("scheme").attr("val", e.scheme)),
             e.underline && t.append(vu("u")),
             e.italic && t.append(vu("i")),
             e.strike && t.append(vu("strike")),
@@ -26470,12 +26483,12 @@ function make_xlsx_lib(a) {
             e.shadow && t.append(vu("shadow")),
             e.vertAlign && t.append(vu("vertAlign").attr("val", e.vertAlign)),
             e.color &&
-              (e.color.theme
-                ? (t.append(vu("color").attr("theme", e.color.theme)),
-                  e.color.tint &&
-                    t.append(vu("tint").attr("theme", e.color.tint)))
+              (e.color.theme != null
+                ? (fontColor = vu("color").attr("theme", e.color.theme),
+                   e.color.tint != null && fontColor.attr("tint", e.color.tint),
+                   t.append(fontColor))
                 : e.color.rgb &&
-                  t.append(vu("color").attr("rgb", e.color.rgb))),
+                  t.append(vu("color").attr("rgb", e.color.rgb.length === 6 ? "FF" + e.color.rgb : e.color.rgb))),
             this.$fonts.append(t);
           t = this.$fonts.children().length;
           return this.$fonts.attr("count", t), t - 1;
@@ -26499,7 +26512,7 @@ function make_xlsx_lib(a) {
           return this.$numFmts.attr("count", e), r;
         },
         _addFill: function (e) {
-          if (!e) return 0;
+          if (!e || (!e.patternType && !e.fgColor && !e.bgColor)) return 0;
           var t,
             r = vu("patternFill").attr("patternType", e.patternType || "solid");
           e.fgColor &&
@@ -26509,7 +26522,7 @@ function make_xlsx_lib(a) {
                   (e.fgColor.rgb = "FF" + e.fgColor.rgb),
                 t.attr("rgb", e.fgColor.rgb),
                 r.append(t))
-              : e.fgColor.theme &&
+              : e.fgColor.theme != null &&
                 (t.attr("theme", e.fgColor.theme),
                 e.fgColor.tint && t.attr("tint", e.fgColor.tint),
                 r.append(t)),
@@ -26530,7 +26543,7 @@ function make_xlsx_lib(a) {
                 t.color.auto
                   ? e.attr("auto", t.color.auto)
                   : t.color.rgb
-                  ? e.attr("rgb", t.color.rgb)
+                  ? e.attr("rgb", t.color.rgb.length === 6 ? "FF" + t.color.rgb : t.color.rgb)
                   : (t.color.theme || t.color.tint) &&
                     (e.attr("theme", t.color.theme || "1"),
                     e.attr("tint", t.color.tint || "0")),

package/xlsx-js-style/dist/xlsx.min.js

@@ -14427,8 +14427,8 @@ function make_xlsx_lib(a) {
             (r = (function (e, t, r, a) {
               if (
                 (e.c && r["!comments"].push([t, e.c]),
-                (void 0 === e.v && "string" != typeof e.f) ||
-                  ("z" === e.t && !e.f))
+                ((void 0 === e.v && "string" != typeof e.f) ||
+                  ("z" === e.t && !e.f)) && !e.s)
               )
                 return "";
               var n = "",
@@ -14458,6 +14458,8 @@ function make_xlsx_lib(a) {
               var o = $t("v", kt(n)),
                 c = { r: t },
                 l = el(a.cellXfs, e, a);
+              if (("z" === e.t && !e.f) || (null == e.v && "string" != typeof e.f))
+                o = "";
               switch ((0 !== l && (c.s = l), e.t)) {
                 case "n":
                   break;
@@ -26277,7 +26279,15 @@ function make_xlsx_lib(a) {
         });
       return (
         (a.prototype.escapeAttributeValue = function (e) {
-          return '"' + e.replace(/\"/g, """) + '"';
+          return (
+            '"' +
+            e
+              .replace(/&(?!(?:amp|lt|gt|quot|apos|#[0-9]+|#x[0-9a-fA-F]+);)/g, "&")
+              .replace(/</g, "&lt;")
+              .replace(/>/g, "&gt;")
+              .replace(/\"/g, "&quot;") +
+            '"'
+          );
         }),
         (a.prototype.toXml = function (e) {
           // in this function make style tag
@@ -26457,12 +26467,15 @@ function make_xlsx_lib(a) {
         },
         _addFont: function (e) {
           if (!e) return 0;
+          var fontColor;
           var t = vu("font")
             .append(vu("sz").attr("val", e.sz || this.defaultStyle.font.sz))
             .append(
               vu("name").attr("val", e.name || this.defaultStyle.font.name)
             );
           e.bold && t.append(vu("b")),
+            e.family != null && t.append(vu("family").attr("val", e.family)),
+            e.scheme != null && t.append(vu("scheme").attr("val", e.scheme)),
             e.underline && t.append(vu("u")),
             e.italic && t.append(vu("i")),
             e.strike && t.append(vu("strike")),
@@ -26470,12 +26483,12 @@ function make_xlsx_lib(a) {
             e.shadow && t.append(vu("shadow")),
             e.vertAlign && t.append(vu("vertAlign").attr("val", e.vertAlign)),
             e.color &&
-              (e.color.theme
-                ? (t.append(vu("color").attr("theme", e.color.theme)),
-                  e.color.tint &&
-                    t.append(vu("tint").attr("theme", e.color.tint)))
+              (e.color.theme != null
+                ? (fontColor = vu("color").attr("theme", e.color.theme),
+                   e.color.tint != null && fontColor.attr("tint", e.color.tint),
+                   t.append(fontColor))
                 : e.color.rgb &&
-                  t.append(vu("color").attr("rgb", e.color.rgb))),
+                  t.append(vu("color").attr("rgb", e.color.rgb.length === 6 ? "FF" + e.color.rgb : e.color.rgb))),
             this.$fonts.append(t);
           t = this.$fonts.children().length;
           return this.$fonts.attr("count", t), t - 1;
@@ -26499,7 +26512,7 @@ function make_xlsx_lib(a) {
           return this.$numFmts.attr("count", e), r;
         },
         _addFill: function (e) {
-          if (!e) return 0;
+          if (!e || (!e.patternType && !e.fgColor && !e.bgColor)) return 0;
           var t,
             r = vu("patternFill").attr("patternType", e.patternType || "solid");
           e.fgColor &&
@@ -26509,7 +26522,7 @@ function make_xlsx_lib(a) {
                   (e.fgColor.rgb = "FF" + e.fgColor.rgb),
                 t.attr("rgb", e.fgColor.rgb),
                 r.append(t))
-              : e.fgColor.theme &&
+              : e.fgColor.theme != null &&
                 (t.attr("theme", e.fgColor.theme),
                 e.fgColor.tint && t.attr("tint", e.fgColor.tint),
                 r.append(t)),
@@ -26530,7 +26543,7 @@ function make_xlsx_lib(a) {
                 t.color.auto
                   ? e.attr("auto", t.color.auto)
                   : t.color.rgb
-                  ? e.attr("rgb", t.color.rgb)
+                  ? e.attr("rgb", t.color.rgb.length === 6 ? "FF" + t.color.rgb : t.color.rgb)
                   : (t.color.theme || t.color.tint) &&
                     (e.attr("theme", t.color.theme || "1"),
                     e.attr("tint", t.color.tint || "0")),

package/xlsx.js

@@ -14542,15 +14542,11 @@ function safe_format(p, fmtid, fillid, opts, themes, styles, fontid, borderid,cf
         if (p.s.bold) p.s.font = { ...p.s.font, bold: p.s.bold ? true : false, };
         if (p.s.italic) p.s.font = { ...p.s.font, italic: p.s.italic ? true : false, };
         if (p.s.name) p.s.font = { ...p.s.font, name: p.s.name, };
+        if (p.s.family != null) p.s.font = { ...p.s.font, family: p.s.family };
+        if (p.s.scheme != null) p.s.font = { ...p.s.font, scheme: p.s.scheme };
 	}
 	if(borderid != null) p.s.border = styles.Borders[borderid]
 	if(cf != null && cf?.alignment) p.s = {...p.s, alignment:cf.alignment}
-	if(p.s && p.t == 'z'){
-		p.t = 's';
-		// p.z = 'General'
-		p.v = ' '
-		p.w = ' '
-	}
 	// console.log('p style',p)
 }
 
@@ -14591,10 +14587,6 @@ var drawingregex = /(<(?:\w:)?drawing[^>]*\/>)|(<(?:\w+:)?drawing[^>]*>([\s\S]*)
 var legacyDrawingregex = /(<(?:\w:)?legacyDrawing[^>]*\/>)|(<(?:\w+:)?legacyDrawing[^>]*>([\s\S]*)<\/(?:\w+:)?legacyDrawing>)/g;
 
 
-paperSize="9"
-        scale="91"
-        fitToWidth="0"
-
 /* 18.3 Worksheets */
 function parse_ws_xml(data, opts, idx, rels, wb, themes, styles) {
 	// console.log('parse_ws_xml')