to-spreadsheet 1.1.0 → 1.1.2

package/README.md

@@ -6,6 +6,8 @@ npm package to create spreadsheet in node environment
 [![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
 ```
@@ -14,8 +16,10 @@ npm i 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 } from 'to-spreadsheet/lib/index';
+import { generateExcel , EnvironmentType, skipCell } from 'to-spreadsheet/lib/index';
 
 const sampleData = [
   {
@@ -27,10 +31,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); // <-- by default generate XLSX for node
 generateExcel(sampleData, EnvironmentType.BROWSER); // <-- for browser
-```
+```

package/lib/generate-excel.js

@@ -12,6 +12,7 @@ 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 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) })), {}));
 };
@@ -21,19 +22,32 @@ var EnvironmentType;
     EnvironmentType[EnvironmentType["BROWSER"] = 1] = "BROWSER";
 })(EnvironmentType || (EnvironmentType = {}));
 exports.EnvironmentType = EnvironmentType;
-const generateExcel = (dump, environmentType = EnvironmentType.BROWSER) => {
+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 if (content instanceof util_1.Equation) {
+                    return { type: index_1.ICellType.equation, value: content };
+                }
+                else {
+                    return { type: index_1.ICellType.skip };
                 }
-                return { type, value };
             });
             return { cells };
         });
@@ -68,14 +82,14 @@ const generateExcelWorkbookNode = (workbook) => {
         output.on("end", () => {
             console.debug("Data has been drained");
         });
-        archive.on("warning", function (err) {
+        archive.on("warning", (err) => {
             if (err.code === "ENOENT") {
             }
             else {
                 reject(err);
             }
         });
-        archive.on("error", function (err) {
+        archive.on("error", (err) => {
             reject(err);
         });
         archive.pipe(output);

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,13 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnvironmentType = exports.sampleData = exports.generateExcel = exports.ICellType = void 0;
+exports.writeEquation = 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, "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; } });
+Object.defineProperty(exports, "writeEquation", { enumerable: true, get: function () { return util_1.writeEquation; } });
 var ICellType;
 (function (ICellType) {
     ICellType["string"] = "s";
     ICellType["number"] = "n";
+    ICellType["skip"] = "skip";
+    ICellType["equation"] = "equation";
 })(ICellType || (ICellType = {}));
 exports.ICellType = ICellType;
 const sampleData = [
@@ -17,10 +22,10 @@ const sampleData = [
             ['woof', 'smack'],
             [1],
             [1, 2],
-            [1, 2, 3],
+            [1, 2, 3, (0, util_1.writeEquation)('SUM(A5,C5)')],
         ]
     },
-    { 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,16 @@ 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;
+declare class Equation {
+    private equation;
+    getEquation: () => string;
+    constructor(equation: string);
+}
+declare const writeEquation: (equation: string) => Equation;
+export { indexToVbIndex, indexToVbRelationIndex, indexToRowIndex, rowColumnToVbPosition, calculateExtant, SkipCell, skipCell, Equation, writeEquation };

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.writeEquation = exports.Equation = 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,21 @@ 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;
+class Equation {
+    constructor(equation) {
+        this.getEquation = () => this.equation;
+        this.equation = equation;
+    }
+}
+exports.Equation = Equation;
+const writeEquation = (equation) => new Equation(equation);
+exports.writeEquation = writeEquation;

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"?>
@@ -19,14 +20,33 @@ const generateSheetXml = (sheet) => {
     <col max="1025" min="1" style="0" width="11.52"/>
   </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>
-      `).join('\n')}
-    </row>
-    `).join('\n')}
-  </sheetData>
+  ${sheet.rows.map((row, rowIndex) => {
+        let rowContent = '';
+        rowContent += `<row r="${(0, util_1.indexToVbIndex)(rowIndex)}">\n`;
+        row.cells.forEach((cell, cellIndex) => {
+            const cellType = cell.type;
+            if (cellType !== __1.ICellType.skip) {
+                const cellPosition = (0, util_1.rowColumnToVbPosition)(cellIndex, rowIndex);
+                const cellValue = cell.value || '';
+                if (cell.type === __1.ICellType.equation) {
+                    rowContent += `
+              <c r="${cellPosition}" t="n">
+                <f aca="false">${cell.value.getEquation()}</f>
+              </c>\n`;
+                }
+                else {
+                    rowContent += `
+              <c r="${cellPosition}" t="${cellType}">
+                <v>${cellValue}</v>
+              </c>\n`;
+                }
+            }
+        });
+        rowContent += '</row>\n';
+        return rowContent;
+    }).join('')}
+</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.1.0",
+  "version": "1.1.2",
   "description": "npm package to create spreadsheet in node environment",
   "main": "src/index.ts",
   "scripts": {

package/src/index.ts

@@ -1,15 +1,31 @@
 import { generateExcel, EnvironmentType } from "./generate-excel";
+import { SkipCell, skipCell, Equation, writeEquation } from "./util";
 
 enum ICellType {
   string = "s",
-  number = "n"
+  number = "n",
+  skip = "skip",
+  equation = "equation",
 }
 
-interface ICell {
-  type: ICellType;
-  value: any;
+interface ICellString {
+  type: ICellType.string;
+  value: number;
+}
+interface ICellNumber {
+  type: ICellType.number;
+  value: number;
+}
+interface ICellSkip {
+  type: ICellType.skip;
+}
+interface ICellEquation {
+  type: ICellType.equation;
+  value: Equation;
 }
 
+type ICell = ICellString | ICellNumber | ICellSkip | ICellEquation;
+
 interface IRows {
   cells: ICell[];
 }
@@ -27,7 +43,7 @@ interface IWorkbook {
 
 interface IPage {
   title: string
-  content: (string | number)[][]
+  content: (string | number | undefined | SkipCell | Equation)[][]
 }
 
 export { ICell, ISheet, IWorkbook, IRows, ICellType, IPage }
@@ -40,11 +56,13 @@ const sampleData = [
       ['woof', 'smack'],
       [1],
       [1, 2],
-      [1, 2, 3],
+      [1, 2, 3, writeEquation('SUM(A5,C5)')],
     ]
   },
-  { 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']] }
 ]
 
-export { generateExcel, sampleData, EnvironmentType };
+// generateExcel(sampleData) // <- check before releasing with `yarn test:compile`
+
+export { generateExcel, sampleData, EnvironmentType, skipCell, writeEquation };