to-spreadsheet 1.0.0 → 1.1.0

package/README.md

@@ -1,5 +1,10 @@
 # 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)
 
 
 # NPM
@@ -7,4 +12,25 @@ npm to package to create spreadsheet in node environment
 npm i to-spreadsheet
 ```
 
-https://www.npmjs.com/package/to-spreadsheet
+
+# Usage
+```ts
+import { generateExcel , EnvironmentType } 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, 2]] },
+  { title: 'Maifee3', content: [['meaw', "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,12 +12,16 @@ 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 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.BROWSER) => {
     const strings = [];
     const sheets = dump.map(({ title, content }) => {
         const rows = content.map(row => {
@@ -40,35 +44,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", function (err) {
+            if (err.code === "ENOENT") {
+            }
+            else {
+                reject(err);
+            }
+        });
+        archive.on("error", function (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,4 +1,4 @@
-import { generateExcel, generateExcelWorkbook } from "./generate-excel";
+import { generateExcel, EnvironmentType } from "./generate-excel";
 declare enum ICellType {
     string = "s",
     number = "n"
@@ -28,4 +28,4 @@ declare const sampleData: {
     title: string;
     content: (string[] | number[])[];
 }[];
-export { generateExcel, generateExcelWorkbook, sampleData };
+export { generateExcel, sampleData, EnvironmentType };

package/lib/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sampleData = exports.generateExcelWorkbook = exports.generateExcel = exports.ICellType = void 0;
+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; } });
 var ICellType;
 (function (ICellType) {
     ICellType["string"] = "s";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "to-spreadsheet",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "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,4 +1,4 @@
-import { generateExcel, generateExcelWorkbook } from "./generate-excel";
+import { generateExcel, EnvironmentType } from "./generate-excel";
 
 enum ICellType {
   string = "s",
@@ -47,6 +47,4 @@ const sampleData = [
   { title: 'Maifee3', content: [['meaw', "meaw"], ["woof", 'woof']] }
 ]
 
-// generateExcel(sampleData);
-
-export { generateExcel, generateExcelWorkbook, sampleData };
+export { generateExcel, sampleData, EnvironmentType };