to-spreadsheet 1.0.0 → 1.1.1

package/README.md

@@ -1,10 +1,40 @@
 # to-spreadsheet
-npm to package to create spreadsheet in node environment
+npm package to create spreadsheet in node environment
 
 
+[![npm version](https://img.shields.io/npm/v/to-spreadsheet.svg)](https://www.npmjs.com/package/to-spreadsheet)
+[![minified](https://badgen.net/bundlephobia/min/to-spreadsheet)](https://bundlephobia.com/result?p=to-spreadsheet)
+[![minified + gzipped](https://badgen.net/bundlephobia/minzip/to-spreadsheet)](https://bundlephobia.com/result?p=to-spreadsheet)
+
+[![GitHub stars](https://img.shields.io/github/stars/maifeeulasad/to-spreadsheet)](https://github.com/maifeeulasad/to-spreadsheet/stargazers)
+[![GitHub watchers](https://img.shields.io/github/watchers/maifeeulasad/to-spreadsheet)](https://github.com/maifeeulasad/to-spreadsheet/watchers)
+
 # NPM
 ```
 npm i to-spreadsheet
 ```
 
-https://www.npmjs.com/package/to-spreadsheet
+
+# Usage
+[![Open in CodeSandbox](https://img.shields.io/badge/Open%20in-CodeSandbox-blue?logo=codesandbox)](https://codesandbox.io/s/to-spreadsheet-example-hdmrvc?file=/src/App.tsx)
+
+```ts
+import { generateExcel , EnvironmentType, skipCell } from 'to-spreadsheet/lib/index';
+
+const sampleData = [
+  {
+    title: 'Maifee1', content: [
+      ['meaw', 'grrr'],
+      ['woof', 'smack'],
+      [1],
+      [1, 2],
+      [1, 2, 3],
+    ]
+  },
+  { title: 'Maifee2', content: [[1], [1, skipCell(3), 2]] },
+  { title: 'Maifee3', content: [['meaw', undefined, "meaw"], ["woof", 'woof']] }
+]
+
+generateExcel(sampleData); // <-- by default generate XLSX for node
+generateExcel(sampleData, EnvironmentType.BROWSER); // <-- for browser
+```

package/lib/generate-excel.d.ts

@@ -1,4 +1,7 @@
-import { IPage, IWorkbook } from "./index";
-declare const generateExcel: (dump: IPage[]) => void;
-declare const generateExcelWorkbook: (workbook: IWorkbook) => void;
-export { generateExcel, generateExcelWorkbook };
+import { IPage } from "./index";
+declare enum EnvironmentType {
+    NODE = 0,
+    BROWSER = 1
+}
+declare const generateExcel: (dump: IPage[], environmentType?: EnvironmentType) => Promise<void>;
+export { generateExcel, EnvironmentType };

package/lib/generate-excel.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateExcelWorkbook = exports.generateExcel = void 0;
+exports.EnvironmentType = exports.generateExcel = void 0;
 const content_types_xml_1 = require("./content-types.xml");
 const _rels_1 = require("./_rels/.rels");
 const app_xml_1 = require("./docProps/app.xml");
@@ -12,24 +12,39 @@ const theme1_xml_1 = require("./xl/theme/theme1.xml");
 const workbook_xml_1 = require("./xl/workbook.xml");
 const sheet_xml_1 = require("./xl/worksheets/sheet.xml");
 const index_1 = require("./index");
-const fs = require("fs");
-const archiver = require("archiver");
+const util_1 = require("./util");
 const generateTree = (workbook) => {
     return Object.assign({ "[Content_Types].xml": (0, content_types_xml_1.generateContentTypesXml)(workbook), "_rels/.rels": (0, _rels_1.generateRels)(), "docProps/app.xml": (0, app_xml_1.generateAppXml)(workbook), "docProps/core.xml": (0, core_xml_1.generateCoreXml)({}), "xl/_rels/workbook.xml.rels": (0, workbook_xml_rels_1.generateWorkBookXmlRels)(workbook), "xl/sharedStrings.xml": (0, sharedStrings_xml_1.generateSharedStrings)(workbook), "xl/styles.xml": (0, styles_xml_1.generateStyleXml)(), "xl/theme/theme1.xml": (0, theme1_xml_1.generateTheme1)(), "xl/workbook.xml": (0, workbook_xml_1.generateWorkBookXml)(workbook) }, workbook.sheets.reduce((acc, sheet, idx) => (Object.assign(Object.assign({}, acc), { [`xl/worksheets/sheet${idx + 1}.xml`]: (0, sheet_xml_1.generateSheetXml)(sheet) })), {}));
 };
-const generateExcel = (dump) => {
+var EnvironmentType;
+(function (EnvironmentType) {
+    EnvironmentType[EnvironmentType["NODE"] = 0] = "NODE";
+    EnvironmentType[EnvironmentType["BROWSER"] = 1] = "BROWSER";
+})(EnvironmentType || (EnvironmentType = {}));
+exports.EnvironmentType = EnvironmentType;
+const generateExcel = (dump, environmentType = EnvironmentType.NODE) => {
     const strings = [];
     const sheets = dump.map(({ title, content }) => {
         const rows = content.map(row => {
-            const cells = row.map(content => {
-                const isString = typeof content === 'string';
-                const type = isString ? index_1.ICellType.string : index_1.ICellType.number;
-                let value = isString ? strings.indexOf(content) : content;
-                if (isString && value === -1) {
-                    strings.push(content);
-                    value = strings.length - 1;
+            const cells = row.flatMap(content => {
+                if (typeof content === 'number') {
+                    return { type: index_1.ICellType.number, value: content };
+                }
+                else if (typeof content === 'string') {
+                    const type = index_1.ICellType.string;
+                    let value = strings.indexOf(content);
+                    if (value === -1) {
+                        strings.push(content);
+                        value = strings.length - 1;
+                    }
+                    return { type: index_1.ICellType.string, value };
+                }
+                else if (content instanceof util_1.SkipCell) {
+                    return new Array(content.getSkipCell()).fill({ type: index_1.ICellType.skip, value: undefined });
+                }
+                else {
+                    return { type: index_1.ICellType.skip, value: undefined };
                 }
-                return { type, value };
             });
             return { cells };
         });
@@ -40,35 +55,64 @@ const generateExcel = (dump) => {
         strings,
         filename: "tem.xlsx"
     };
-    generateExcelWorkbook(workbook);
+    if (environmentType === EnvironmentType.BROWSER) {
+        return generateExcelWorkbookBrowser(workbook);
+    }
+    else {
+        return generateExcelWorkbookNode(workbook);
+    }
 };
 exports.generateExcel = generateExcel;
-const generateExcelWorkbook = (workbook) => {
-    const output = fs.createWriteStream(`${__dirname}/${workbook.filename}.xlsx`);
-    const archive = archiver("zip", {
-        zlib: { level: 9 },
-    });
-    output.on("close", function () {
-        console.debug(archive.pointer() + " total bytes");
-        console.debug("archiver has been finalized and the output file descriptor has closed.");
-    });
-    output.on("end", function () {
-        console.debug("Data has been drained");
+const generateExcelWorkbookNode = (workbook) => {
+    return new Promise((resolve, reject) => {
+        const fs = require('fs');
+        const archiver = require('archiver');
+        const output = fs.createWriteStream(`${__dirname}/${workbook.filename}.xlsx`);
+        const archive = archiver("zip", {
+            zlib: { level: 9 },
+        });
+        output.on("close", () => {
+            console.debug(archive.pointer() + " total bytes");
+            console.debug("archiver has been finalized and the output file descriptor has closed.");
+            resolve();
+        });
+        output.on("end", () => {
+            console.debug("Data has been drained");
+        });
+        archive.on("warning", (err) => {
+            if (err.code === "ENOENT") {
+            }
+            else {
+                reject(err);
+            }
+        });
+        archive.on("error", (err) => {
+            reject(err);
+        });
+        archive.pipe(output);
+        Object.entries(generateTree(workbook)).map(([filename, fileContent]) => {
+            archive.append(fileContent, { name: filename });
+        });
+        archive.finalize();
     });
-    archive.on("warning", function (err) {
-        if (err.code === "ENOENT") {
+};
+const generateExcelWorkbookBrowser = (workbook) => {
+    return new Promise((resolve, reject) => {
+        try {
+            const JSZip = require('jszip');
+            const { saveAs } = require('file-saver');
+            const zip = new JSZip();
+            const tree = generateTree(workbook);
+            Object.entries(tree).forEach(([filename, fileContent]) => {
+                zip.file(filename, fileContent);
+            });
+            zip.generateAsync({ type: "blob" }).then((blob) => {
+                saveAs(blob, `${workbook.filename}.xlsx`);
+                resolve();
+            });
         }
-        else {
-            throw err;
+        catch (error) {
+            reject(error);
         }
     });
-    archive.on("error", function (err) {
-        throw err;
-    });
-    archive.pipe(output);
-    Object.entries(generateTree(workbook)).map(([filename, fileContent]) => {
-        archive.append(fileContent, { name: filename });
-    });
-    archive.finalize();
 };
-exports.generateExcelWorkbook = generateExcelWorkbook;

package/lib/index.d.ts

@@ -1,11 +1,13 @@
-import { generateExcel, generateExcelWorkbook } from "./generate-excel";
+import { generateExcel, EnvironmentType } from "./generate-excel";
+import { SkipCell, skipCell } from "./util";
 declare enum ICellType {
     string = "s",
-    number = "n"
+    number = "n",
+    skip = "skip"
 }
 interface ICell {
     type: ICellType;
-    value: any;
+    value: number | undefined;
 }
 interface IRows {
     cells: ICell[];
@@ -21,11 +23,17 @@ interface IWorkbook {
 }
 interface IPage {
     title: string;
-    content: (string | number)[][];
+    content: (string | number | undefined | SkipCell)[][];
 }
 export { ICell, ISheet, IWorkbook, IRows, ICellType, IPage };
-declare const sampleData: {
+declare const sampleData: ({
     title: string;
     content: (string[] | number[])[];
-}[];
-export { generateExcel, generateExcelWorkbook, sampleData };
+} | {
+    title: string;
+    content: (number | SkipCell)[][];
+} | {
+    title: string;
+    content: (string | undefined)[][];
+})[];
+export { generateExcel, sampleData, EnvironmentType, skipCell };

package/lib/index.js

@@ -1,13 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sampleData = exports.generateExcelWorkbook = exports.generateExcel = exports.ICellType = void 0;
+exports.skipCell = exports.EnvironmentType = exports.sampleData = exports.generateExcel = exports.ICellType = void 0;
 const generate_excel_1 = require("./generate-excel");
 Object.defineProperty(exports, "generateExcel", { enumerable: true, get: function () { return generate_excel_1.generateExcel; } });
-Object.defineProperty(exports, "generateExcelWorkbook", { enumerable: true, get: function () { return generate_excel_1.generateExcelWorkbook; } });
+Object.defineProperty(exports, "EnvironmentType", { enumerable: true, get: function () { return generate_excel_1.EnvironmentType; } });
+const util_1 = require("./util");
+Object.defineProperty(exports, "skipCell", { enumerable: true, get: function () { return util_1.skipCell; } });
 var ICellType;
 (function (ICellType) {
     ICellType["string"] = "s";
     ICellType["number"] = "n";
+    ICellType["skip"] = "skip";
 })(ICellType || (ICellType = {}));
 exports.ICellType = ICellType;
 const sampleData = [
@@ -20,7 +23,7 @@ const sampleData = [
             [1, 2, 3],
         ]
     },
-    { title: 'Maifee2', content: [[1], [1, 2]] },
-    { title: 'Maifee3', content: [['meaw', "meaw"], ["woof", 'woof']] }
+    { title: 'Maifee2', content: [[1], [1, (0, util_1.skipCell)(3), 2]] },
+    { title: 'Maifee3', content: [['meaw', undefined, "meaw"], ["woof", 'woof']] }
 ];
 exports.sampleData = sampleData;

package/lib/util.d.ts

@@ -4,4 +4,10 @@ declare const indexToVbRelationIndex: (index: number) => number;
 declare const indexToRowIndex: (index: number) => string;
 declare const rowColumnToVbPosition: (row: number, col: number) => string;
 declare const calculateExtant: (rows: IRows[]) => string;
-export { indexToVbIndex, indexToVbRelationIndex, indexToRowIndex, rowColumnToVbPosition, calculateExtant };
+declare class SkipCell {
+    private skipCell;
+    getSkipCell: () => number;
+    constructor(skipCell: number);
+}
+declare const skipCell: (skipCell: number) => SkipCell;
+export { indexToVbIndex, indexToVbRelationIndex, indexToRowIndex, rowColumnToVbPosition, calculateExtant, SkipCell, skipCell };

package/lib/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateExtant = exports.rowColumnToVbPosition = exports.indexToRowIndex = exports.indexToVbRelationIndex = exports.indexToVbIndex = void 0;
+exports.skipCell = exports.SkipCell = exports.calculateExtant = exports.rowColumnToVbPosition = exports.indexToRowIndex = exports.indexToVbRelationIndex = exports.indexToVbIndex = void 0;
 const indexToVbIndex = (index) => index + 1;
 exports.indexToVbIndex = indexToVbIndex;
 const indexToVbRelationIndex = (index) => indexToVbIndex(index) + 2;
@@ -20,3 +20,12 @@ const rowColumnToVbPosition = (row, col) => indexToRowIndex(indexToVbIndex(row))
 exports.rowColumnToVbPosition = rowColumnToVbPosition;
 const calculateExtant = (rows) => rowColumnToVbPosition(Math.max(...rows.map(row => row.cells.length)) - 1, rows.length - 1);
 exports.calculateExtant = calculateExtant;
+class SkipCell {
+    constructor(skipCell) {
+        this.getSkipCell = () => this.skipCell;
+        this.skipCell = skipCell;
+    }
+}
+exports.SkipCell = SkipCell;
+const skipCell = (skipCell) => new SkipCell(skipCell);
+exports.skipCell = skipCell;

package/lib/xl/worksheets/sheet.xml.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateSheetXml = void 0;
+const __1 = require("../..");
 const util_1 = require("../../util");
 const generateSheetXml = (sheet) => {
     return `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -20,12 +21,16 @@ const generateSheetXml = (sheet) => {
   </cols>
   <sheetData>
     ${(sheet.rows).map((row, indexCol) => `
-    <row r="${(0, util_1.indexToVbIndex)(indexCol)}">
-      ${(row.cells).map((cell, indexRow) => `
-      <c r="${(0, util_1.rowColumnToVbPosition)(indexRow, indexCol)}" t="${cell.type}"><v>${cell.value}</v></c>
+      <row r="${(0, util_1.indexToVbIndex)(indexCol)}">
+        ${(row.cells).map((cell, indexRow) => cell.type === __1.ICellType.skip
+        ? ""
+        : `
+          <c r="${(0, util_1.rowColumnToVbPosition)(indexRow, indexCol)}" t="${cell.type}">
+            <v>${cell.value}</v>
+          </c>
+          `).join('\n')}
+      </row>
       `).join('\n')}
-    </row>
-    `).join('\n')}
   </sheetData>
   <pageMargins left="0.7" right="0.7" top="0.75" bottom="0.75" header="0.3" footer="0.3"/>
 </worksheet>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "to-spreadsheet",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "npm package to create spreadsheet in node environment",
   "main": "src/index.ts",
   "scripts": {
@@ -19,11 +19,17 @@
   },
   "homepage": "https://github.com/maifeeulasad/to-spreadsheet#readme",
   "dependencies": {
-    "archiver": "^5.3.1",
-    "date-fns": "^2.29.3"
+    "archiver": "^6.0.1",
+    "date-fns": "^2.30.0",
+    "file-saver": "^2.0.5",
+    "jszip": "^3.10.1"
   },
-  "files": ["lib"],
+  "files": [
+    "lib"
+  ],
   "devDependencies": {
+    "@types/archiver": "^5.3.3",
+    "@types/file-saver": "^2.0.5",
     "@types/node": "^17.0.35",
     "ts-node": "^10.8.0",
     "typescript": "^4.7.2"

package/src/index.ts

@@ -1,13 +1,15 @@
-import { generateExcel, generateExcelWorkbook } from "./generate-excel";
+import { generateExcel, EnvironmentType } from "./generate-excel";
+import { SkipCell, skipCell } from "./util";
 
 enum ICellType {
   string = "s",
-  number = "n"
+  number = "n",
+  skip = "skip",
 }
 
 interface ICell {
   type: ICellType;
-  value: any;
+  value: number | undefined;
 }
 
 interface IRows {
@@ -27,7 +29,7 @@ interface IWorkbook {
 
 interface IPage {
   title: string
-  content: (string | number)[][]
+  content: (string | number | undefined | SkipCell)[][]
 }
 
 export { ICell, ISheet, IWorkbook, IRows, ICellType, IPage }
@@ -43,10 +45,10 @@ const sampleData = [
       [1, 2, 3],
     ]
   },
-  { title: 'Maifee2', content: [[1], [1, 2]] },
-  { title: 'Maifee3', content: [['meaw', "meaw"], ["woof", 'woof']] }
+  { title: 'Maifee2', content: [[1], [1, skipCell(3), 2]] },
+  { title: 'Maifee3', content: [['meaw', undefined, "meaw"], ["woof", 'woof']] }
 ]
 
-// generateExcel(sampleData);
+// generateExcel(sampleData) // <- check before releasing with `yarn test:compile`
 
-export { generateExcel, generateExcelWorkbook, sampleData };
+export { generateExcel, sampleData, EnvironmentType, skipCell };