exceljs-lts 4.5.3 → 4.5.4

package/index.d.ts

@@ -865,6 +865,10 @@ export interface HeaderFooter {
 export type AutoFilter = string | {
 	from: string | { row: number; column: number };
 	to: string | { row: number; column: number };
+	/**
+	 * Columns (0 = leftmost column of the range) whose filter button is hidden
+	 */
+	exclude?: number[];
 };
 
 export interface WorksheetProtection {

package/lib/doc/image.js

@@ -56,4 +56,36 @@ class Image {
   }
 }
 
+function isFiniteNumber(value) {
+  return typeof value === 'number' && Number.isFinite(value);
+}
+
+Image.validateRange = function validateRange(range) {
+  if (typeof range === 'string') {
+    let decoded;
+    try {
+      decoded = colCache.decode(range);
+    } catch (e) {
+      decoded = {};
+    }
+    const isRange = ['top', 'left', 'bottom', 'right'].every(key => isFiniteNumber(decoded[key]));
+    const isAddress = isFiniteNumber(decoded.row) && isFiniteNumber(decoded.col);
+    if (!isRange && !isAddress) {
+      throw new Error(`Invalid image range "${range}": expected a cell range such as "B2:D6"`);
+    }
+    return;
+  }
+  if (!range || typeof range !== 'object') {
+    throw new Error(
+      'Invalid image range: expected a cell range string or an object with tl and br or ext'
+    );
+  }
+  if (!range.br && !range.ext) {
+    throw new Error('Invalid image range: an object range needs either br or ext');
+  }
+  if (range.ext && typeof range.ext !== 'object') {
+    throw new Error('Invalid image range: ext must be an object with width and height');
+  }
+};
+
 module.exports = Image;

package/lib/doc/worksheet.js

@@ -781,7 +781,15 @@ class Worksheet {
 
   // =========================================================================
   // Images
+  _validateImageId(imageId) {
+    if (imageId === undefined || imageId === null || !this._workbook.getImage(imageId)) {
+      throw new Error(`Image with id ${imageId} not found. Add it with workbook.addImage() first`);
+    }
+  }
+
   addImage(imageId, range) {
+    this._validateImageId(imageId);
+    Image.validateRange(range);
     const model = {
       type: 'image',
       imageId,
@@ -795,6 +803,7 @@ class Worksheet {
   }
 
   addBackgroundImage(imageId) {
+    this._validateImageId(imageId);
     const model = {
       type: 'background',
       imageId,

package/lib/stream/xlsx/worksheet-writer.js

@@ -473,6 +473,9 @@ class WorksheetWriter {
   // =========================================================================
 
   addBackgroundImage(imageId) {
+    if (imageId === undefined || imageId === null || !this._workbook.getImage(imageId)) {
+      throw new Error(`Image with id ${imageId} not found. Add it with workbook.addImage() first`);
+    }
     this._background = {
       imageId,
     };

package/lib/xlsx/xform/sheet/auto-filter-xform.js

@@ -22,16 +22,55 @@ class AutoFilterXform extends BaseXform {
         const firstAddress = getAddress(model.from);
         const secondAddress = getAddress(model.to);
         if (firstAddress && secondAddress) {
-          xmlStream.leafNode('autoFilter', {ref: `${firstAddress}:${secondAddress}`});
+          const ref = `${firstAddress}:${secondAddress}`;
+          if (model.exclude && model.exclude.length) {
+            // hide the filter button on the excluded columns (0 = leftmost column of the range)
+            xmlStream.openNode('autoFilter', {ref});
+            model.exclude.forEach(colId => {
+              xmlStream.leafNode('filterColumn', {colId, hiddenButton: '1'});
+            });
+            xmlStream.closeNode();
+          } else {
+            xmlStream.leafNode('autoFilter', {ref});
+          }
         }
       }
     }
   }
 
   parseOpen(node) {
-    if (node.name === 'autoFilter') {
-      this.model = node.attributes.ref;
+    switch (node.name) {
+      case 'autoFilter':
+        this.ref = node.attributes.ref;
+        this.exclude = [];
+        this.model = this.ref;
+        return true;
+      case 'filterColumn': {
+        const {colId, hiddenButton, showButton} = node.attributes;
+        const hidden =
+          hiddenButton === '1' ||
+          hiddenButton === 'true' ||
+          showButton === '0' ||
+          showButton === 'false';
+        if (hidden && colId !== undefined) {
+          this.exclude.push(parseInt(colId, 10));
+        }
+        return true;
+      }
+      default:
+        return true;
+    }
+  }
+
+  parseClose(name) {
+    if (name === 'autoFilter') {
+      if (this.exclude.length && this.ref) {
+        const [from, to] = this.ref.split(':');
+        this.model = {from, to: to || from, exclude: this.exclude};
+      }
+      return false;
     }
+    return true;
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exceljs-lts",
-  "version": "4.5.3",
+  "version": "4.5.4",
   "description": "Maintained fork of exceljs — drop-in replacement, fixes Excel \"We found a problem with some content\" repair prompts, the TypeError crash on rich-text shared strings, and lost formula results (0, false, ''). Read and write xlsx and csv files.",
   "private": false,
   "license": "MIT",