npm - excellentexport - Versions diffs - 3.8.1 → 3.9.0 - Mend

excellentexport 3.8.1 → 3.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/.github/workflows/webpack.yml +5 -2
package/README.md +50 -6
package/dist/excellentexport.d.ts +3 -0
package/dist/excellentexport.js +1 -1
package/dist/format.d.ts +29 -0
package/dist/utils.d.ts +1 -0
package/index.format.html +100 -0
package/package.json +1 -1
package/src/excellentexport.ts +35 -3
package/src/format.ts +52 -0
package/src/utils.ts +145 -141
package/test/convert.format.ts +56 -0

package/dist/format.d.ts ADDED Viewed

@@ -0,0 +1,29 @@
+export declare enum CellType {
+    TEXT = "s",
+    NUMBER = "n",
+    DATE = "d",
+    BOOLEAN = "b"
+}
+export declare enum CellPattern {
+    INTEGER = "0",
+    DECIMAL = "0.00",
+    DATE = "dd/mm/yyyy",
+    TIME = "hh:mm:ss",
+    DATETIME = "dd/mm/yyyy hh:mm:ss",
+    CURRENCY = "[$$-409]#,##0.00;[RED]-[$$-409]#,##0.00",
+    PERCENTAGE = "0.00%",
+    EXPONENT = "0.00E+00",
+    TEXT = "@"
+}
+export interface CellFormat {
+    type: CellType;
+    pattern?: CellPattern;
+}
+export interface CellFormats {
+    [key: string]: CellFormat;
+}
+export declare const PredefinedFormat: CellFormats;
+export interface FormatDefinition {
+    range: string;
+    format?: CellFormat;
+}

package/dist/utils.d.ts CHANGED Viewed

@@ -27,3 +27,4 @@ export declare const tableToCSV: (table: HTMLTableElement, csvDelimiter?: string
 export declare const createDownloadLink: (anchor: HTMLAnchorElement, base64data: string, exporttype: string, filename: string) => boolean;
 export declare const string2ArrayBuffer: (s: string) => ArrayBuffer;
 export declare const removeColumns: (dataArray: any[][], columnIndexes: number[]) => void;
+export declare const hasContent: (value: any) => boolean;

package/index.format.html ADDED Viewed

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title>Export to excel test</title>
+        <script src="dist/excellentexport.js"></script>
+        <style>
+            table, tr, td {
+                border: 1px black solid;
+            }
+        </style>
+        <script>
+            function newApi(format) {
+                return ExcellentExport.convert({
+                    anchor: 'anchorNewApi-' + format,
+                    filename: 'data',
+                    format: format
+                }, [{
+                    name: 'Formatted Sheet',
+                    from: {
+                        table: 'datatable'
+                    },
+                    formats: [
+                        { range: "A2:A10", format: ExcellentExport.formats.INTEGER },
+                        { range: "B2:B10", format: ExcellentExport.formats.TEXT },
+                        { range: "C2:C10", format: ExcellentExport.formats.DATE },
+                        { range: "D2:D10", format: ExcellentExport.formats.DECIMAL },
+                        { range: "E2:E10", format: ExcellentExport.formats.BOOLEAN },
+                        { range: "F2:F10", format: ExcellentExport.formats.INTEGER },
+                        { range: "A5:E5", format: ExcellentExport.formats.TEXT },
+                        { range: "A6", format: ExcellentExport.formats.DECIMAL },
+                    ],
+                }]);
+            }
+        </script>
+    </head>
+    <body>
+        <h1>ExcellentExport.js</h1>
+        <h3>Test page</h3>
+        Test table:
+        <table id="datatable">
+            <tr>
+                <th>ID</th>
+                <th>Name</th>
+                <th>Birthdate</th>
+                <th>Salary</th>
+                <th>Active</th>
+                <th>Big number</th>
+            </tr>
+            <tr>
+                <td>1</td>
+                <td>John</td>
+                <td>1980-12-10</td>
+                <td>98762000.55</td>
+                <td>1</td>
+                <td>987654321987654</td>
+            </tr>
+            <tr>
+                <td>2</td>
+                <td>Peter</td>
+                <td>1978-01-23</td>
+                <td>98762500.43</td>
+                <td>0</td>
+                <td>876543219987654</td>
+            </tr>
+            <tr>
+                <td>3</td>
+                <td>George</td>
+                <td>1985-11-30</td>
+                <td>98761800.98</td>
+                <td>1</td>
+                <td>765432198987654</td>
+            </tr>
+            <tr>
+                <td>End</td>
+                <td>End</td>
+                <td>End</td>
+                <td>End</td>
+                <td>End</td>
+                <td>End</td>
+            </tr>
+            <tr>
+                <td>9876543.21</td>
+                <td></td>
+                <td></td>
+                <td></td>
+                <td></td>
+                <td></td>
+            </tr>
+        </table>
+        <br/>
+        <a href="#" id="anchorNewApi-xlsx" onclick="return newApi('xlsx');">Export Excel</a>
+        <a href="#" id="anchorNewApi-csv" onclick="return newApi('csv');">Export CSV</a>
+    </body>
+</html>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "excellentexport",
-  "version": "3.8.1",
+  "version": "3.9.0",
   "description": "Client side JavaScript export to Excel or CSV",
   "license": "MIT",
   "homepage": "http://jordiburgos.com",

package/src/excellentexport.ts CHANGED Viewed

@@ -8,6 +8,7 @@
  */
 import * as XLSX from 'xlsx';
+import { CellType, FormatDefinition, PredefinedFormat } from './format';
 import * as utils from './utils';
@@ -29,6 +30,7 @@ export interface FromOptions {
     table?: (string|HTMLTableElement),
     array?: any[][],
 }
 export interface SheetOptions {
     name: string,
     from: FromOptions,
@@ -36,13 +38,13 @@ export interface SheetOptions {
     filterRowFn?(row:any[]): boolean ,
     fixValue?(value:any, row:number, column:number): any,
     fixArray?(array:any[][]): any[][],
-    rtl?: boolean
+    rtl?: boolean,
+    formats?: (FormatDefinition | null)[],
 }
 const ExcellentExport = function() {
-    const version = "3.8.1";
+    const version = "3.9.0";
     /*
      ExcellentExport.convert(options, sheets);
@@ -138,6 +140,35 @@ const ExcellentExport = function() {
             // Create sheet
             workbook.SheetNames.push(name);
             const worksheet = XLSX.utils.aoa_to_sheet(dataArray, {sheet: name} as XLSX.AOA2SheetOpts);
+            // Apply format
+            if (sheetConf.formats) {
+                sheetConf.formats.forEach(f => {
+                    const range = XLSX.utils.decode_range(f.range);
+                    for (let R = range.s.r; R <= range.e.r; ++R) {
+                        for (let C = range.s.c; C <= range.e.c; ++C) {
+                            const cell = worksheet[XLSX.utils.encode_cell({r: R, c: C})];
+                            if (cell && utils.hasContent(cell.v)) {
+                                // type
+                                cell.t = f.format.type;
+                                // type fix
+                                if (f.format?.type == CellType.BOOLEAN) {
+                                    const v = cell.v.toString().toLowerCase();
+                                    if (v == 'true' || v == '1') cell.v = true;
+                                    if (v == 'false' || v == '0') cell.v = false;
+                                }
+                                // pattern
+                                if (f.format?.pattern) {
+                                    cell.z = f.format.pattern;
+                                }
+                            }
+                        }
+                    }
+                });
+            }
             workbook.Sheets[name] = worksheet;
             workbook.Views.push({RTL: options.rtl || sheetConf.rtl || false});
         });
@@ -177,6 +208,7 @@ const ExcellentExport = function() {
         version: function(): string {
             return version;
         },
+        formats: PredefinedFormat,
         excel: function(anchor:(HTMLAnchorElement|string), table:HTMLTableElement, name:string) {
             table = utils.getTable(table);
             anchor = utils.getAnchor(anchor);

package/src/format.ts ADDED Viewed

@@ -0,0 +1,52 @@
+export enum CellType {
+    TEXT = 's',
+    NUMBER = 'n',
+    DATE = 'd',
+    BOOLEAN = 'b',
+}
+export enum CellPattern {
+    INTEGER = '0',
+    DECIMAL = '0.00',
+    DATE = 'dd/mm/yyyy',
+    TIME = 'hh:mm:ss',
+    DATETIME = 'dd/mm/yyyy hh:mm:ss',
+    CURRENCY = '[$$-409]#,##0.00;[RED]-[$$-409]#,##0.00',
+    PERCENTAGE = '0.00%',
+    EXPONENT = '0.00E+00',
+    TEXT = '@',
+}
+export interface CellFormat {
+    type: CellType,
+    pattern?: CellPattern,
+}
+// Define structure for predefined formats
+export interface CellFormats {
+    [key: string]: CellFormat
+}
+export const PredefinedFormat : CellFormats = {
+    NUMBER: { type: CellType.NUMBER},
+    INTEGER: { type: CellType.NUMBER, pattern: CellPattern.INTEGER },
+    DECIMAL: { type: CellType.NUMBER, pattern: CellPattern.DECIMAL },
+    CURRENCY: { type: CellType.NUMBER, pattern: CellPattern.CURRENCY },
+    PERCENTAGE: { type: CellType.NUMBER, pattern: CellPattern.PERCENTAGE },
+    EXPONENT: { type: CellType.NUMBER, pattern: CellPattern.EXPONENT },
+    DATE: { type: CellType.DATE, pattern: CellPattern.DATE },
+    TIME: { type: CellType.DATE, pattern: CellPattern.TIME },
+    DATETIME: { type: CellType.DATE, pattern: CellPattern.DATETIME },
+    TEXT: { type: CellType.TEXT, pattern: CellPattern.TEXT },
+    BOOLEAN: { type: CellType.BOOLEAN },
+}
+export interface FormatDefinition {
+    range: string,
+    format?: CellFormat,
+}

package/src/utils.ts CHANGED Viewed

@@ -1,141 +1,145 @@
-export const b64toBlob = function (b64Data:string, contentType:string, sliceSize?:number): Blob {
-    // function taken from http://stackoverflow.com/a/16245768/2591950
-    // author Jeremy Banks http://stackoverflow.com/users/1114/jeremy-banks
-    contentType = contentType || '';
-    sliceSize = sliceSize || 512;
-    const byteCharacters = atob(b64Data);
-    const byteArrays = [];
-    for (let offset = 0; offset < byteCharacters.length; offset += sliceSize) {
-        const slice = byteCharacters.slice(offset, offset + sliceSize);
-        const byteNumbers = new Array(slice.length);
-        for (let i = 0; i < slice.length; i = i + 1) {
-            byteNumbers[i] = slice.charCodeAt(i);
-        }
-        const byteArray = new Uint8Array(byteNumbers);
-        byteArrays.push(byteArray);
-    }
-    return new Blob(byteArrays, {
-        type: contentType
-    });
-};
-export const templates = {excel: '<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns="http://www.w3.org/TR/REC-html40"><head><meta name=ProgId content=Excel.Sheet> <meta name=Generator content="Microsoft Excel 11"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><!--[if gte mso 9]><xml><x:ExcelWorkbook><x:ExcelWorksheets><x:ExcelWorksheet><x:Name>{worksheet}</x:Name><x:WorksheetOptions><x:DisplayGridlines/></x:WorksheetOptions></x:ExcelWorksheet></x:ExcelWorksheets></x:ExcelWorkbook></xml><![endif]--></head><body><table>{table}</table></body></html>'};
-/**
- * Convert a string to Base64.
- */
-export const base64 = function(s:string) : string {
-    return btoa(unescape(encodeURIComponent(s)));
-};
-export const format = function(s:string, context:any) : string {
-    return s.replace(new RegExp("{(\\w+)}", "g"), function(m, p) {
-        return context[p] || "{" + p + "}";
-    });
-};
-/**
- * Get element by ID.
- * @param {*} element
- */
- export const getTable = function(element :(HTMLTableElement|string)) : HTMLTableElement {
-    if (typeof element === 'string') {
-        return document.getElementById(element) as HTMLTableElement;
-    }
-    return element;
-};
-/**
- * Get element by ID.
- * @param {*} element
- */
-export const getAnchor = function(element :(HTMLAnchorElement|string)) : HTMLAnchorElement {
-    if (typeof element === 'string') {
-        return document.getElementById(element) as HTMLAnchorElement;
-    }
-    return element;
-};
-/**
- * Encode a value for CSV.
- * @param {*} value
- */
- export const fixCSVField = function(value:string, csvDelimiter:string) : string {
-    let fixedValue = value;
-    const addQuotes = (value.indexOf(csvDelimiter) !== -1) || (value.indexOf('\r') !== -1) || (value.indexOf('\n') !== -1);
-    const replaceDoubleQuotes = (value.indexOf('"') !== -1);
-    if (replaceDoubleQuotes) {
-        fixedValue = fixedValue.replace(/"/g, '""');
-    }
-    if (addQuotes || replaceDoubleQuotes) {
-        fixedValue = '"' + fixedValue + '"';
-    }
-    return fixedValue;
-};
-export const tableToArray = function(table:HTMLTableElement) : any[][] {
-    let tableInfo = Array.prototype.map.call(table.querySelectorAll('tr'), function(tr) {
-        return Array.prototype.map.call(tr.querySelectorAll('th,td'), function(td) {
-            return td.innerHTML;
-        });
-    });
-    return tableInfo;
-};
-export const tableToCSV = function(table:HTMLTableElement, csvDelimiter:string = ',', csvNewLine:string = '\n') : string {
-    let data = "";
-    for (let i = 0; i < table.rows.length; i=i+1) {
-        const row = table.rows[i];
-        for (let j = 0; j < row.cells.length; j=j+1) {
-            const col = row.cells[j];
-            data = data + (j ? csvDelimiter : '') + fixCSVField(col.textContent.trim(), csvDelimiter);
-        }
-        data = data + csvNewLine;
-    }
-    return data;
-};
-export const createDownloadLink = function(anchor:HTMLAnchorElement, base64data:string, exporttype:string, filename:string) : boolean {
-    if (window.navigator.msSaveBlob) {
-        const blob = b64toBlob(base64data, exporttype);
-        window.navigator.msSaveBlob(blob, filename);
-        return false;
-    } else if (window.URL.createObjectURL) {
-        const blob = b64toBlob(base64data, exporttype);
-        anchor.href = window.URL.createObjectURL(blob);
-    } else {
-        anchor.download = filename;
-        anchor.href = "data:" + exporttype + ";base64," + base64data;
-    }
-    // Return true to allow the link to work
-    return true;
-};
-// String to ArrayBuffer
-export const string2ArrayBuffer = function (s:string): ArrayBuffer {
-    let buf = new ArrayBuffer(s.length);
-    let view = new Uint8Array(buf);
-    for (let i=0; i !== s.length; ++i) {
-        view[i] = s.charCodeAt(i) & 0xFF;
-    }
-    return buf;
-};
-export const removeColumns = function(dataArray:any[][], columnIndexes:number[]) {
-    const uniqueIndexes = [...new Set(columnIndexes)].sort().reverse();
-    uniqueIndexes.forEach(function(columnIndex) {
-        dataArray.forEach(function(row) {
-            row.splice(columnIndex, 1);
-        });
-    });
-};
+export const b64toBlob = function (b64Data:string, contentType:string, sliceSize?:number): Blob {
+    // function taken from http://stackoverflow.com/a/16245768/2591950
+    // author Jeremy Banks http://stackoverflow.com/users/1114/jeremy-banks
+    contentType = contentType || '';
+    sliceSize = sliceSize || 512;
+    const byteCharacters = atob(b64Data);
+    const byteArrays = [];
+    for (let offset = 0; offset < byteCharacters.length; offset += sliceSize) {
+        const slice = byteCharacters.slice(offset, offset + sliceSize);
+        const byteNumbers = new Array(slice.length);
+        for (let i = 0; i < slice.length; i = i + 1) {
+            byteNumbers[i] = slice.charCodeAt(i);
+        }
+        const byteArray = new Uint8Array(byteNumbers);
+        byteArrays.push(byteArray);
+    }
+    return new Blob(byteArrays, {
+        type: contentType
+    });
+};
+export const templates = {excel: '<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns="http://www.w3.org/TR/REC-html40"><head><meta name=ProgId content=Excel.Sheet> <meta name=Generator content="Microsoft Excel 11"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><!--[if gte mso 9]><xml><x:ExcelWorkbook><x:ExcelWorksheets><x:ExcelWorksheet><x:Name>{worksheet}</x:Name><x:WorksheetOptions><x:DisplayGridlines/></x:WorksheetOptions></x:ExcelWorksheet></x:ExcelWorksheets></x:ExcelWorkbook></xml><![endif]--></head><body><table>{table}</table></body></html>'};
+/**
+ * Convert a string to Base64.
+ */
+export const base64 = function(s:string) : string {
+    return btoa(unescape(encodeURIComponent(s)));
+};
+export const format = function(s:string, context:any) : string {
+    return s.replace(new RegExp("{(\\w+)}", "g"), function(m, p) {
+        return context[p] || "{" + p + "}";
+    });
+};
+/**
+ * Get element by ID.
+ * @param {*} element
+ */
+ export const getTable = function(element :(HTMLTableElement|string)) : HTMLTableElement {
+    if (typeof element === 'string') {
+        return document.getElementById(element) as HTMLTableElement;
+    }
+    return element;
+};
+/**
+ * Get element by ID.
+ * @param {*} element
+ */
+export const getAnchor = function(element :(HTMLAnchorElement|string)) : HTMLAnchorElement {
+    if (typeof element === 'string') {
+        return document.getElementById(element) as HTMLAnchorElement;
+    }
+    return element;
+};
+/**
+ * Encode a value for CSV.
+ * @param {*} value
+ */
+ export const fixCSVField = function(value:string, csvDelimiter:string) : string {
+    let fixedValue = value;
+    const addQuotes = (value.indexOf(csvDelimiter) !== -1) || (value.indexOf('\r') !== -1) || (value.indexOf('\n') !== -1);
+    const replaceDoubleQuotes = (value.indexOf('"') !== -1);
+    if (replaceDoubleQuotes) {
+        fixedValue = fixedValue.replace(/"/g, '""');
+    }
+    if (addQuotes || replaceDoubleQuotes) {
+        fixedValue = '"' + fixedValue + '"';
+    }
+    return fixedValue;
+};
+export const tableToArray = function(table:HTMLTableElement) : any[][] {
+    let tableInfo = Array.prototype.map.call(table.querySelectorAll('tr'), function(tr) {
+        return Array.prototype.map.call(tr.querySelectorAll('th,td'), function(td) {
+            return td.innerHTML;
+        });
+    });
+    return tableInfo;
+};
+export const tableToCSV = function(table:HTMLTableElement, csvDelimiter:string = ',', csvNewLine:string = '\n') : string {
+    let data = "";
+    for (let i = 0; i < table.rows.length; i=i+1) {
+        const row = table.rows[i];
+        for (let j = 0; j < row.cells.length; j=j+1) {
+            const col = row.cells[j];
+            data = data + (j ? csvDelimiter : '') + fixCSVField(col.textContent.trim(), csvDelimiter);
+        }
+        data = data + csvNewLine;
+    }
+    return data;
+};
+export const createDownloadLink = function(anchor:HTMLAnchorElement, base64data:string, exporttype:string, filename:string) : boolean {
+    if (window.navigator.msSaveBlob) {
+        const blob = b64toBlob(base64data, exporttype);
+        window.navigator.msSaveBlob(blob, filename);
+        return false;
+    } else if (window.URL.createObjectURL) {
+        const blob = b64toBlob(base64data, exporttype);
+        anchor.href = window.URL.createObjectURL(blob);
+    } else {
+        anchor.download = filename;
+        anchor.href = "data:" + exporttype + ";base64," + base64data;
+    }
+    // Return true to allow the link to work
+    return true;
+};
+// String to ArrayBuffer
+export const string2ArrayBuffer = function (s:string): ArrayBuffer {
+    let buf = new ArrayBuffer(s.length);
+    let view = new Uint8Array(buf);
+    for (let i=0; i !== s.length; ++i) {
+        view[i] = s.charCodeAt(i) & 0xFF;
+    }
+    return buf;
+};
+export const removeColumns = function(dataArray:any[][], columnIndexes:number[]) {
+    const uniqueIndexes = [...new Set(columnIndexes)].sort().reverse();
+    uniqueIndexes.forEach(function(columnIndex) {
+        dataArray.forEach(function(row) {
+            row.splice(columnIndex, 1);
+        });
+    });
+};
+export const hasContent = function(value:any) : boolean {
+    return value !== undefined && value !== null && value !== "";
+}

package/test/convert.format.ts ADDED Viewed

@@ -0,0 +1,56 @@
+const assert = require('assert');
+import ExcellentExport, { ConvertOptions, SheetOptions } from '../src/excellentexport';
+import { PredefinedFormat } from '../src/format';
+describe('convert() API with column formats', function() {
+    beforeEach(() => {
+        window.URL.createObjectURL = () => "blob:fake_URL";
+        document.body.innerHTML = '';
+        const element = document.createElement("div");
+        element.innerHTML = '<a id="anchor">Link</a>';
+        document.body.appendChild(element);
+    });
+    it('should create a XLSX with types', function() {
+        const options = {
+            anchor: 'anchor',
+            filename: 'data_from_array',
+            format: 'xlsx'
+        } as ConvertOptions;
+        const sheets = [
+            {
+                name: 'People',
+                from: {
+                    array: [
+                        ["ID", "Name", "Birthdate", "Active", "Salary"],
+                        [11, "John", "1980-01-01", true, 1000.98],
+                        [22, "Mary", "1985-02-02", false, 2000.88],
+                        [33, "Peter", "1990-03-03", true, 3000.32],
+                    ]
+                },
+                formats: [
+                    { range: 'A2:A10', format: PredefinedFormat.INTEGER },
+                    { range: 'C2:C10', format: PredefinedFormat.DATE },
+                    { range: 'D2:D10', format: PredefinedFormat.BOOLEAN },
+                    { range: 'E2:E10', format: PredefinedFormat.DECIMAL },
+                ]
+            },
+        ] as SheetOptions[];
+        const workbook = ExcellentExport.convert(options, sheets);
+        assert.ok(workbook, 'Result must not be null');
+        const anchor = document.getElementById('anchor') as HTMLAnchorElement;
+        assert.ok(anchor.href, 'Element must have href');
+        assert.ok(anchor.href.indexOf('blob:') === 0, 'Element href myst be a blob:');
+    });
+});