Merge pull request #31 from zurmokeeper/bugfix/rich_text_error

fix rich text tags bug and add type definitions
zurmokeeper · Oct 20, 2023 · aa16b15 · aa16b15
2 parents 0120757 + 79a0191
commit aa16b15
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 18 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x, 18.x, 20.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x, 20.x, 21.x]
         os: [ubuntu-latest, macOS-latest, windows-latest]
     runs-on: ${{ matrix.os }}
 

diff --git a/README.md b/README.md
@@ -2345,7 +2345,7 @@ Options supported when reading CSV files.
 | dateFormats      |     N       |  Array      | Specify the date encoding format of dayjs. |
 | map              |     N       |  Function   | Custom Array.prototype.map() callback function for processing data. |
 | sheetName        |     N       |  String     | Specify worksheet name. |
-| parserOptions    |     N       |  Object     | [parseOptions options](https://c2fo.io/fast-csv/docs/parsing/options)  @fast-csv/format module to write csv data. |
+| parserOptions    |     N       |  Object     | [parseOptions options](https://c2fo.github.io/fast-csv/docs/parsing/options)  @fast-csv/format module to write csv data. |
 
 ```javascript
 // read from a file
@@ -2388,7 +2388,7 @@ const options = {
         return parseFloat(value);
     }
   },
-  // https://c2fo.io/fast-csv/docs/parsing/options
+  // https://c2fo.github.io/fast-csv/docs/parsing/options
   parserOptions: {
     delimiter: '\t',
     quote: false,
@@ -2424,7 +2424,7 @@ Options supported when writing to a CSV file.
 | map              |     N       |  Function   | Custom Array.prototype.map() callback function for processing row values. |
 | sheetName        |     N       |  String     | Specify worksheet name. |
 | sheetId          |     N       |  Number     | Specify worksheet ID. |
-| formatterOptions |     N       |  Object     | [formatterOptions options](https://c2fo.io/fast-csv/docs/formatting/options/) @fast-csv/format module to write csv data. |
+| formatterOptions |     N       |  Object     | [formatterOptions options](https://c2fo.github.io/fast-csv/docs/formatting/options/) @fast-csv/format module to write csv data. |
 
 ```javascript
 
@@ -2465,7 +2465,7 @@ const options = {
         return value;
     }
   },
-  // https://c2fo.io/fast-csv/docs/formatting/options
+  // https://c2fo.github.io/fast-csv/docs/formatting/options
   formatterOptions: {
     delimiter: '\t',
     quote: false,

diff --git a/README_zh.md b/README_zh.md
@@ -2236,7 +2236,7 @@ const buffer = await workbook.xlsx.writeBuffer({password: '123456'});
 | dateFormats      |     N       |  Array      | 指定 dayjs 的日期编码格式。 |
 | map              |     N       |  Function   | 自定义`Array.prototype.map()` 回调函数，用于处理数据。 |
 | sheetName        |     N       |  String     | 指定工作表名称。 |
-| parserOptions    |     N       |  Object     | [parseOptions 选项](https://c2fo.io/fast-csv/docs/parsing/options)  @fast-csv/format 模块以写入 csv 数据。 |
+| parserOptions    |     N       |  Object     | [parseOptions 选项](https://c2fo.github.io/fast-csv/docs/parsing/options)  @fast-csv/format 模块以写入 csv 数据。 |
 
 ```javascript
 // 从文件读取
@@ -2279,7 +2279,7 @@ const options = {
         return parseFloat(value);
     }
   },
-  // https://c2fo.io/fast-csv/docs/parsing/options
+  // https://c2fo.github.io/fast-csv/docs/parsing/options
   parserOptions: {
     delimiter: '\t',
     quote: false,
@@ -2312,7 +2312,7 @@ CSV 解析器使用 [fast-csv](https://www.npmjs.com/package/fast-csv) 读取CSV
 | map              |     N       |  Function   | 自定义`Array.prototype.map()` 回调函数，用于处理行值。 |
 | sheetName        |     N       |  String     | 指定工作表名称。 |
 | sheetId          |     N       |  Number     | 指定工作表 ID。 |
-| formatterOptions |     N       |  Object     | [formatterOptions 选项](https://c2fo.io/fast-csv/docs/formatting/options/) @fast-csv/format 模块写入csv 数据。 |
+| formatterOptions |     N       |  Object     | [formatterOptions 选项](https://c2fo.github.io/fast-csv/docs/formatting/options/) @fast-csv/format 模块写入csv 数据。 |
 
 ```javascript
 
@@ -2352,7 +2352,7 @@ const options = {
         return value;
     }
   },
-  // https://c2fo.io/fast-csv/docs/formatting/options
+  // https://c2fo.github.io/fast-csv/docs/formatting/options
   formatterOptions: {
     delimiter: '\t',
     quote: false,

diff --git a/index.d.ts b/index.d.ts
@@ -230,7 +230,7 @@ export interface Font {
 }
 
 export type BorderStyle =
-	| 'thin' | 'dotted' | 'hair' | 'medium' | 'double' | 'thick' | 'dashDot'
+	| 'thin' | 'dotted' | 'hair' | 'medium' | 'double' | 'thick' | 'dashed' | 'dashDot'
 	| 'dashDotDot' | 'slantDashDot' | 'mediumDashed' | 'mediumDashDotDot' | 'mediumDashDot';
 
 export type ColorIndexes = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 |
@@ -371,6 +371,7 @@ export interface Alignment {
 
 export interface Protection {
 	locked: boolean;
+	hidden: boolean;
 }
 
 export interface Style {
@@ -426,19 +427,20 @@ export interface CellRichTextValue {
 export interface CellHyperlinkValue {
 	text: string;
 	hyperlink: string;
+	tooltip?: string;
 }
 
 export interface CellFormulaValue {
 	formula: string;
-	result?: number | string | Date | { error: CellErrorValue };
-	date1904: boolean;
+	result?: number | string | boolean | Date | CellErrorValue;
+	date1904?: boolean;
 }
 
 export interface CellSharedFormulaValue {
 	sharedFormula: string;
 	readonly formula?: string;
-	result?: number | string | Date | { error: CellErrorValue };
-	date1904: boolean;
+	result?: number | string | boolean | Date | CellErrorValue;
+	date1904?: boolean;
 }
 
 export declare enum ValueType {
@@ -1234,7 +1236,7 @@ export interface Worksheet {
 	/**
 	 * Get the last column in a worksheet
 	 */
-	readonly lastColumn: Column;
+	readonly lastColumn: Column | undefined;
 
 	/**
 	 * A count of the number of columns that have values.
@@ -1667,7 +1669,7 @@ export interface Xlsx {
 	write(stream: import('stream').Stream, options?: Partial<XlsxWriteOptions>): Promise<void>;
 }
 
-// https://c2fo.io/fast-csv/docs/parsing/options
+// https://c2fo.github.io/fast-csv/docs/parsing/options
 
 type HeaderArray = (string | undefined | null)[];
 type HeaderTransformFunction = (headers: HeaderArray) => HeaderArray;
@@ -1708,7 +1710,7 @@ interface RowTransformFunction {
 	(row: Rows): Rows;
 }
 
-// https://c2fo.io/fast-csv/docs/formatting/options/
+// https://c2fo.github.io/fast-csv/docs/formatting/options/
 export interface FastCsvFormatterOptionsArgs {
 	objectMode: boolean;
 	delimiter: string;

diff --git a/lib/xlsx/xform/strings/shared-string-xform.js b/lib/xlsx/xform/strings/shared-string-xform.js
@@ -75,6 +75,9 @@ class SharedStringXform extends BaseXform {
           case 'r': {
             let rt = this.model.richText;
             if (!rt) {
+              if (!this.model) {
+                this.model = {};
+              }
               rt = this.model.richText = [];
             }
             rt.push(this.parser.model);

diff --git a/lib/xlsx/xform/style/border-xform.js b/lib/xlsx/xform/style/border-xform.js
@@ -89,6 +89,7 @@ class EdgeXform extends BaseXform {
 
 EdgeXform.validStyleValues = [
   'thin',
+  'dashed',
   'dotted',
   'dashDot',
   'hair',

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@zurmokeeper/exceljs",
-  "version": "4.4.6",
+  "version": "4.4.7",
   "description": "Excel Workbook Manager - Read and Write xlsx and csv Files.",
   "private": false,
   "license": "MIT",

diff --git a/spec/integration/data/rich-text-parse-test.xlsx b/spec/integration/data/rich-text-parse-test.xlsx
diff --git a/spec/integration/workbook-xlsx-reader.spec.js b/spec/integration/workbook-xlsx-reader.spec.js
@@ -428,4 +428,13 @@ describe('WorkbookReader', () => {
       );
     });
   });
+
+  describe('with rich text to describe a hyperlink', () => {
+    it('should parse with no errors', () => {
+      const workbook = new ExcelJS.Workbook();
+      return workbook.xlsx.read(
+        fs.createReadStream('./spec/integration/data/rich-text-parse-test.xlsx')
+      );
+    });
+  });
 });