@corbe30/fortune-excel 1.2.5 → 2.0.0

package/README.md

@@ -2,7 +2,7 @@
   <img align="center" src="fortuneExcelLogo.png" width="150px" height="150px" />
 </p>
 <h1 align="center">FortuneExcel</h1>
-<p align="center">FortuneExcel is an .xlsx import/export plugin for FortuneSheet.</p>
+<p align="center">FortuneExcel is an .xlsx and .csv import/export plugin for FortuneSheet / ProsperaSheet.</p>
 
 <div align="center">
 
@@ -16,34 +16,42 @@
 
 ## Usage
 
-For best results, import and export a single sheet at a time. Although you can force FortuneExcel to handle multiple sheets, certain configurations may break.
+You can check the example in [Storybook](https://github.com/Corbe30/FortuneExcel/blob/main/src/stories/Page.tsx).
 
 1. Install the package:
-```js
-npm i @corbe30/fortune-excel
-```
+    ```js
+    npm i @corbe30/fortune-excel
+    ```
 
 2. Add import/export toolbar item in fortune-sheet
-> `<ImportHelper />` is a hidden component and only required when using `importToolBarItem()`.
-```js
-import { ImportHelper, importToolBarItem, exportToolBarItem } from "@corbe30/fortune-excel";
-
-function App() {
-  const workbookRef = useRef();
-  const [key, setKey] = useState(0);
-  const [sheets, setSheets] = useState(data);
-
-  return (
-    <>
-      <ImportHelper setKey={setKey} setSheets={setSheets} sheetRef={workbookRef} />
-      <Workbook
-        key={key} data={sheets} ref={workbookRef}
-        customToolbarItems={[exportToolBarItem(workbookRef), importToolBarItem()]}
-      />
-    </>
-  );
-}
-```
+    > `<FortuneExcelHelper />` is a hidden component.
+    ```js
+    import { FortuneExcelHelper, importToolBarItem, exportToolBarItem } from "@corbe30/fortune-excel";
+
+    function App() {
+      const workbookRef = useRef();
+      const [key, setKey] = useState(0);
+      const [sheets, setSheets] = useState(data);
+
+      return (
+        <>
+          <FortuneExcelHelper
+            setKey={setKey}
+            setSheets={setSheets}
+            sheetRef={sheetRef}
+            config={{
+              import: { xlsx: true, csv: true },
+              export: { xlsx: true, csv: true },
+            }}
+          />
+          <Workbook
+            key={key} data={sheets} ref={workbookRef}
+            customToolbarItems={[importToolBarItem(), exportToolBarItem(workbookRef)]}
+          />
+        </>
+      );
+    }
+    ```
 
 ## Authors and acknowledgment
 
@@ -60,11 +68,10 @@ Export support:
 - [Orleans9](https://blog.csdn.net/zinchliang) - [article](https://blog.csdn.net/zinchliang/article/details/120262185)
 
 ## Contribution
-1. node v20.17.0
-2. Use npm and not yarn
-3. npm run prepare
-4. npm run build-storybook
-5. npm run storybook
+1. Install node v20.17.0
+3. `npm run prepare`
+4. `npm run build-storybook`
+5. `npm run storybook`
 
 ## License
 

package/dist/ToExcel/ExcelFile.d.ts

@@ -1 +1,2 @@
-export declare function exportSheetExcel(luckysheetRef: any): Promise<void>;
+import { IFileType } from "../common/ICommon";
+export declare function exportSheetExcel(luckysheetRef: any, fileType: IFileType): Promise<void>;

package/dist/ToExcel/ExcelFile.js

@@ -71,9 +71,10 @@ var ExcelImage_1 = require("./ExcelImage");
 var ExcelBorder_1 = require("./ExcelBorder");
 var ExcelValidation_1 = require("./ExcelValidation");
 var ExcelConfig_1 = require("./ExcelConfig");
-function exportSheetExcel(luckysheetRef) {
+var ICommon_1 = require("../common/ICommon");
+function exportSheetExcel(luckysheetRef, fileType) {
     return __awaiter(this, void 0, void 0, function () {
-        var luckysheet, workbook, buffer, fileData;
+        var luckysheet, workbook, fileData, buffer, buffer;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -92,11 +93,19 @@ function exportSheetExcel(luckysheetRef) {
                         (0, ExcelConfig_1.setHiddenRowCol)(table, worksheet);
                         return true;
                     });
-                    return [4 /*yield*/, workbook.xlsx.writeBuffer()];
+                    if (!(fileType === ICommon_1.IFileType.CSV)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, workbook.csv.writeBuffer()];
                 case 1:
                     buffer = _a.sent();
                     fileData = new Blob([buffer]);
-                    fileSaver.saveAs(fileData, "".concat(luckysheetRef.getSheet().name, ".xlsx"));
+                    return [3 /*break*/, 4];
+                case 2: return [4 /*yield*/, workbook.xlsx.writeBuffer()];
+                case 3:
+                    buffer = _a.sent();
+                    fileData = new Blob([buffer]);
+                    _a.label = 4;
+                case 4:
+                    fileSaver.saveAs(fileData, "".concat(luckysheetRef.getSheet().name, ".").concat(fileType));
                     return [2 /*return*/];
             }
         });

package/dist/ToExcel/ExportHelper.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import "./style.css";
+export declare const ExportHelper: (props: any) => React.JSX.Element;

package/dist/ToExcel/ExportHelper.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportHelper = void 0;
+var react_1 = __importDefault(require("react"));
+require("./style.css");
+var Transform_1 = require("../common/Transform");
+var ICommon_1 = require("../common/ICommon");
+var getExportButton = function (fileType, onClick) {
+    return (react_1.default.createElement("button", { className: "unstyled-button", onClick: function () { return onClick(fileType); } },
+        "Export as .",
+        fileType.toLowerCase()));
+};
+var ExportHelper = function (props) {
+    var sheetRef = props.sheetRef, config = props.config;
+    var onMouseLeave = function () {
+        var exportHelper = document.querySelector(".export-helper");
+        exportHelper.style.visibility = "hidden";
+    };
+    var onClick = function (fileType) {
+        (0, Transform_1.transformFortuneToExcel)(sheetRef.current, fileType);
+        onMouseLeave();
+    };
+    return (react_1.default.createElement("div", { className: "export-helper", onMouseLeave: onMouseLeave },
+        config.xlsx ? getExportButton(ICommon_1.IFileType.XLSX, onClick) : null,
+        config.csv ? getExportButton(ICommon_1.IFileType.CSV, onClick) : null));
+};
+exports.ExportHelper = ExportHelper;

package/dist/ToFortuneSheet/ImportHelper.js

@@ -43,8 +43,9 @@ exports.ImportHelper = void 0;
 var react_1 = __importDefault(require("react"));
 var Transform_1 = require("../common/Transform");
 var ImportHelper = function (props) {
-    var setSheets = props.setSheets, setKey = props.setKey, sheetRef = props.sheetRef;
-    return (react_1.default.createElement("input", { type: "file", id: "ImportHelper", accept: ".xlsx", onChange: function (e) { return __awaiter(void 0, void 0, void 0, function () {
+    var setSheets = props.setSheets, setKey = props.setKey, sheetRef = props.sheetRef, config = props.config;
+    var acceptTypes = "".concat(config.xlsx ? ".xlsx," : "").concat(config.csv ? ".csv" : "");
+    return (react_1.default.createElement("input", { type: "file", id: "ImportHelper", accept: acceptTypes, onChange: function (e) { return __awaiter(void 0, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, (0, Transform_1.transformExcelToFortune)(e, setSheets, setKey, sheetRef)];

package/dist/common/FortuneExcelHelper.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export declare const FortuneExcelHelper: (props: any) => React.JSX.Element;

package/dist/common/FortuneExcelHelper.js

@@ -0,0 +1,36 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FortuneExcelHelper = void 0;
+var react_1 = __importDefault(require("react"));
+var ImportHelper_1 = require("../ToFortuneSheet/ImportHelper");
+var ExportHelper_1 = require("../ToExcel/ExportHelper");
+var formatConfig = function (config) {
+    if (config === void 0) { config = {}; }
+    var defaultConfig = {
+        import: { xlsx: true, csv: true },
+        export: { xlsx: true, csv: true },
+    };
+    return __assign(__assign({}, defaultConfig), config);
+};
+var FortuneExcelHelper = function (props) {
+    var setKey = props.setKey, setSheets = props.setSheets, sheetRef = props.sheetRef, config = props.config;
+    var sanitizedConfig = formatConfig(config);
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(ImportHelper_1.ImportHelper, { setKey: setKey, setSheets: setSheets, sheetRef: sheetRef, config: sanitizedConfig.import }),
+        react_1.default.createElement(ExportHelper_1.ExportHelper, { sheetRef: sheetRef, config: sanitizedConfig.export })));
+};
+exports.FortuneExcelHelper = FortuneExcelHelper;

package/dist/common/ICommon.d.ts

@@ -32,3 +32,7 @@ export interface IBorderInfo {
 export interface IBorderInfoCompute {
     [key: string]: IBorderInfo;
 }
+export declare enum IFileType {
+    CSV = "csv",
+    XLSX = "xlsx"
+}

package/dist/common/ICommon.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.IFileType = void 0;
+var IFileType;
+(function (IFileType) {
+    IFileType["CSV"] = "csv";
+    IFileType["XLSX"] = "xlsx";
+})(IFileType || (exports.IFileType = IFileType = {}));

package/dist/common/ToolbarItem.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="react" />
+import React from "react";
 export declare const exportToolBarItem: (sheetRef: any) => {
     key: string;
     tooltip: string;
-    icon: import("react").JSX.Element;
+    icon: React.JSX.Element;
     onClick: (e: any) => Promise<void>;
 };
 export declare const importToolBarItem: () => {
     key: string;
     tooltip: string;
-    icon: import("react").JSX.Element;
+    icon: React.JSX.Element;
     onClick: (e: any) => void;
 };

package/dist/common/ToolbarItem.js

@@ -42,20 +42,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.importToolBarItem = exports.exportToolBarItem = void 0;
 var ExportIcon_1 = __importDefault(require("../icons/ExportIcon"));
 var ImportIcon_1 = __importDefault(require("../icons/ImportIcon"));
-var Transform_1 = require("./Transform");
 var exportToolBarItem = function (sheetRef) {
     return {
         key: "export",
-        tooltip: "Export .xlsx",
+        tooltip: "Export ...",
         icon: (0, ExportIcon_1.default)(),
         onClick: function (e) { return __awaiter(void 0, void 0, void 0, function () {
+            var exportHelper, visibility;
             return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, Transform_1.transformFortuneToExcel)(sheetRef.current)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
+                exportHelper = document.querySelector(".export-helper");
+                visibility = exportHelper === null || exportHelper === void 0 ? void 0 : exportHelper.style.visibility;
+                exportHelper.style.visibility = visibility === "visible" ? "hidden" : "visible";
+                return [2 /*return*/];
             });
         }); },
     };
@@ -64,7 +62,7 @@ exports.exportToolBarItem = exportToolBarItem;
 var importToolBarItem = function () {
     return {
         key: "import",
-        tooltip: "Import .xlsx",
+        tooltip: "Import file",
         icon: (0, ImportIcon_1.default)(),
         onClick: function (e) {
             var _a;

package/dist/common/Transform.d.ts

@@ -1,2 +1,3 @@
+import { IFileType } from "./ICommon";
 export declare const transformExcelToFortune: (e: any, setSheets: any, setKey: any, sheetRef: any) => Promise<void>;
-export declare const transformFortuneToExcel: (luckysheetRef: any) => Promise<void>;
+export declare const transformFortuneToExcel: (luckysheetRef: any, fileType: IFileType) => Promise<void>;

package/dist/common/Transform.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -40,17 +63,50 @@ exports.transformFortuneToExcel = exports.transformExcelToFortune = void 0;
 var FortuneFile_1 = require("../ToFortuneSheet/FortuneFile");
 var HandleZip_1 = require("../ToFortuneSheet/HandleZip");
 var ExcelFile_1 = require("../ToExcel/ExcelFile");
+var ExcelJS = __importStar(require("exceljs"));
+var convertCsvToExcel = function (file) { return __awaiter(void 0, void 0, void 0, function () {
+    var csvText, rows, workbook, worksheet, buffer;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, file.text()];
+            case 1:
+                csvText = _a.sent();
+                rows = csvText.split("\n").map(function (row) { return row.split(","); });
+                workbook = new ExcelJS.Workbook();
+                worksheet = workbook.addWorksheet("Sheet1");
+                rows.forEach(function (row) {
+                    worksheet.addRow(row);
+                });
+                return [4 /*yield*/, workbook.xlsx.writeBuffer()];
+            case 2:
+                buffer = _a.sent();
+                return [2 /*return*/, buffer];
+        }
+    });
+}); };
 var transformExcelToFortune = function (e, setSheets, setKey, sheetRef) { return __awaiter(void 0, void 0, void 0, function () {
-    var excelFile, files, fortuneFile, lsh;
+    var file, excelFile, fileName, files, fortuneFile, lsh;
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, e.target.files[0].arrayBuffer()];
+            case 0:
+                file = e.target.files[0];
+                fileName = file.name;
+                if (!(file.type === 'text/csv' || file.name.toLowerCase().endsWith('.csv'))) return [3 /*break*/, 2];
+                return [4 /*yield*/, convertCsvToExcel(file)];
             case 1:
+                // convert CSV to xlsx
                 excelFile = _a.sent();
-                return [4 /*yield*/, new HandleZip_1.HandleZip(excelFile).unzipFile()];
-            case 2:
+                fileName = file.name.replace(/\.csv$/i, '.xlsx');
+                return [3 /*break*/, 4];
+            case 2: return [4 /*yield*/, file.arrayBuffer()];
+            case 3:
+                // process as excel file
+                excelFile = _a.sent();
+                _a.label = 4;
+            case 4: return [4 /*yield*/, new HandleZip_1.HandleZip(new File([excelFile], fileName)).unzipFile()];
+            case 5:
                 files = _a.sent();
-                fortuneFile = new FortuneFile_1.FortuneFile(files, excelFile.name);
+                fortuneFile = new FortuneFile_1.FortuneFile(files, fileName);
                 fortuneFile.Parse();
                 lsh = fortuneFile.serialize();
                 setSheets(lsh.sheets);
@@ -69,10 +125,10 @@ var transformExcelToFortune = function (e, setSheets, setKey, sheetRef) { return
     });
 }); };
 exports.transformExcelToFortune = transformExcelToFortune;
-var transformFortuneToExcel = function (luckysheetRef) { return __awaiter(void 0, void 0, void 0, function () {
+var transformFortuneToExcel = function (luckysheetRef, fileType) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, (0, ExcelFile_1.exportSheetExcel)(luckysheetRef)];
+            case 0: return [4 /*yield*/, (0, ExcelFile_1.exportSheetExcel)(luckysheetRef, fileType)];
             case 1:
                 _a.sent();
                 return [2 /*return*/];

package/dist/main.d.ts

@@ -1,2 +1,2 @@
 export * from "./common/ToolbarItem";
-export * from "./ToFortuneSheet/ImportHelper";
+export * from "./common/FortuneExcelHelper";

package/dist/main.js

@@ -15,4 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./common/ToolbarItem"), exports);
-__exportStar(require("./ToFortuneSheet/ImportHelper"), exports);
+__exportStar(require("./common/FortuneExcelHelper"), exports);

package/package.json

@@ -3,7 +3,7 @@
   "workspaces": [
     "src/*"
   ],
-  "version": "1.2.5",
+  "version": "2.0.0",
   "description": "An Excel import/export import library for FortuneSheet",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",