@gatekeeper_technology/excel-utils 1.0.9 → 1.0.11

package/README.md

@@ -1,19 +1,47 @@
-# Gatekeeper's Excel Utils
-
-## Changelog
-### [1.00.09] 24-08-2022
-### Added
-- Ability to load data into worksheet with row offset.
-### [1.00.08] 24-08-2022
-### Added
-- Ability to get worksheet by name.
-- Ability to get worksheet by index.
-### [1.00.07] 24-08-2022
-### Fixed
-- Fixed bug where workbook_creator class was not exported properly. 
-### [1.00.05] 18-03-2022
-### Changed
-- Fixed import bug
-### [1.00.04] 18-03-2022
-#### Changed
-- Moved the functions and WorkbookCreator Class each to their own folder.
+# Gatekeeper's Excel Utils
+
+## Changelog
+
+### [1.0.11] 17-04-2025
+
+### Changed
+
+-   Changed the way the workbook_creator class gets exported.
+-   Removed 'date1904' property from the workbook_creator class.
+
+### [1.00.10] 24-08-2022
+
+### Fixed
+
+-   Bug with loadDataIntoWorksheetWithRowOffset function which did not load data correctly.
+
+### [1.00.09] 24-08-2022
+
+### Added
+
+-   Ability to load data into worksheet with row offset.
+
+### [1.00.08] 24-08-2022
+
+### Added
+
+-   Ability to get worksheet by name.
+-   Ability to get worksheet by index.
+
+### [1.00.07] 24-08-2022
+
+### Fixed
+
+-   Fixed bug where workbook_creator class was not exported properly.
+
+### [1.00.05] 18-03-2022
+
+### Changed
+
+-   Fixed import bug
+
+### [1.00.04] 18-03-2022
+
+#### Changed
+
+-   Moved the functions and WorkbookCreator Class each to their own folder.

package/index.js

@@ -1,7 +1,7 @@
-const workbookCreator = require("./workbook_creator.js");
-const utils = require("./utils.js");
-
-module.exports = {
-    utils,
-    workbookCreator
+const workbookCreator = require("./workbook_creator.js");
+const utils = require("./utils.js");
+
+module.exports = {
+    utils,
+    workbookCreator
 }

package/package.json

@@ -1,27 +1,28 @@
-{
-    "name": "@gatekeeper_technology/excel-utils",
-    "version": "1.0.9",
-    "description": "Gatekeeper's excel Utils - shared in NPM",
-    "author": "David Holtzhausen",
-    "main": "index.js",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/gatekeeper-technology/excel-utils.git"
-    },
-    "keywords": [
-        "excel",
-        "util",
-        "gatekeeper"
-    ],
-    "bugs": {
-        "url": "https://github.com/gatekeeper-technology/excel-utils/issues"
-    },
-    "homepage": "https://github.com/gatekeeper-technology/excel-utils#readme",
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "license": "ISC",
-    "dependencies": {
-        "exceljs": "^4.3.0"
-    }
-}
+{
+    "name": "@gatekeeper_technology/excel-utils",
+    "version": "1.0.11",
+    "description": "Gatekeeper's excel Utils - shared in NPM",
+    "author": "David Holtzhausen",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/gatekeeper-technology/excel-utils.git"
+    },
+    "keywords": [
+        "excel",
+        "util",
+        "gatekeeper"
+    ],
+    "bugs": {
+        "url": "https://github.com/gatekeeper-technology/excel-utils/issues"
+    },
+    "homepage": "https://github.com/gatekeeper-technology/excel-utils#readme",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "license": "ISC",
+    "dependencies": {
+        "@gatekeeper_technology/excel-utils": "file:",
+        "exceljs": "^4.3.0"
+    }
+}

package/utils.js

@@ -1,31 +1,31 @@
-const WorkbookCreator = require("./workbook_creator.js");
-
-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;
-}
-
-module.exports = {
-    generateXLSXBuffer,
-    getWorkbookData
-}
+const WorkbookCreator = require("./workbook_creator.js");
+
+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;
+}
+
+module.exports = {
+    generateXLSXBuffer,
+    getWorkbookData
+}

package/workbook_creator.js

@@ -1,166 +1,164 @@
-const ExcelJS = require("exceljs");
-
-let WorkbookCreator = class {
-    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;
-    }
-
-    /**
-     * Load data into worksheet 
-     * @param {ExcelJS.Worksheet} worksheet Worksheet
-     * @param {string[][]} data Data array
-     * @param {number} offset Number of rows to skip before writing data
-     * @returns {ExcelJS.Worksheet} The created workbook
-     */
-    loadDataIntoWorksheetWithRowOffset(worksheet, data, row_offset) {
-        for (let _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(row_offset + 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,
-        };
-    }
-
-    /**
-     * Gets worksheet with specified name within workbook
-     * @param {ExcelJS.Workbook} workbook
-     * @param {string} worksheet_name
-     * @returns {ExcelJS.Worksheet} Worksheet with specified name
-     */
-    getWorksheetByName(workbook, worksheet_name) {
-        return workbook.getWorksheet(worksheet_name);
-    }
-
-    /**
-     * Gets worksheet at specified index within workbook
-     * @param {ExcelJS.Workbook} workbook
-     * @param {number} index
-     * @returns {ExcelJS.Worksheet} Worksheet at specified index
-     */
-     getWorksheetByIndex(workbook, worksheet_index) {
-        return workbook.worksheets[worksheet_index];
-    }
-
-}
-
-module.exports = WorkbookCreator;
+const ExcelJS = require("exceljs");
+
+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 Worksheet
+     * @param {ExcelJS.Workbook} workbook Workbook
+     * @returns {ExcelJS.Worksheet} The created Worksheet
+     */
+    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;
+    }
+
+    /**
+     * Load data into worksheet with row offset
+     * @param {ExcelJS.Worksheet} worksheet Worksheet
+     * @param {string[][]} data Data array
+     * @param {number} offset Number of rows to skip before writing data
+     * @returns {ExcelJS.Worksheet} The created Worksheet
+     */
+    loadDataIntoWorksheetWithRowOffset(worksheet, data, row_offset) {
+        for (let [_index, _row_data] of data.entries()) {
+            let current_row_index = _index + row_offset;
+            // Get a row object. If it doesn't already exist, a new empty one will be returned
+            let row = worksheet.getRow(current_row_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,
+        };
+    }
+
+    /**
+     * Gets worksheet with specified name within workbook
+     * @param {ExcelJS.Workbook} workbook
+     * @param {string} worksheet_name
+     * @returns {ExcelJS.Worksheet} Worksheet with specified name
+     */
+    getWorksheetByName(workbook, worksheet_name) {
+        return workbook.getWorksheet(worksheet_name);
+    }
+
+    /**
+     * Gets worksheet at specified index within workbook
+     * @param {ExcelJS.Workbook} workbook
+     * @param {number} index
+     * @returns {ExcelJS.Worksheet} Worksheet at specified index
+     */
+    getWorksheetByIndex(workbook, worksheet_index) {
+        return workbook.worksheets[worksheet_index];
+    }
+}
+
+module.exports = WorkbookCreator;