sm-utility 2.2.11 → 2.2.12

package/excel/excel-parser/excelParser.d.ts

@@ -1,5 +1,12 @@
 import { IExcelParserData } from "../interfaces";
 export declare class ExcelParser {
+    /**
+   * Parse an excel table into JS objects
+   * uploadFolderPath refers to the absolute path of the folder, from the root, that will store the excel file temporarily.
+   * This need is a result of the middleware logic stored in the file Upload.middleware.ts of the core api
+   * @param data - refers to the data necessary to parse.
+   * @returns returns js objects
+   */
     parse<T = any>(data: IExcelParserData): Promise<T[][]>;
     private deleteFile;
 }

package/excel/excel-parser/excelParser.js

@@ -10,10 +10,17 @@ const path_1 = __importDefault(require("path"));
 const sheetExcelParser_1 = require("./sheetExcelParser");
 const logger_1 = require("../../logger");
 class ExcelParser {
+    /**
+   * Parse an excel table into JS objects
+   * uploadFolderPath refers to the absolute path of the folder, from the root, that will store the excel file temporarily.
+   * This need is a result of the middleware logic stored in the file Upload.middleware.ts of the core api
+   * @param data - refers to the data necessary to parse.
+   * @returns returns js objects
+   */
     async parse(data) {
         try {
             logger_1.logger.info("ExcelParser initiated", { context: data });
-            const filePath = path_1.default.resolve(data.rootDirname, "uploads", `${data.filename}`);
+            const filePath = path_1.default.resolve(data.uploadFolderPath, `${data.filename}`);
             const sheets = node_xlsx_1.default.parse(filePath);
             const parsedResult = sheets.map((sheet) => new sheetExcelParser_1.SheetExcelParser().parse(sheet));
             await this.deleteFile(filePath);

package/excel/interfaces.d.ts

@@ -21,7 +21,7 @@ export interface IFormatStructure {
 }
 export interface IExcelParserData {
     filename: string;
-    rootDirname: string;
+    uploadFolderPath: string;
 }
 export interface IExcelSheet {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "2.2.11",
+  "version": "2.2.12",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",