@gatekeeper_technology/excel-utils 1.0.0 → 1.0.1

package/index.js

@@ -0,0 +1,158 @@
+import ExcelJS from "exceljs";
+
+module.exports = {
+    getWorkbookData,
+    generateXLSXBuffer,
+    WorkbookCreator
+}
+
+class WorkbookCreator {
+    constructor() {
+
+    }
+    /**
+     * Create a new workbook
+     * @returns {ExcelJS.Workbook} The created workbook
+     */
+    createWorkbook() {
+        const workbook = new ExcelJS.Workbook();
+        workbook.creator = "Gatekeeper Technology";
+        workbook.lastModifiedBy = "Gatekeeper Technology";
+        workbook.created = new Date();
+        workbook.modified = new Date();
+        workbook.properties.date1904 = true;
+        workbook.calcProperties.fullCalcOnLoad = true;
+        // workbook.lastPrinted = new Date(2016, 9, 27);
+
+        workbook.views = [
+            {
+                x: 0,
+                y: 0,
+                width: 10000,
+                height: 20000,
+                firstSheet: 0,
+                activeTab: 1,
+                visibility: "visible",
+            },
+        ];
+
+        return workbook;
+    }
+
+    /**
+     * Create a new workbook
+     * @param {ExcelJS.Workbook} workbook Workbook
+     * @returns {ExcelJS.Worksheet} The created workbook
+     */
+    createWorksheet(workbook, worksheet_name) {
+        const worksheet = workbook.addWorksheet(worksheet_name ? worksheet_name : 'sheet', {
+            pageSetup: { paperSize: 9, orientation: "landscape" },
+        });
+
+        return worksheet;
+    }
+
+    /**
+     * Create a new workbook
+     * @param {ExcelJS.Worksheet} worksheet Worksheet
+     * @param {string[][]} data Data array
+     * @returns {ExcelJS.Worksheet} The created workbook
+     */
+    loadDataIntoWorksheet(worksheet, data) {
+        for (let [_index, _row_data] of data.entries()) {
+            // Get a row object. If it doesn't already exist, a new empty one will be returned
+            let row = worksheet.getRow(_index + 1);
+            row.values = _row_data;
+        }
+
+        return worksheet;
+    }
+
+    /**
+     * Save workbook as XLSX
+     * @param {ExcelJS.Workbook} workbook Workbook
+     * @param {string} filename The filename
+     */
+    async saveXLSXWorkbook(workbook, filename) {
+        await workbook.xlsx.writeFile(filename);
+    }
+
+    /**
+     * Get array buffer data
+     * @param {ExcelJS.Workbook} workbook Workbook
+     */
+    async getXLSXWorkbookBuffer(workbook) {
+        // write to a new buffer
+        const uint8array = (await workbook.xlsx.writeBuffer());
+        return uint8array.buffer;
+    }
+
+    /**
+     * Converts Workbook Buffer into a ExcelJS.Workbook
+     * @param {Buffer} workbook_buffer - Workbook data in a Buffer
+     * @returns {Promise<ExcelJS.Workbook>}
+     */
+    async loadXLSX(workbook_buffer) {
+        const workbook = new ExcelJS.Workbook();
+        await workbook.xlsx.load(workbook_buffer);
+
+        return workbook;
+    }
+
+    /**
+     * Get the workbook's details
+     * @param {ExcelJS.Workbook} workbook
+     * @returns {Object} An object containing information of the workbook
+     */
+    getWorkbookDetails(workbook) {
+        if (!workbook) return null;
+        return {
+            created: workbook.created,
+            modified: workbook.modified,
+            title: workbook.title,
+            creator: workbook.creator,
+            company: workbook.company,
+            description: workbook.description,
+        };
+    }
+
+    /**
+     * Get the worksheet's details
+     * @param {ExcelJS.Worksheet} worksheet
+     * @returns {Object} An object containing information of the worksheet
+     */
+    getWorksheetDetails(worksheet) {
+        return {
+            id: worksheet.id,
+            properties: worksheet.properties,
+            name: worksheet.name,
+            state: worksheet.state,
+        };
+    }
+
+}
+
+async function generateXLSXBuffer(data, sheet_name) {
+    const workbook_creator = new WorkbookCreator();
+    let _workbook = workbook_creator.createWorkbook();
+    let _worksheet = workbook_creator.createWorksheet(_workbook, sheet_name);
+    workbook_creator.loadDataIntoWorksheet(_worksheet, data);
+    const _array_buffer = (await workbook_creator.getXLSXWorkbookBuffer(_workbook));
+    return _array_buffer;
+}
+
+/**
+ * Returns an array of all 
+ */
+async function getWorkbookData(data) {
+    const workbook_creator = new WorkbookCreator();
+    let _workbook = await workbook_creator.loadXLSX(data);
+    let _worksheet = _workbook.worksheets[0];
+
+    let rows_data = [];
+    _worksheet.eachRow((row) => {
+        rows_data.push(row.values);
+    });
+
+    return rows_data;
+}

package/package.json

@@ -1,9 +1,9 @@
 {
     "name": "@gatekeeper_technology/excel-utils",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "Gatekeeper's excel Utils - shared in NPM",
     "author": "David Holtzhausen",
-    "main": "./index.js",
+    "main": "index.js",
     "repository": {
       "type": "git",
       "url": "git+https://github.com/gatekeeper-technology/excel-utils.git"