update index.t.ds abd readme.md

CTyrannosaurus · CTyrannosaurus · commit a905bea990e8 · 2023-06-08T16:00:11.000+08:00
diff --git a/README.md b/README.md
@@ -13,9 +13,43 @@ Reverse engineered from Excel spreadsheet files as a project.
 # Installation
 
 ```shell
-npm install exceljs
+npm install @zurmokeeper/exceljs
 ```
 
+# V4.4.1 New Features!
+
+Change Log:
+<ul>
+  <li>
+    Add nested columns feature. Thank you <a href="https://github.com/jeka1985">jeka1985</a>, Merged <a href="https://github.com/exceljs/exceljs/pull/1889"> PR1889</a>.
+    
+    Code snippets: 
+
+    // new api: worksheet.makeColumns()
+  </li>
+  <li>
+    Add file encryption function.
+
+    Code snippets: 
+    await workbook.xlsx.writeFile(filename, {password: '123456'});
+  </li>
+</ul>
+
+# V4.4.0 New Features!
+
+Change Log:
+<ul>
+  <li>
+    Add decryption of excel files with password encryption (Support frontend and backend)
+
+    Code snippets:
+
+    // read from a stream, decrypt excel files encrypted with password
+    // const workbook = new Excel.Workbook();
+    // await workbook.xlsx.readFile(filename, {password:'123456'});
+  </li>
+</ul>
+
 # New Features!
 
 <ul>
@@ -742,6 +776,26 @@ const newCol3Values = [1,2,3,4,5];
 const newCol4Values = ['one', 'two', 'three', 'four', 'five'];
 worksheet.spliceColumns(3, 1, newCol3Values, newCol4Values);
 
+// Nested columns
+// Also you can build nested columns 
+worksheet.makeColumns([
+  {
+    id: 1, 
+    title: 'Some', 
+  },
+  {id: 2, title: 'Qwe'},
+  {id: 3, title: 'Foo'},
+  {
+    id: 4,
+    title: 'Zoo',
+    children: [
+      { id: 41, title: 'Zoo 1' },
+      { id: 42, title: 'Zoo 2' },
+      { id: 44, title: 'Zoo 3' },
+      { id: 45, title: 'Zoo 4' },
+    ]
+  }
+]);
 ```
 
 ## Rows[⬆](#contents)<!-- Link generated with jump2header -->
@@ -2193,11 +2247,21 @@ await workbook.xlsx.load(data, {password:'123456'});
 const workbook = createAndFillWorkbook();
 await workbook.xlsx.writeFile(filename);
 
+// write to a file, with password encryption
+const workbook = createAndFillWorkbook();
+await workbook.xlsx.writeFile(filename, {password: '123456'});
+
 // write to a stream
 await workbook.xlsx.write(stream);
 
+// write to a stream, with password encryption
+await workbook.xlsx.write(stream, {password: '123456'}));
+
 // write to a new buffer
 const buffer = await workbook.xlsx.writeBuffer();
+
+// write to a new buffer, with password encryption
+const buffer = await workbook.xlsx.writeBuffer({password: '123456'});
 ```
 
 ### CSV[⬆](#contents)<!-- Link generated with jump2header -->
diff --git a/README_zh.md b/README_zh.md
@@ -11,9 +11,43 @@
 # 安装
 
 ```shell
-npm install exceljs
+npm install @zurmokeeper/exceljs
 ```
 
+# V4.4.1 新的功能!
+
+变更日志:
+<ul>
+  <li>
+    新增嵌套列功能（多表头）. 感谢 <a href="https://github.com/jeka1985">jeka1985</a>, Merged <a href="https://github.com/exceljs/exceljs/pull/1889"> PR1889</a>.
+    
+    Code snippets: 
+
+    // new api: worksheet.makeColumns()
+  </li>
+  <li>
+    新增导出加密Excel文件功能.
+
+    Code snippets: 
+    await workbook.xlsx.writeFile(filename, {password: '123456'});
+  </li>
+</ul>
+
+# V4.4.0 新的功能!
+
+变更日志:
+<ul>
+  <li>
+    新增读取加密Excel的功能 (支持前端和后端（Node.js）)
+
+    Code snippets:
+
+    // read from a stream, decrypt excel files encrypted with password
+    // const workbook = new Excel.Workbook();
+    // await workbook.xlsx.readFile(filename, {password:'123456'});
+  </li>
+</ul>
+
 # 新的功能!
 
 <ul>
@@ -689,6 +723,26 @@ const newCol3Values = [1,2,3,4,5];
 const newCol4Values = ['one', 'two', 'three', 'four', 'five'];
 worksheet.spliceColumns(3, 1, newCol3Values, newCol4Values);
 
+// 嵌套列
+// 使用这个API来构建嵌套列（实现多级表头）
+worksheet.makeColumns([
+  {
+    id: 1, 
+    title: 'Some', 
+  },
+  {id: 2, title: 'Qwe'},
+  {id: 3, title: 'Foo'},
+  {
+    id: 4,
+    title: 'Zoo',
+    children: [
+      { id: 41, title: 'Zoo 1' },
+      { id: 42, title: 'Zoo 2' },
+      { id: 44, title: 'Zoo 3' },
+      { id: 45, title: 'Zoo 4' },
+    ]
+  }
+]);
 ```
 
 ## 行[⬆](#目录)<!-- Link generated with jump2header -->
@@ -2083,11 +2137,21 @@ await workbook.xlsx.load(data, {password:'123456'});
 const workbook = createAndFillWorkbook();
 await workbook.xlsx.writeFile(filename);
 
+// 写入文件, 带密码保护的
+const workbook = createAndFillWorkbook();
+await workbook.xlsx.writeFile(filename, {password: '123456'});
+
 // 写入流
 await workbook.xlsx.write(stream);
 
+// 写入流, 带密码保护的
+await workbook.xlsx.write(stream, {password: '123456'}));
+
 // 写入 buffer
 const buffer = await workbook.xlsx.writeBuffer();
+
+// 写入 buffer, 带密码保护的
+const buffer = await workbook.xlsx.writeBuffer({password: '123456'});
 ```
 
 ### CSV[⬆](#目录)<!-- Link generated with jump2header -->
diff --git a/index.d.ts b/index.d.ts
@@ -1163,15 +1163,43 @@ export interface Worksheet {
 	 * Cut one or more columns (columns to the right are shifted left)
 	 * and optionally insert more
 	 *
-	 * If column properties have been definde, they will be cut or moved accordingly
+	 * If column properties have been define, they will be cut or moved accordingly
 	 *
 	 * Known Issue: If a splice causes any merged cells to move, the results may be unpredictable
 	 *
-	 * Also: If the worksheet has more rows than values in the colulmn inserts,
+	 * Also: If the worksheet has more rows than values in the column inserts,
 	 * the rows will still be shifted as if the values existed
 	 */
 	spliceColumns(start: number, count: number, ...insert: any[][]): void;
 
+	/**
+	 * Generate nested columns
+	 * Example:
+	 * 
+	 *  const headers = [
+	 *  {id: 1,title: 'name'},
+        {id: 2, title: 'Qwe'},
+        {id: 3, title: 'Foo'},
+        {
+          id: 4,
+          title: 'ABC',
+          children: [
+            {id: 41, title: 'Zoo 1'},
+            {id: 42, title: 'Zoo 2'},
+            {id: 44, title: 'Zoo 3'},
+          ],
+        }]
+	 *
+	 *	const workbook = new ExcelJS.Workbook();
+	 *	const worksheet = workbook.addWorksheet('Sheet1');
+	 *	worksheet.makeColumns(headers);
+	 *
+	 * 
+	 * Note: This API allows you to quickly build an excel with multiple table headers.
+	 * TODO: Can you set the background color together?
+	 */
+	makeColumns(input: any[][]): any[][];
+
 	/**
 	 * Add column headers and define column keys and widths.
 	 *
diff --git a/lib/doc/worksheet.js b/lib/doc/worksheet.js
@@ -924,6 +924,9 @@ class Worksheet {
     this.conditionalFormattings = value.conditionalFormattings;
   }
 
+  /**
+   * @desc Generates a nested column
+   */
   makeColumns(input) {
     const flatter = new ColumnFlatter(input);
     const merges = flatter.getMerges();
diff --git a/lib/utils/column-flatter.js b/lib/utils/column-flatter.js
@@ -4,7 +4,7 @@ const colCache = require('./col-cache');
  * ColumnFlatter is a helper class to create sheets with nested columns.
  *
  * Based on following concepts
- *  - Walk throught nested input structure to build flat list and tree meta information
+ *  - Walk through nested input structure to build flat list and tree meta information
  *  - Use "leaf" columns as physical cols and "branch" as merge-slots
  *  - Generate cell matrix and merge rules
  */
@@ -46,7 +46,7 @@ class ColumnFlatter {
   }
 
   /**
-   * Walk throught tree input.
+   * Walk through tree input.
    * Build flat columns list and aggregate column size (recursive children length sum)
    */
   _getFlatList(input) {
@@ -158,7 +158,7 @@ class ColumnFlatter {
   /**
    * Calculates horizontal merge rules
    *
-   * Walks width-throught rows collecting ranges with cell index and its recursive size
+   * Walks width-through rows collecting ranges with cell index and its recursive size
    */
   _calcHorizontalMerges() {
     const res = [];
@@ -184,7 +184,7 @@ class ColumnFlatter {
   /**
    * Calculates vertical merge rules
    *
-   * Walks deep-throught rows looking for non-empty cell in row
+   * Walks deep-through rows looking for non-empty cell in row
    */
   _calcVerticalMerges() {
     const depth = this._rows.length - 1;
diff --git a/spec/integration/pr/test-pr-1899.spec.js b/spec/integration/pr/test-pr-1899.spec.js
@@ -6,10 +6,9 @@ describe('pull request  1899', () => {
   it('pull request 1899- Support nested columns feature', async () => {
     async function test() {
       const workbook = new ExcelJS.Workbook();
-      //   const worksheet = workbook.addWorksheet('sheet');
-      const worksheet = workbook.addWorksheet('sheet', {
+      const worksheet = workbook.addWorksheet('Sheet1', {
         // properties: {defaultColWidth: 25},
-        views: [{state: 'frozen', xSplit: 0, ySplit: 3}], // 冻结第1行和第二行
+        views: [{state: 'frozen', xSplit: 0, ySplit: 2}], // 冻结第1行和第二行
       });
 
       worksheet.makeColumns([
@@ -26,14 +25,6 @@ describe('pull request  1899', () => {
             {id: 41, title: 'Zoo 1'},
             {id: 42, title: 'Zoo 2'},
             {id: 44, title: 'Zoo 3'},
-            {
-              id: 45,
-              title: 'Zoo 4',
-              children: [
-                {id: 451, title: 'Zoo 3XXXX'},
-                {id: 452, title: 'Zoo 3XXXX1232'},
-              ],
-            },
           ],
         },
         {
@@ -48,23 +39,7 @@ describe('pull request  1899', () => {
         {id: 6, title: 'Foo123213'},
       ]);
       const data = [
-        [
-          1,
-          'electron',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-          'DOB',
-        ],
-        [null, null, null, null, null, 'DOB'],
+        [1, 2, 3, null, null, 'DOB'],
         [1, 'electron', 'DOB'],
         [1, 'electron', 'DOB'],
         [1, 'electron', 'DOB'],
@@ -82,6 +57,50 @@ describe('pull request  1899', () => {
 
     await test();
 
-    // expect(error).to.be.an('error');
+    const workbookReader = new ExcelJS.Workbook();
+    await workbookReader.xlsx.readFile(TEST_1899_XLSX_FILE_NAME);
+    const worksheetReader = workbookReader.getWorksheet('Sheet1');
+
+    const actualRows = worksheetReader.getSheetValues();
+
+    // TODO: Why is the first data always null
+    const expectedRows = [
+      null,
+      [
+        null,
+        '姓名',
+        'Qwe',
+        'Foo',
+        '基础信息',
+        '基础信息',
+        '基础信息',
+        'Zoo1',
+        'Zoo1',
+        'Zoo1',
+        'Foo123213',
+      ],
+      [
+        null,
+        '姓名',
+        'Qwe',
+        'Foo',
+        'Zoo 1',
+        'Zoo 2',
+        'Zoo 3',
+        'Zoo 51',
+        'Zoo 52',
+        'Zoo 53',
+        'Foo123213',
+      ],
+      [null, 1, 2, 3, null, null, 'DOB'],
+      [null, 1, 'electron', 'DOB'],
+      [null, 1, 'electron', 'DOB'],
+      [null, 1, 'electron', 'DOB'],
+      [null, 1, 'electron', 'DOB'],
+      [null, 1, 'electron', 'DOB'],
+      [null, 1, 'electron', 'DOB'],
+      [null, 1, 'electron', 'DOB'],
+    ];
+    expect(JSON.stringify(actualRows)).to.equal(JSON.stringify(expectedRows));
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -924,6 +924,9 @@ class Worksheet {`
`924`	`924`	`this.conditionalFormattings = value.conditionalFormattings;`
`925`	`925`	`}`
`926`	`926`
	`927`	`+ /**`
	`928`	`+ * @desc Generates a nested column`
	`929`	`+ */`
`927`	`930`	`makeColumns(input) {`
`928`	`931`	`const flatter = new ColumnFlatter(input);`
`929`	`932`	`const merges = flatter.getMerges();`