@cj-tech-master/excelts 1.4.5 → 1.5.0

package/dist/cjs/doc/range.js

@@ -5,11 +5,17 @@ const col_cache_js_1 = require("../utils/col-cache");
 // used by worksheet to calculate sheet dimensions
 class Range {
     constructor(...args) {
+        this.model = {
+            top: 0,
+            left: 0,
+            bottom: 0,
+            right: 0
+        };
         this.decode(args);
     }
     setTLBR(t, l, b, r, s) {
-        if (arguments.length < 4) {
-            // setTLBR(tl, br, s)
+        if (typeof t === "string" && typeof l === "string") {
+            // setTLBR(tl, br, s) - t and l are address strings
             const tl = col_cache_js_1.colCache.decodeAddress(t);
             const br = col_cache_js_1.colCache.decodeAddress(l);
             this.model = {
@@ -17,12 +23,14 @@ class Range {
                 left: Math.min(tl.col, br.col),
                 bottom: Math.max(tl.row, br.row),
                 right: Math.max(tl.col, br.col),
-                sheetName: b
+                sheetName: typeof b === "string" ? b : undefined
             };
-            this.setTLBR(tl.row, tl.col, br.row, br.col, s);
         }
-        else {
-            // setTLBR(t, l, b, r, s)
+        else if (typeof t === "number" &&
+            typeof l === "number" &&
+            typeof b === "number" &&
+            typeof r === "number") {
+            // setTLBR(t, l, b, r, s) - all numbers
             this.model = {
                 top: Math.min(t, b),
                 left: Math.min(l, r),
@@ -35,16 +43,33 @@ class Range {
     decode(argv) {
         switch (argv.length) {
             case 5: // [t,l,b,r,s]
-                this.setTLBR(argv[0], argv[1], argv[2], argv[3], argv[4]);
+                if (typeof argv[0] === "number" &&
+                    typeof argv[1] === "number" &&
+                    typeof argv[2] === "number" &&
+                    typeof argv[3] === "number" &&
+                    typeof argv[4] === "string") {
+                    this.setTLBR(argv[0], argv[1], argv[2], argv[3], argv[4]);
+                }
                 break;
             case 4: // [t,l,b,r]
-                this.setTLBR(argv[0], argv[1], argv[2], argv[3]);
+                if (typeof argv[0] === "number" &&
+                    typeof argv[1] === "number" &&
+                    typeof argv[2] === "number" &&
+                    typeof argv[3] === "number") {
+                    this.setTLBR(argv[0], argv[1], argv[2], argv[3]);
+                }
                 break;
             case 3: // [tl,br,s]
-                this.setTLBR(argv[0], argv[1], argv[2]);
+                if (typeof argv[0] === "string" &&
+                    typeof argv[1] === "string" &&
+                    typeof argv[2] === "string") {
+                    this.setTLBR(argv[0], argv[1], argv[2]);
+                }
                 break;
             case 2: // [tl,br]
-                this.setTLBR(argv[0], argv[1]);
+                if (typeof argv[0] === "string" && typeof argv[1] === "string") {
+                    this.setTLBR(argv[0], argv[1]);
+                }
                 break;
             case 1: {
                 const value = argv[0];
@@ -58,11 +83,15 @@ class Range {
                         sheetName: value.sheetName
                     };
                 }
-                else if (value instanceof Array) {
+                else if (Array.isArray(value)) {
                     // an arguments array
                     this.decode(value);
                 }
-                else if (value.top && value.left && value.bottom && value.right) {
+                else if (typeof value === "object" &&
+                    "top" in value &&
+                    "left" in value &&
+                    "bottom" in value &&
+                    "right" in value) {
                     // a model
                     this.model = {
                         top: value.top,
@@ -72,25 +101,27 @@ class Range {
                         sheetName: value.sheetName
                     };
                 }
-                else {
+                else if (typeof value === "string") {
                     // [sheetName!]tl:br
-                    const tlbr = col_cache_js_1.colCache.decodeEx(value);
-                    if (tlbr.top) {
+                    const decoded = col_cache_js_1.colCache.decodeEx(value);
+                    if ("top" in decoded) {
+                        // It's a DecodedRange
                         this.model = {
-                            top: tlbr.top,
-                            left: tlbr.left,
-                            bottom: tlbr.bottom,
-                            right: tlbr.right,
-                            sheetName: tlbr.sheetName
+                            top: decoded.top,
+                            left: decoded.left,
+                            bottom: decoded.bottom,
+                            right: decoded.right,
+                            sheetName: decoded.sheetName
                         };
                     }
-                    else {
+                    else if ("row" in decoded) {
+                        // It's an Address
                         this.model = {
-                            top: tlbr.row,
-                            left: tlbr.col,
-                            bottom: tlbr.row,
-                            right: tlbr.col,
-                            sheetName: tlbr.sheetName
+                            top: decoded.row,
+                            left: decoded.col,
+                            bottom: decoded.row,
+                            right: decoded.col,
+                            sheetName: decoded.sheetName
                         };
                     }
                 }
@@ -172,7 +203,9 @@ class Range {
     }
     expandToAddress(addressStr) {
         const address = col_cache_js_1.colCache.decodeEx(addressStr);
-        this.expand(address.row, address.col, address.row, address.col);
+        if ("row" in address && "col" in address) {
+            this.expand(address.row, address.col, address.row, address.col);
+        }
     }
     get tl() {
         return col_cache_js_1.colCache.n2l(this.left) + this.top;
@@ -224,7 +257,10 @@ class Range {
     }
     contains(addressStr) {
         const address = col_cache_js_1.colCache.decodeEx(addressStr);
-        return this.containsEx(address);
+        if ("row" in address && "col" in address) {
+            return this.containsEx(address);
+        }
+        return false;
     }
     containsEx(address) {
         if (address.sheetName && this.sheetName && address.sheetName !== this.sheetName) {

package/dist/cjs/doc/row.js

@@ -12,19 +12,29 @@ class Row {
         this.style = {};
         this.outlineLevel = 0;
     }
-    // return the row number
+    /**
+     * The row number
+     */
     get number() {
         return this._number;
     }
+    /**
+     * The worksheet that contains this row
+     */
     get worksheet() {
         return this._worksheet;
     }
-    // Inform Streaming Writer that this row (and all rows before it) are complete
-    // and ready to write. Has no effect on Worksheet document
+    /**
+     * Commit a completed row to stream.
+     * Inform Streaming Writer that this row (and all rows before it) are complete
+     * and ready to write. Has no effect on Worksheet document.
+     */
     commit() {
         this._worksheet._commitRow(this);
     }
-    // helps GC by breaking cyclic references
+    /**
+     * Helps GC by breaking cyclic references
+     */
     destroy() {
         delete this._worksheet;
         delete this._cells;
@@ -43,7 +53,9 @@ class Row {
         }
         return cell;
     }
-    // get cell by key, letter or column number
+    /**
+     * Get cell by number, column letter or column key
+     */
     getCell(col) {
         let colNum;
         if (typeof col === "string") {
@@ -66,7 +78,11 @@ class Row {
                 col: colNum
             }));
     }
-    // remove cell(s) and shift all higher cells down by count
+    /**
+     * Cut one or more cells (cells to the right are shifted left)
+     *
+     * Note: this operation will not affect other rows
+     */
     splice(start, count, ...inserts) {
         const nKeep = start + count;
         const nExpand = inserts.length - count;
@@ -83,12 +99,12 @@ class Row {
                     cDst = this.getCell(i);
                     cDst.value = cSrc.value;
                     cDst.style = cSrc.style;
-                    cDst._comment = cSrc._comment;
+                    cDst.comment = cSrc.comment;
                 }
                 else if (cDst) {
                     cDst.value = null;
                     cDst.style = {};
-                    cDst._comment = undefined;
+                    cDst.comment = undefined;
                 }
             }
         }
@@ -100,7 +116,7 @@ class Row {
                     cDst = this.getCell(i + nExpand);
                     cDst.value = cSrc.value;
                     cDst.style = cSrc.style;
-                    cDst._comment = cSrc._comment;
+                    cDst.comment = cSrc.comment;
                 }
                 else {
                     this._cells[i + nExpand - 1] = undefined;
@@ -112,29 +128,29 @@ class Row {
             cDst = this.getCell(start + i);
             cDst.value = inserts[i];
             cDst.style = {};
-            cDst._comment = undefined;
+            cDst.comment = undefined;
         }
     }
-    eachCell(optionsOrIteratee, maybeIteratee) {
+    eachCell(optOrCallback, maybeCallback) {
         let options = null;
-        let iteratee;
-        if (typeof optionsOrIteratee === "function") {
-            iteratee = optionsOrIteratee;
+        let callback;
+        if (typeof optOrCallback === "function") {
+            callback = optOrCallback;
         }
         else {
-            options = optionsOrIteratee;
-            iteratee = maybeIteratee;
+            options = optOrCallback;
+            callback = maybeCallback;
         }
         if (options && options.includeEmpty) {
             const n = this._cells.length;
             for (let i = 1; i <= n; i++) {
-                iteratee(this.getCell(i), i);
+                callback(this.getCell(i), i);
             }
         }
         else {
             this._cells.forEach((cell, index) => {
                 if (cell && cell.type !== enums_js_1.Enums.ValueType.Null) {
-                    iteratee(cell, index + 1);
+                    callback(cell, index + 1);
                 }
             });
         }
@@ -155,7 +171,9 @@ class Row {
         }
         ws.rowBreaks.push(pb);
     }
-    // return a sparse array of cell values
+    /**
+     * Get a row as a sparse array
+     */
     get values() {
         const values = [];
         this._cells.forEach(cell => {
@@ -165,7 +183,9 @@ class Row {
         });
         return values;
     }
-    // set the values by contiguous or sparse array, or by key'd object literal
+    /**
+     * Set the values by contiguous or sparse array, or by key'd object literal
+     */
     set values(value) {
         // this operation is not additive - any prior cells are removed
         this._cells = [];
@@ -201,13 +221,21 @@ class Row {
             });
         }
     }
-    // returns true if the row includes at least one cell with a value
+    /**
+     * Returns true if the row includes at least one cell with a value
+     */
     get hasValues() {
-        return this._cells.some((cell) => cell && cell.type !== enums_js_1.Enums.ValueType.Null);
+        return this._cells.some(cell => cell && cell.type !== enums_js_1.Enums.ValueType.Null);
     }
+    /**
+     * Number of cells including empty ones
+     */
     get cellCount() {
         return this._cells.length;
     }
+    /**
+     * Number of non-empty cells
+     */
     get actualCellCount() {
         let count = 0;
         this.eachCell(() => {
@@ -215,7 +243,9 @@ class Row {
         });
         return count;
     }
-    // get the min and max column number for the non-null cells in this row or null
+    /**
+     * Get the min and max column number for the non-null cells in this row or null
+     */
     get dimensions() {
         let min = 0;
         let max = 0;
@@ -242,46 +272,57 @@ class Row {
         this.style[name] = value;
         this._cells.forEach(cell => {
             if (cell) {
-                cell[name] = value;
+                cell.style[name] = value;
             }
         });
-        return value;
     }
     get numFmt() {
         return this.style.numFmt;
     }
     set numFmt(value) {
-        this._applyStyle("numFmt", value);
+        if (value !== undefined) {
+            this._applyStyle("numFmt", value);
+        }
     }
     get font() {
         return this.style.font;
     }
     set font(value) {
-        this._applyStyle("font", value);
+        if (value !== undefined) {
+            this._applyStyle("font", value);
+        }
     }
     get alignment() {
         return this.style.alignment;
     }
     set alignment(value) {
-        this._applyStyle("alignment", value);
+        if (value !== undefined) {
+            this._applyStyle("alignment", value);
+        }
     }
     get protection() {
         return this.style.protection;
     }
     set protection(value) {
-        this._applyStyle("protection", value);
+        if (value !== undefined) {
+            this._applyStyle("protection", value);
+        }
     }
     get border() {
         return this.style.border;
     }
     set border(value) {
-        this._applyStyle("border", value);
+        if (value !== undefined) {
+            this._applyStyle("border", value);
+        }
     }
     get fill() {
         return this.style.fill;
     }
     set fill(value) {
-        this._applyStyle("fill", value);
+        if (value !== undefined) {
+            this._applyStyle("fill", value);
+        }
     }
     get hidden() {
         return !!this._hidden;

package/dist/cjs/doc/table.js

@@ -157,9 +157,7 @@ class Table {
         // the sheet...
         const assignStyle = (cell, style) => {
             if (style) {
-                Object.keys(style).forEach(key => {
-                    cell.style[key] = style[key];
-                });
+                Object.assign(cell.style, style);
             }
         };
         const { worksheet, table } = this;
@@ -377,10 +375,10 @@ class Table {
         this._assign(this.table, "totalsRow", value);
     }
     get theme() {
-        return this.table.style.name;
+        return this.table.style.theme;
     }
     set theme(value) {
-        this.table.style.name = value;
+        this.table.style.theme = value;
     }
     get showFirstColumn() {
         return this.table.style.showFirstColumn;

package/dist/cjs/doc/workbook.js

@@ -29,12 +29,18 @@ class Workbook {
         this.pivotTables = [];
         this._definedNames = new defined_names_js_1.DefinedNames();
     }
+    /**
+     * xlsx file format operations
+     */
     get xlsx() {
         if (!this._xlsx) {
             this._xlsx = new xlsx_js_1.XLSX(this);
         }
         return this._xlsx;
     }
+    /**
+     * csv file format operations
+     */
     get csv() {
         if (!this._csv) {
             this._csv = new csv_js_1.CSV(this);
@@ -50,15 +56,19 @@ class Workbook {
         }
         return this._worksheets.length || 1;
     }
+    /**
+     * Add a new worksheet and return a reference to it
+     */
     addWorksheet(name, options) {
         const id = this.nextId;
         const lastOrderNo = this._worksheets.reduce((acc, ws) => ((ws && ws.orderNo) > acc ? ws.orderNo : acc), 0);
-        const worksheetOptions = Object.assign({}, options, {
+        const worksheetOptions = {
+            ...options,
             id,
             name,
             orderNo: lastOrderNo + 1,
             workbook: this
-        });
+        };
         const worksheet = new worksheet_js_1.Worksheet(worksheetOptions);
         this._worksheets[id] = worksheet;
         return worksheet;
@@ -72,6 +82,9 @@ class Workbook {
             worksheet.destroy();
         }
     }
+    /**
+     * Fetch sheet by name or id
+     */
     getWorksheet(id) {
         if (id === undefined) {
             return this._worksheets.find(Boolean);
@@ -84,6 +97,9 @@ class Workbook {
         }
         return undefined;
     }
+    /**
+     * Return a clone of worksheets in order
+     */
     get worksheets() {
         // return a clone of _worksheets
         return this._worksheets
@@ -91,9 +107,14 @@ class Workbook {
             .sort((a, b) => a.orderNo - b.orderNo)
             .filter(Boolean);
     }
-    eachSheet(iteratee) {
+    /**
+     * Iterate over all sheets.
+     *
+     * Note: `workbook.worksheets.forEach` will still work but this is better.
+     */
+    eachSheet(callback) {
         this.worksheets.forEach(sheet => {
-            iteratee(sheet, sheet.id);
+            callback(sheet, sheet.id);
         });
     }
     get definedNames() {
@@ -103,14 +124,17 @@ class Workbook {
         // Note: themes are not an exposed feature, meddle at your peril!
         this._themes = undefined;
     }
+    /**
+     * Add Image to Workbook and return the id
+     */
     addImage(image) {
         // TODO:  validation?
         const id = this.media.length;
-        this.media.push(Object.assign({}, image, { type: "image" }));
+        this.media.push({ ...image, type: "image" });
         return id;
     }
     getImage(id) {
-        return this.media[id];
+        return this.media[Number(id)];
     }
     get model() {
         return {