pp-robot-module 0.2.14

package/dist/MR/Excel.js

@@ -0,0 +1,316 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MR = void 0;
+const xlsx = require("xlsx");
+const path = require("path");
+const File_1 = require("./File");
+const Log_1 = require("./Log");
+var MR;
+(function (MR) {
+    class Excel {
+        constructor() { }
+        static get instance() {
+            if (!this.excel) {
+                this.excel = new Excel();
+            }
+            return this.excel;
+        }
+        load(filePath) {
+            this._filename = filePath;
+            this._workbook = xlsx.readFile(filePath);
+        }
+        open(params) {
+            Log_1.default.debug("Excel.open", params);
+            this.load(params._filename);
+            let sheetName = this._workbook.SheetNames[0];
+            if (params._sheetname) {
+                sheetName = this._workbook.SheetNames.find((name) => name === params._sheetname);
+            }
+            this._sheet = this._workbook.Sheets[sheetName];
+            return this._workbook;
+        }
+        sheetNames() {
+            Log_1.default.debug("Excel.sheetNames");
+            return this._workbook.SheetNames;
+        }
+        getData(params) {
+            Log_1.default.debug("Excel.sheet", params);
+            if (params._sheetname) {
+                let sheetName = this._workbook.SheetNames.find((name) => name === params._sheetname);
+                this._sheet = this._workbook.Sheets[sheetName];
+            }
+            if (params._type) {
+                let res = undefined;
+                switch (params._type) {
+                    case 'json':
+                        res = xlsx.utils.sheet_to_json(this._sheet);
+                        break;
+                    case 'csv':
+                        res = xlsx.utils.sheet_to_csv(this._sheet);
+                        break;
+                    case 'txt':
+                        res = xlsx.utils.sheet_to_txt(this._sheet);
+                        break;
+                    case 'html':
+                        res = xlsx.utils.sheet_to_html(this._sheet);
+                        break;
+                    case 'formulae':
+                        res = xlsx.utils.sheet_to_formulae(this._sheet);
+                        break;
+                }
+                return res;
+            }
+            else {
+                return xlsx.utils.sheet_to_json(this._sheet);
+            }
+        }
+        ec(row, column) {
+            return xlsx.utils.encode_cell({ r: row, c: column });
+        }
+        buildStyle(params = { _fontname: '宋体', _fontsize: 12, _fontrgb: 'FFFFAA00', _fontbold: false }) {
+            return {
+                // set the style for target cell
+                font: {
+                    name: params._fontsize,
+                    sz: params._fontsize,
+                    bold: params._fontbold,
+                    color: {
+                        rgb: params._fontrgb,
+                    }
+                },
+            };
+        }
+        //清空列
+        clearColumn(params) {
+            Log_1.default.debug("Excel.clearColumn", params);
+            const columnIndex = xlsx.utils.decode_col(params._column);
+            const range = xlsx.utils.decode_range(this._sheet['!ref']);
+            for (let r = range.s.r; r <= range.e.r; r++) {
+                const cellRef = xlsx.utils.encode_cell({ r, c: columnIndex });
+                delete this._sheet[cellRef];
+            }
+            xlsx.writeFile(this._workbook, this._filename);
+        }
+        //删除列
+        deleteColumn(params) {
+            Log_1.default.debug("Excel.deleteColumn", params);
+            const columnIndex = xlsx.utils.decode_col(params._column);
+            let range = xlsx.utils.decode_range(this._sheet["!ref"]);
+            for (let r = range.s.r; r <= range.e.r; r++) {
+                for (var C = columnIndex; C <= range.e.c; ++C) {
+                    this._sheet[this.ec(r, C)] = this._sheet[this.ec(r, C + 1)];
+                }
+            }
+            range.e.c--;
+            this._sheet["!ref"] = xlsx.utils.encode_range(range.s, range.e);
+            xlsx.writeFile(this._workbook, this._filename);
+        }
+        //清空行
+        clearRow(params) {
+            Log_1.default.debug("Excel.clearRow", params);
+            let row = params._row < 0 ? 0 : params._row - 1;
+            const range = xlsx.utils.decode_range(this._sheet['!ref']);
+            for (var C = range.s.c; C <= range.e.c; ++C) {
+                const cellRef = xlsx.utils.encode_cell({ r: row, c: C });
+                delete this._sheet[cellRef];
+            }
+            xlsx.writeFile(this._workbook, this._filename);
+        }
+        //删除行
+        deleteRow(params) {
+            Log_1.default.debug("Excel.deleteRow", params);
+            let row = params._row < 0 ? 0 : params._row - 1;
+            let range = xlsx.utils.decode_range(this._sheet["!ref"]);
+            for (let r = row; r <= range.e.r; r++) {
+                for (var C = range.s.c; C <= range.e.c; ++C) {
+                    this._sheet[this.ec(r, C)] = this._sheet[this.ec(r + 1, C)];
+                }
+            }
+            range.e.r--;
+            this._sheet["!ref"] = xlsx.utils.encode_range(range.s, range.e);
+            xlsx.writeFile(this._workbook, this._filename);
+        }
+        //行列 长度
+        size(params = {}) {
+            Log_1.default.debug("Excel.range", params);
+            if (params._sheetname) {
+                this.posSheet({ _sheetname: params._sheetname });
+            }
+            return this._sheet['!ref'];
+        }
+        //添加公式
+        formula(params) {
+            Log_1.default.debug("Excel.formula", params);
+            if (params._sheetname) {
+                this.posSheet({ _sheetname: params._sheetname });
+            }
+            //xlsx.utils.sheet_set_array_formula(this._sheet, "C1", "SUM(A1:A3*B1:B3)");
+            xlsx.utils.sheet_set_array_formula(this._sheet, params._range, params._formula);
+            xlsx.writeFile(this._workbook, this._filename);
+        }
+        //行列对象
+        range(params = {}) {
+            Log_1.default.debug("Excel.range", params);
+            if (params._sheetname) {
+                this.posSheet({ _sheetname: params._sheetname });
+            }
+            var range = xlsx.utils.decode_range(this._sheet['!ref']);
+            return range;
+        }
+        //获取某一行数据
+        row(params) {
+            Log_1.default.debug("Excel.row", params);
+            let row = params._row < 0 ? 0 : params._row - 1;
+            let range = xlsx.utils.decode_range(this._sheet["!ref"]);
+            let data = [];
+            for (var C = range.s.c; C <= range.e.c; ++C) {
+                const cell = this._sheet[this.ec(row, C)];
+                if (cell) {
+                    data.push(cell.v);
+                }
+                else {
+                    data.push('');
+                }
+            }
+            return data;
+        }
+        //获取某一列数据
+        column(params) {
+            Log_1.default.debug("Excel.column", params);
+            let data = [];
+            const columnIndex = xlsx.utils.decode_col(params._column);
+            let range = xlsx.utils.decode_range(this._sheet["!ref"]);
+            for (let r = range.s.r; r <= range.e.r; r++) {
+                const cell = this._sheet[this.ec(r, columnIndex)];
+                if (cell) {
+                    data.push(cell.v);
+                }
+                else {
+                    data.push('');
+                }
+            }
+            return data;
+        }
+        cell(params) {
+            Log_1.default.debug("Excel.cell", params);
+            var desired_cell = this._sheet[params._pos];
+            if (params._value) {
+                let oriData = desired_cell.v;
+                desired_cell.v = params._value;
+                xlsx.writeFile(this._workbook, this._filename);
+                return oriData;
+            }
+            else {
+                var desired_value = (desired_cell ? desired_cell.v : undefined);
+                return desired_value;
+            }
+        }
+        /**
+         * Convert to CSV/other and export file.
+         */
+        convert(params) {
+            Log_1.default.debug("Excel.convert", params);
+            let outFilename = `${params._filename}.${params._type}`;
+            if (params._filename) {
+                this.load(params._filename);
+                outFilename = `${path.parse(params._filename).name}_${params._sheetname}.${params._type}`;
+            }
+            const res = this.getData({ _type: params._type, _sheetname: params._sheetname });
+            File_1.default.write({ _filename: outFilename, _data: res });
+            return outFilename;
+        }
+        //定位sheet
+        posSheet(params) {
+            Log_1.default.debug("Excel.posSheet", params);
+            const sheetName = this._workbook.SheetNames.find((name) => name === params._sheetname);
+            this._sheet = this._workbook.Sheets[sheetName];
+        }
+        addSheet(params) {
+            Log_1.default.debug("Excel.addSheet", params._sheetname, params._type);
+            let workSheet;
+            if (params._type === 'aoa') {
+                workSheet = xlsx.utils.aoa_to_sheet(params._data);
+            }
+            else {
+                workSheet = xlsx.utils.json_to_sheet(params._data);
+            }
+            xlsx.utils.book_append_sheet(this._workbook, workSheet, params._sheetname);
+        }
+        //sheet上追加数据
+        put(params) {
+            Log_1.default.debug("Excel.put", params._data);
+            if (params._sheetname) {
+                this.posSheet({ _sheetname: params._sheetname });
+            }
+            if (params._type === 'json') {
+                let tmpSheetJson = xlsx.utils.sheet_to_json(this._sheet);
+                tmpSheetJson.push(params._data);
+                xlsx.utils.sheet_add_json(this._sheet, tmpSheetJson);
+            }
+            else {
+                xlsx.utils.sheet_add_aoa(this._sheet, params._data);
+            }
+            xlsx.writeFile(this._workbook, this._filename);
+        }
+        //覆盖数据
+        cover(params) {
+            Log_1.default.debug("Excel.cover", params._data);
+            if (params._sheetname) {
+                this.posSheet({ _sheetname: params._sheetname });
+            }
+            const workBook = xlsx.utils.book_new();
+            let workSheet;
+            if (params._type === 'aoa') {
+                workSheet = xlsx.utils.aoa_to_sheet(params._data);
+            }
+            else {
+                workSheet = xlsx.utils.json_to_sheet(params._data);
+            }
+            xlsx.utils.book_append_sheet(workBook, workSheet);
+            xlsx.writeFile(workBook, this._filename);
+        }
+        write(params) {
+            Log_1.default.debug("Excel.write", params._filename);
+            const workBook = xlsx.utils.book_new();
+            const workSheet = xlsx.utils.json_to_sheet(params._data);
+            xlsx.utils.book_append_sheet(workBook, workSheet);
+            xlsx.writeFile(workBook, params._filename);
+        }
+        /**
+         * Convert to CSV and export file.
+         */
+        toCSV(params) {
+            Log_1.default.debug("Excel.toCSV", params);
+            const workbook = xlsx.readFile(params._filename);
+            let outFilename = `${params._filename}.csv`;
+            //转换指定的sheetname
+            if (params._sheetname) {
+                outFilename = `${path.parse(params._filename).name}_${params._sheetname}.csv`;
+                const sheetName = workbook.SheetNames.find((name) => name === params._sheetname);
+                const sheet = workbook.Sheets[sheetName];
+                if (sheet) {
+                    const csv = xlsx.utils.sheet_to_csv(sheet);
+                    File_1.default.write({ _filename: outFilename, _data: csv });
+                }
+                return outFilename;
+            }
+            else {
+                //转换全部的sheet
+                const sheetNames = workbook.SheetNames;
+                let csvNames = [];
+                for (let sheetName of sheetNames) {
+                    outFilename = `${path.parse(params._filename).name}_${sheetName}.csv`;
+                    const sheet = workbook.Sheets[sheetName];
+                    if (sheet) {
+                        const csv = xlsx.utils.sheet_to_csv(sheet);
+                        File_1.default.write({ _filename: outFilename, _data: csv });
+                        csvNames.push(outFilename);
+                    }
+                }
+                return csvNames;
+            }
+        }
+    }
+    MR.Excel = Excel;
+})(MR = exports.MR || (exports.MR = {}));
+exports.default = MR.Excel.instance;

package/dist/MR/File.d.ts

@@ -0,0 +1,162 @@
+/// <reference types="node" />
+import fs = require("fs");
+declare enum SortType {
+    Name = "name",
+    Birthtime = "birthtime",
+    Ctime = "ctime",
+    Mtime = "mtime",
+    Size = "size"
+}
+declare enum OrderBy {
+    ASC = 0,
+    DESC = 1
+}
+export declare namespace MR {
+    class File {
+        static readonly SortType: typeof SortType;
+        static readonly OrderBy: typeof OrderBy;
+        private constructor();
+        static copy(params: {
+            _srcFile: string;
+            _destFile: string;
+            _options?: any;
+        }): Promise<any>;
+        static emptyDir(params: {
+            _dir: string;
+        }): Promise<boolean>;
+        static ensureFile(params: {
+            _filename: string;
+        }): Promise<any>;
+        static ensureDir(params: {
+            _dir: string;
+            _options: any;
+        }): Promise<boolean>;
+        static mkdirp(params: {
+            _dir: string;
+            _options: any;
+        }): Promise<any>;
+        static move(params: {
+            _srcFile: string;
+            _destFile: string;
+        }): Promise<void>;
+        static pathExists(params: {
+            _filename: string;
+        }): Promise<any>;
+        static outputFile(params: {
+            _filename: string;
+            _data: string;
+            _encoding?: string;
+        }): Promise<any>;
+        static readFile(params: {
+            _filename: string;
+            _encoding?: string;
+        }): Promise<any>;
+        static outputJson(params: {
+            _filename: string;
+            _data: string;
+            _encoding?: string;
+        }): Promise<void>;
+        static readJson(params: {
+            _filename: string;
+            _encoding?: string;
+        }): Promise<any>;
+        static remove(params: {
+            _filename: string;
+        }): Promise<any>;
+        static detail(params: {
+            _filename: string;
+        }): Promise<{
+            isFile: boolean;
+            isDirectory: boolean;
+            sizeForamt: string;
+            size: number;
+            birthtime: Date;
+            modifytime: Date;
+            filename: string;
+            extname: string;
+            dirname: string;
+            fullpath: string;
+        }>;
+        private static formatFileSize;
+        static folderSize(params: {
+            _dir: string;
+        }): Promise<string>;
+        private static getFolderSize;
+        static getLastedFile(params: {
+            _dir: string;
+        }): Promise<any>;
+        private static getNewestFileInDirectory;
+        /**
+         * Change the name or location of a file or directory.
+         * @param params
+         */
+        static rename(params: {
+            /** A relative path to a file from {@link outDir}. */
+            _oldFile: string;
+            /** A relative path to a file from {@link outDir}. */
+            _newFile: string;
+        }): void;
+        /**
+         * Write data to a file, replacing the file if it already exists.
+         * @param params
+         */
+        static write(params: {
+            /** A relative path to a file from {@link outDir}. */
+            _filename: string;
+            _data: any;
+        }): void;
+        /**
+         * Create a directory.
+         * @param params
+         */
+        static makeDir(params: {
+            /** A relative path to the new directory from {@link outDir}. */
+            _dir: string;
+        }): void;
+        /**
+         * Get file status.
+         * @param params
+         */
+        static getStats(params: {
+            /** A relative path to a file from {@link outDir}. */
+            _filename: string;
+        }): fs.Stats;
+        /**
+         * Lists files or directories in a directory.
+         * @param params
+         */
+        static list(params?: {
+            /** A relative path to a directory from {@link outDir}. */
+            _dir?: string;
+            /** If specified, sorts by sortType */
+            sortType?: SortType;
+            /** Whether the sort order is descending or ascending. The default is ascending. */
+            orderBy?: OrderBy;
+        }): string[];
+        /**
+         * Lists only files in a directory.
+         * @param params
+         */
+        static listFiles(params?: {
+            /** A relative path to a directory from {@link outDir}. */
+            _dir?: string;
+            /** If specified, sorts by sortType */
+            sortType?: SortType;
+            /** Whether the sort order is descending or ascending. The default is ascending. */
+            orderBy?: OrderBy;
+        }): string[];
+        /**
+         * Tests whether the given path is a file.
+         * @param params
+         */
+        static isFile(params: {
+            /** A relative path to a file from {@link outDir}. */
+            _filename: string;
+        }): boolean;
+        static isDir(params: {
+            _filename: string;
+        }): boolean;
+    }
+}
+declare const _default: typeof MR.File;
+export default _default;