style-xlsx-m 0.1.31 → 0.1.34

package/NOTICE

@@ -1,5 +1,5 @@
 style-xlsx-m
-Copyright 2022-present Shukurov Shahrom
+Copyright 2022-present Shahrom Shukurov
 
 This product is a derivative work and includes software developed by others:
 
@@ -8,16 +8,16 @@ This product is a derivative work and includes software developed by others:
    https://github.com/SheetJS/sheetjs
    Licensed under the Apache License, Version 2.0.
 
-2. xlsx-js-style
+2. xlsx-js-style 1.2.0
    https://github.com/gitbrent/xlsx-js-style
    A fork of SheetJS Community Edition that adds cell styling on write.
    Licensed under the Apache License, Version 2.0.
    Its compiled output is bundled in ./xlsx-js-style/ and is used by this
    package for XLSX.write / XLSX.writeFile.
 
-Changes made in style-xlsx-m (by Shukurov Shahrom):
-- XLSX.read / XLSX.readFile with { cellStyles: true } keep cell styles
-  (xlsx format only), so a file can be edited and saved without losing them.
+Changes made in style-xlsx-m (by Shahrom Shukurov):
+- XLSX.read / XLSX.readFile with { cellStyles: true } expose selected cell styles
+  (xlsx format only), with round-trip limitations documented in README.md.
 - XLSX.utils.sheet_to_json accepts { getCellStyles: true } and returns
   { out, styles }.
 - Worksheet page setup (paperSize, scale, fitToWidth, orientation) is read
@@ -25,9 +25,21 @@ Changes made in style-xlsx-m (by Shukurov Shahrom):
 - XLSX.write / writeFile / writeFileSync / writeXLSX / writeFileXLSX are
   delegated to the bundled xlsx-js-style build.
 
-Modified source files carry a "Modified by Shukurov Shahrom" notice. The
+Modified source files carry a "Modified by Shahrom Shukurov" notice. The
 original copyright headers have been kept.
 
 This project is not affiliated with or endorsed by SheetJS LLC.
 "SheetJS" is a trademark of its owner and is used here only to describe the
 origin of the code.
+
+Neither upstream npm tarball (xlsx 0.18.5, xlsx-js-style 1.2.0) ships a NOTICE
+file. Their Apache 2.0 LICENSE texts and distributed copyright headers remain
+intact. Bundled codepage and adler-32 notices, and the vendored commander
+license, are also retained in third-party-licenses/. External npm dependencies
+retain their own license files when installed.
+
+Additional locally modified sources: xlsx.mjs, types/index.d.ts,
+dist/xlsx.core.min.js, dist/xlsx.mini.min.js, dist/xlsx.extendscript.js,
+xlsx-js-style/dist/xlsx.min.js, xlsx-js-style/dist/xlsx.bundle.js,
+xlsx-js-style/dist/shim.min.js, xlsx-js-style/types/index.d.ts. These include
+legacy source builds that are not shipped in the release tarball.

package/README.md

@@ -1,6 +1,6 @@
 # style-xlsx-m
 
-Read and write `.xlsx` files in Node.js with cell styles kept, and set page setup for printing.
+Read and write `.xlsx` files with selected cell styles in Node.js or bundled browser code, and set page setup for printing.
 
 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).
 
@@ -11,11 +11,11 @@ Based on [SheetJS Community Edition](https://github.com/SheetJS/sheetjs) (`xlsx`
 | | SheetJS (npm `xlsx`) | xlsx-js-style | style-xlsx-m |
 | :-- | :-- | :-- | :-- |
 | Write cell styles | no | yes | yes |
-| Read cell styles from an existing `.xlsx` | no | no | yes (`cellStyles: true`) |
+| Read styles ready for styled writing | fill metadata only | fill metadata only | selected styles (`cellStyles: true`; see limitations) |
 | `sheet_to_json` returns styles | no | no | yes (`getCellStyles: true`) |
 | Page setup (`!pageSetup`) | no | no | yes |
 
-The use case is editing an existing styled Excel template: read it, change the data, and save it without losing the formatting.
+The use case is editing a tested Excel template: read it, change the data, and save it with the supported formatting. Test your own templates before relying on a round trip.
 
 ## Installation
 
@@ -50,7 +50,7 @@ For everything else (`utils`, `read` options, other formats) see the [SheetJS do
 
 ## Reading a file with styles
 
-Pass `{ cellStyles: true }` to `readFile` (or `read`). Each cell then has an `s` property. Edit values, save with `writeFile`, and the styles are written back.
+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.
 
 ```js
 const XLSX = require('style-xlsx-m');
@@ -58,7 +58,7 @@ const XLSX = require('style-xlsx-m');
 const wb = XLSX.readFile('./demo.xlsx', { cellStyles: true });
 const ws = wb.Sheets['demo'];
 
-ws.A1.v = 'changed'; // value changes, style stays
+ws.A1.v = 'changed'; // change the value; supported styles are written back
 XLSX.writeFile(wb, 'demo-edited.xlsx');
 ```
 
@@ -67,16 +67,18 @@ Styles are also available per row from `sheet_to_json`:
 ```js
 const { out, styles } = XLSX.utils.sheet_to_json(ws, { header: 1, getCellStyles: true });
 // out[r][c]    -> cell value
-// styles[r][c] -> style object of that cell ({} if the cell has no style)
+// styles[r][i] -> style of the i-th visited cell ({} without a style)
 ```
 
 Note: `styles[r]` lists the cells that `sheet_to_json` visits in that row, in order. It can be shorter than the sheet's width.
 
 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.
+
 ## Cell styles reference
 
-A cell is `{ v: value, t: type, s: style }`. The supported style properties are `alignment`, `border`, `fill` and `font`.
+A cell is `{ v: value, t: type, s: style }`. The example below writes `alignment`, `border`, `fill` and `font`. Set the cell's `z` property for a number format.
 
 ```js
 const COLOR = { rgb: 'FF0000' };          // hex value, no leading "#"
@@ -97,7 +99,9 @@ const style = {
     bottom: border,
     left: border,
     right: border,
-    diagonal: { style: 'thin', color: COLOR, diagonalUp: false, diagonalDown: true },
+    diagonal: { style: 'thin', color: COLOR },
+    diagonalUp: false,
+    diagonalDown: true,
   },
   font: {
     name: 'Calibri',
@@ -137,19 +141,24 @@ 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 not a full round trip. In testing, a solid cell fill and border colours written to a file did not come back in the cell's `s` object after `readFile`. Check your own templates and test before relying on this.
-- `!pageSetup` is returned as a raw XML string on read (see above).
-- The TypeScript definitions are inherited from SheetJS with a `getCellStyles` option added. The `s` style property and `!pageSetup` are not fully typed.
-- Only the write functions come from xlsx-js-style: `write`, `writeFile`, `writeFileSync`, `writeXLSX`, `writeFileXLSX`.
+- 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.
+- 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.
+- 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
 
 This package is a fork of [SheetJS Community Edition](https://github.com/SheetJS/sheetjs) and includes code from [xlsx-js-style](https://github.com/gitbrent/xlsx-js-style). Both are licensed under the Apache License 2.0.
 
-Changes in this fork (by Shukurov Shahrom):
-- Reading existing `.xlsx` files with cell styles preserved (`cellStyles: true`)
+Changes in this fork (by Shahrom Shukurov):
+- Reading selected cell styles from existing `.xlsx` files (`cellStyles: true`)
 - `getCellStyles` option for `sheet_to_json`
 - 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](LICENSE) and [NOTICE](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,110 +1,118 @@
 {
-	"name": "style-xlsx-m",
-	"version": "0.1.31",
-	"author": "Shukurov Shahrom <hp.sh.shahrom@gmail.com> (https://github.com/MOR8T)",
-	"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": [
-		"excel",
-		"xls",
-		"xlsx",
-		"xlsm",
-		"xlsb",
-		"ods",
-		"csv",
-		"dbf",
-		"dif",
-		"sylk",
-		"office",
-		"spreadsheet",
-		"style",
-		"print",
-		"format",
-		"workbook",
-		"worksheet",
-		"styles",
-		"export",
-		"sheetjs",
-		"xlsx-js-style"
-	],
-	"bin": {
-		"xlsx": "./bin/xlsx.njs"
-	},
-	"main": "xlsx.js",
-	"module": "./xlsx-js-style/dist/xlsx.bundle.js",
-	"unpkg": "dist/xlsx.full.min.js",
-	"jsdelivr": "dist/xlsx.full.min.js",
-	"types": "types/index.d.ts",
-	"browser": {
-		"buffer": false,
-		"crypto": false,
-		"stream": false,
-		"process": false,
-		"fs": false
-	},
-	"sideEffects": false,
-	"dependencies": {
-		"adler-32": "~1.3.0",
-		"cfb": "~1.2.1",
-		"codepage": "~1.15.0",
-		"crc-32": "~1.2.1",
-		"ssf": "~0.11.2",
-		"wmf": "~1.0.1",
-		"word": "~0.3.0"
-	},
-	"devDependencies": {
-		"@sheetjs/uglify-js": "~2.7.3",
-		"@types/node": "^8.5.9",
-		"acorn": "7.4.1",
-		"alex": "8.1.1",
-		"blanket": "~1.2.3",
-		"commander": "~2.17.1",
-		"dtslint": "^0.1.2",
-		"eslint": "7.23.0",
-		"eslint-plugin-html": "^6.1.2",
-		"eslint-plugin-json": "^2.1.2",
-		"exit-on-epipe": "~1.0.1",
-		"fflate": "^0.7.1",
-		"jsdom": "~11.1.0",
-		"markdown-spellcheck": "^1.3.1",
-		"mocha": "~2.5.3",
-		"sinon": "^1.17.7",
-		"typescript": "2.2.0"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/MOR8T/STYLE-XSLX-M.git"
-	},
-	"scripts": {
-		"pretest": "npm run lint",
-		"test": "npm run tests-only",
-		"pretest-only": "git submodule init && git submodule update",
-		"tests-only": "make travis",
-		"build": "make",
-		"lint": "make fullint",
-		"dtslint": "dtslint types"
-	},
-	"config": {
-		"blanket": {
-			"pattern": "xlsx.js"
-		}
-	},
-	"alex": {
-		"allow": [
-			"chinese",
-			"special",
-			"simple",
-			"just",
-			"crash",
-			"wtf",
-			"holes"
-		]
-	},
-	"homepage": "https://github.com/MOR8T/STYLE-XSLX-M#readme",
-	"bugs": {
-		"url": "https://github.com/MOR8T/STYLE-XSLX-M/issues"
-	},
-	"license": "Apache-2.0",
-	"engines": {
-		"node": ">=0.8"
-	}
+  "name": "style-xlsx-m",
+  "version": "0.1.34",
+  "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": [
+    "excel",
+    "xls",
+    "xlsx",
+    "xlsm",
+    "xlsb",
+    "ods",
+    "csv",
+    "dbf",
+    "dif",
+    "sylk",
+    "office",
+    "spreadsheet",
+    "style",
+    "print",
+    "format",
+    "workbook",
+    "worksheet",
+    "styles",
+    "export",
+    "sheetjs",
+    "xlsx-js-style",
+    "page-setup"
+  ],
+  "main": "xlsx.js",
+  "module": "./xlsx.js",
+  "unpkg": "dist/xlsx.full.min.js",
+  "jsdelivr": "dist/xlsx.full.min.js",
+  "types": "types/index.d.ts",
+  "browser": {
+    "buffer": false,
+    "crypto": false,
+    "stream": false,
+    "process": false,
+    "fs": false
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "adler-32": "~1.3.0",
+    "cfb": "~1.2.1",
+    "codepage": "~1.15.0",
+    "crc-32": "~1.2.1",
+    "ssf": "~0.11.2",
+    "wmf": "~1.0.1",
+    "word": "~0.3.0"
+  },
+  "devDependencies": {
+    "@sheetjs/uglify-js": "~2.7.3",
+    "@types/node": "^8.5.9",
+    "acorn": "7.4.1",
+    "alex": "8.1.1",
+    "blanket": "~1.2.3",
+    "commander": "~2.17.1",
+    "dtslint": "^0.1.2",
+    "eslint": "7.23.0",
+    "eslint-plugin-html": "^6.1.2",
+    "eslint-plugin-json": "^2.1.2",
+    "exit-on-epipe": "~1.0.1",
+    "fflate": "^0.7.1",
+    "jsdom": "~11.1.0",
+    "markdown-spellcheck": "^1.3.1",
+    "mocha": "~2.5.3",
+    "sinon": "^1.17.7",
+    "typescript": "2.2.0",
+    "webpack": "5.111.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MOR8T/style-xlsx-m.git"
+  },
+  "scripts": {
+    "test": "node test/run.js"
+  },
+  "config": {
+    "blanket": {
+      "pattern": "xlsx.js"
+    }
+  },
+  "alex": {
+    "allow": [
+      "chinese",
+      "special",
+      "simple",
+      "just",
+      "crash",
+      "wtf",
+      "holes"
+    ]
+  },
+  "homepage": "https://github.com/MOR8T/style-xlsx-m#readme",
+  "bugs": {
+    "url": "https://github.com/MOR8T/style-xlsx-m/issues"
+  },
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=0.8"
+  },
+  "files": [
+    "LICENSE",
+    "NOTICE",
+    "README.md",
+    "xlsx.js",
+    "types/index.d.ts",
+    "dist/LICENSE",
+    "dist/cpexcel.js",
+    "dist/xlsx.full.min.js",
+    "xlsx-js-style/dist/LICENSE",
+    "xlsx-js-style/dist/xlsx.min.js",
+    "xlsx-js-style/dist/xlsx.bundle.js",
+    "xlsx-js-style/dist/cpexcel.js",
+    "third-party-licenses/"
+  ]
 }

package/types/index.d.ts

@@ -1,4 +1,5 @@
 /* index.d.ts (C) 2015-present SheetJS and contributors */
+/* Modified by Shahrom Shukurov: getCellStyles option and worksheet naming declaration in the inherited definitions. See NOTICE. */
 // TypeScript Version: 2.2
 // import * as CFB from "cfb";
 // import * as SSF from "ssf";

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

@@ -1,4 +1,5 @@
 /* xlsx-js-style 1.2.0-beta @ 2022-04-05T01:40:40.843Z */
+/* Modified by Shahrom Shukurov: page setup and sheet_to_json style collection in the bundled writer; local formatting. See NOTICE. */
 var XLSX = {};
 function make_xlsx_lib(a) {
   (a.version = "0.18.5"), (a.style_version = "1.2.0");

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

@@ -1,4 +1,5 @@
 /* xlsx-js-style 1.2.0-beta @ 2022-04-05T01:40:40.843Z */
+/* Modified by Shahrom Shukurov: page setup and sheet_to_json style collection in the bundled writer; local formatting. See NOTICE. */
 var XLSX = {};
 function make_xlsx_lib(a) {
   (a.version = "0.18.5"), (a.style_version = "1.2.0");

package/xlsx.js

@@ -1,5 +1,5 @@
 /*! xlsx.js (C) 2013-present SheetJS -- http://sheetjs.com */
-/* Modified by Shukurov Shahrom: style reading, sheet_to_json getCellStyles, page setup, write via xlsx-js-style. See NOTICE. */
+/* Modified by Shahrom Shukurov: style reading, sheet_to_json getCellStyles, page setup, and synchronous style writes; corrected fills and border colours. See NOTICE. */
 /* vim: set ts=2: */
 /*exported XLSX */
 /*global exports, module, require:false, process:false, Buffer:false, ArrayBuffer:false, DataView:false, Deno:false */
@@ -10169,21 +10169,14 @@ function parse_borders(t, styles, themes, opts) {
 				var icv = XLSIcv[color.index];
 				if(color.index == 81) icv = XLSIcv[1];
 				if(!icv) icv = XLSIcv[1]; //throw new Error(x); // note: 206 is valid
-				color.rgb = icv[0].toString(16) + icv[1].toString(16) + icv[2].toString(16);
+				color.rgb = [icv[0], icv[1], icv[2]].map(function(c) { return ('0' + c.toString(16)).slice(-2); }).join('').toUpperCase();
 			} else if(y.theme) {
 				color = {}
 				color.theme = parseInt(y.theme, 10);
 				if(y.tint) color.tint = parseFloat(y.tint);
-				if(y.theme && themes.themeElements && themes.themeElements.clrScheme) {
-					color.rgb = rgb_tint(themes.themeElements.clrScheme[color.theme].rgb, color.tint || 0);
-				}
-			}
-			if(color.index && color.rgb && !color.theme){
-				if(color.index == 64) color = {rgb:'000'}
-				else color = {rgb:color.rgb}
+				/* Keep the theme reference and tint for the style writer. */
 			}
-			else if(!color.index && color.rgb && color.theme) color = {rgb:color.rgb};
-			else color = {index:color.index};
+			if(color.index != null) color = {rgb:color.rgb};
 			break;
 			case '<color/>': case '</color>': break;
 
@@ -14536,28 +14529,10 @@ function safe_format(p, fmtid, fillid, opts, themes, styles, fontid, borderid,cf
 		else p.w = SSF_format(fmtid,p.v,_ssfopts);
 	} catch(e) { if(opts.WTF) throw e; }
 	if(!opts.cellStyles) return;
-	// if(fillid != null) try {
-	// 	// p.s = {...styles.Fills[fillid]};
-	// 	const pss = {...styles.Fills[fillid]}
-	// 	if (pss.fgColor && pss.fgColor.theme && !pss.fgColor.rgb) {
-	// 		p.s.fgColor.rgb = rgb_tint(themes.themeElements.clrScheme[pss.fgColor.theme].rgb, pss.fgColor.tint || 0);
-	// 		if(opts.WTF) p.s.fgColor.raw_rgb = themes.themeElements.clrScheme[pss.fgColor.theme].rgb;
-	// 	}
-	// 	if (pss.bgColor && (pss.bgColor.theme || pss.bgColor.theme == 0)) {
-	// 		p.s.Fills[fillid].bgColor.rgb = rgb_tint(themes.themeElements.clrScheme[pss.bgColor.theme].rgb, pss.bgColor.tint || 0);
-	// 		if(opts.WTF) p.s.bgColor.raw_rgb = themes.themeElements.clrScheme[pss.bgColor.theme].rgb;
-	// 	}
-	// 	if(pss.patternType){
-	// 		if(pss.fgColor.rgb){
-	// 			const bg = { rgb: pss.fgColor.rgb };
-	// 			p.s.fill = {fgColor: bg, bgColor: bg ,
-	// 				patternType: pss.patternType == 'solid' ? 'solid' : 'none',
-	// 			}
-	// 		}else {
-	// 			p.s.fill = {patternType: pss.patternType == 'solid' ? 'solid' : 'none',}
-	// 		}
-	// 	}
-	// } catch(e) { if(opts.WTF && styles.Fills) throw e; }
+	/* Map the parsed fill to the nested shape accepted by xlsx-js-style. */
+	if(fillid != null && styles.Fills && styles.Fills[fillid]) {
+		p.s = {...p.s, fill: {...styles.Fills[fillid]}};
+	}
 	if(fontid != null){
 		p.s = {...p.s,...styles.Fonts[fontid],}
         if (p.s.sz) p.s.font = { ...p.s.font, sz: p.s.sz };
@@ -24310,7 +24285,7 @@ function sheet_to_json(sheet, opts) {
 		if((row.isempty === false) || (header === 1 ? o.blankrows !== false : !!o.blankrows)) styles[stylesi++] = row.styles;
 	}
 	out.length = outi;
-	if(opts.getCellStyles){
+	if(o.getCellStyles){
 		return {out, styles:styles}
 	}
 	return out;