@alienkarma/exceljs 4.4.0-fork.1 → 4.4.0-fork.11

package/lib/stream/xlsx/workbook-writer.js

@@ -1,23 +1,24 @@
-const fs = require('fs');
-const Archiver = require('archiver');
+import { ZipArchive } from "@alienkarma/archiver";
 
-const StreamBuf = require('../../utils/stream-buf');
+const fs = require("fs");
 
-const RelType = require('../../xlsx/rel-type');
-const StylesXform = require('../../xlsx/xform/style/styles-xform');
-const SharedStrings = require('../../utils/shared-strings');
-const DefinedNames = require('../../doc/defined-names');
+const StreamBuf = require("../../utils/stream-buf");
 
-const CoreXform = require('../../xlsx/xform/core/core-xform');
-const RelationshipsXform = require('../../xlsx/xform/core/relationships-xform');
-const ContentTypesXform = require('../../xlsx/xform/core/content-types-xform');
-const AppXform = require('../../xlsx/xform/core/app-xform');
-const WorkbookXform = require('../../xlsx/xform/book/workbook-xform');
-const SharedStringsXform = require('../../xlsx/xform/strings/shared-strings-xform');
+const RelType = require("../../xlsx/rel-type");
+const StylesXform = require("../../xlsx/xform/style/styles-xform");
+const SharedStrings = require("../../utils/shared-strings");
+const DefinedNames = require("../../doc/defined-names");
 
-const WorksheetWriter = require('./worksheet-writer');
+const CoreXform = require("../../xlsx/xform/core/core-xform");
+const RelationshipsXform = require("../../xlsx/xform/core/relationships-xform");
+const ContentTypesXform = require("../../xlsx/xform/core/content-types-xform");
+const AppXform = require("../../xlsx/xform/core/app-xform");
+const WorkbookXform = require("../../xlsx/xform/book/workbook-xform");
+const SharedStringsXform = require("../../xlsx/xform/strings/shared-strings-xform");
 
-const theme1Xml = require('../../xlsx/xml/theme1.js');
+const WorksheetWriter = require("./worksheet-writer");
+
+const theme1Xml = require("../../xlsx/xml/theme1.js");
 
 class WorkbookWriter {
   constructor(options) {
@@ -25,8 +26,8 @@ class WorkbookWriter {
 
     this.created = options.created || new Date();
     this.modified = options.modified || this.created;
-    this.creator = options.creator || 'ExcelJS';
-    this.lastModifiedBy = options.lastModifiedBy || 'ExcelJS';
+    this.creator = options.creator || "ExcelJS";
+    this.lastModifiedBy = options.lastModifiedBy || "ExcelJS";
     this.lastPrinted = options.lastPrinted;
 
     // using shared strings creates a smaller xlsx file but may use more memory
@@ -34,7 +35,9 @@ class WorkbookWriter {
     this.sharedStrings = new SharedStrings();
 
     // style manager
-    this.styles = options.useStyles ? new StylesXform(true) : new StylesXform.Mock(true);
+    this.styles = options.useStyles
+      ? new StylesXform(true)
+      : new StylesXform.Mock(true);
 
     // defined names
     this._definedNames = new DefinedNames();
@@ -47,7 +50,7 @@ class WorkbookWriter {
     this.media = [];
     this.commentRefs = [];
 
-    this.zip = Archiver('zip', this.zipOptions);
+    this.zip = new ZipArchive(this.zipOptions);
     if (options.stream) {
       this.stream = options.stream;
     } else if (options.filename) {
@@ -66,19 +69,19 @@ class WorkbookWriter {
   }
 
   _openStream(path) {
-    const stream = new StreamBuf({bufSize: 65536, batch: true});
-    this.zip.append(stream, {name: path});
-    stream.on('finish', () => {
-      stream.emit('zipped');
+    const stream = new StreamBuf({ bufSize: 65536, batch: true });
+    this.zip.append(stream, { name: path });
+    stream.on("finish", () => {
+      stream.emit("zipped");
     });
     return stream;
   }
 
   _commitWorksheets() {
-    const commitWorksheet = function(worksheet) {
+    const commitWorksheet = function (worksheet) {
       if (!worksheet.committed) {
-        return new Promise(resolve => {
-          worksheet.stream.on('zipped', () => {
+        return new Promise((resolve) => {
+          worksheet.stream.on("zipped", () => {
             resolve();
           });
           worksheet.commit();
@@ -124,7 +127,10 @@ class WorkbookWriter {
 
   addImage(image) {
     const id = this.media.length;
-    const medium = Object.assign({}, image, {type: 'image', name: `image${id}.${image.extension}`});
+    const medium = Object.assign({}, image, {
+      type: "image",
+      name: `image${id}.${image.extension}`,
+    });
     this.media.push(medium);
     return id;
   }
@@ -139,16 +145,20 @@ class WorkbookWriter {
     // in fact, it's even possible to switch it mid-sheet
     options = options || {};
     const useSharedStrings =
-      options.useSharedStrings !== undefined ? options.useSharedStrings : this.useSharedStrings;
+      options.useSharedStrings !== undefined
+        ? options.useSharedStrings
+        : this.useSharedStrings;
 
     if (options.tabColor) {
       // eslint-disable-next-line no-console
-      console.trace('tabColor option has moved to { properties: tabColor: {...} }');
+      console.trace(
+        "tabColor option has moved to { properties: tabColor: {...} }",
+      );
       options.properties = Object.assign(
         {
           tabColor: options.tabColor,
         },
-        options.properties
+        options.properties,
       );
     }
 
@@ -176,44 +186,54 @@ class WorkbookWriter {
     if (id === undefined) {
       return this._worksheets.find(() => true);
     }
-    if (typeof id === 'number') {
+    if (typeof id === "number") {
       return this._worksheets[id];
     }
-    if (typeof id === 'string') {
-      return this._worksheets.find(worksheet => worksheet && worksheet.name === id);
+    if (typeof id === "string") {
+      return this._worksheets.find(
+        (worksheet) => worksheet && worksheet.name === id,
+      );
     }
     return undefined;
   }
 
   addStyles() {
-    return new Promise(resolve => {
-      this.zip.append(this.styles.xml, {name: 'xl/styles.xml'});
+    return new Promise((resolve) => {
+      this.zip.append(this.styles.xml, { name: "xl/styles.xml" });
       resolve();
     });
   }
 
   addThemes() {
-    return new Promise(resolve => {
-      this.zip.append(theme1Xml, {name: 'xl/theme/theme1.xml'});
+    return new Promise((resolve) => {
+      this.zip.append(theme1Xml, { name: "xl/theme/theme1.xml" });
       resolve();
     });
   }
 
   addOfficeRels() {
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       const xform = new RelationshipsXform();
       const xml = xform.toXml([
-        {Id: 'rId1', Type: RelType.OfficeDocument, Target: 'xl/workbook.xml'},
-        {Id: 'rId2', Type: RelType.CoreProperties, Target: 'docProps/core.xml'},
-        {Id: 'rId3', Type: RelType.ExtenderProperties, Target: 'docProps/app.xml'},
+        { Id: "rId1", Type: RelType.OfficeDocument, Target: "xl/workbook.xml" },
+        {
+          Id: "rId2",
+          Type: RelType.CoreProperties,
+          Target: "docProps/core.xml",
+        },
+        {
+          Id: "rId3",
+          Type: RelType.ExtenderProperties,
+          Target: "docProps/app.xml",
+        },
       ]);
-      this.zip.append(xml, {name: '/_rels/.rels'});
+      this.zip.append(xml, { name: "/_rels/.rels" });
       resolve();
     });
   }
 
   addContentTypes() {
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       const model = {
         worksheets: this._worksheets.filter(Boolean),
         sharedStrings: this.sharedStrings,
@@ -222,60 +242,60 @@ class WorkbookWriter {
       };
       const xform = new ContentTypesXform();
       const xml = xform.toXml(model);
-      this.zip.append(xml, {name: '[Content_Types].xml'});
+      this.zip.append(xml, { name: "[Content_Types].xml" });
       resolve();
     });
   }
 
   addMedia() {
     return Promise.all(
-      this.media.map(medium => {
-        if (medium.type === 'image') {
+      this.media.map((medium) => {
+        if (medium.type === "image") {
           const filename = `xl/media/${medium.name}`;
           if (medium.filename) {
-            return this.zip.file(medium.filename, {name: filename});
+            return this.zip.file(medium.filename, { name: filename });
           }
           if (medium.buffer) {
-            return this.zip.append(medium.buffer, {name: filename});
+            return this.zip.append(medium.buffer, { name: filename });
           }
           if (medium.base64) {
             const dataimg64 = medium.base64;
-            const content = dataimg64.substring(dataimg64.indexOf(',') + 1);
-            return this.zip.append(content, {name: filename, base64: true});
+            const content = dataimg64.substring(dataimg64.indexOf(",") + 1);
+            return this.zip.append(content, { name: filename, base64: true });
           }
         }
-        throw new Error('Unsupported media');
-      })
+        throw new Error("Unsupported media");
+      }),
     );
   }
 
   addApp() {
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       const model = {
         worksheets: this._worksheets.filter(Boolean),
       };
       const xform = new AppXform();
       const xml = xform.toXml(model);
-      this.zip.append(xml, {name: 'docProps/app.xml'});
+      this.zip.append(xml, { name: "docProps/app.xml" });
       resolve();
     });
   }
 
   addCore() {
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       const coreXform = new CoreXform();
       const xml = coreXform.toXml(this);
-      this.zip.append(xml, {name: 'docProps/core.xml'});
+      this.zip.append(xml, { name: "docProps/core.xml" });
       resolve();
     });
   }
 
   addSharedStrings() {
     if (this.sharedStrings.count) {
-      return new Promise(resolve => {
+      return new Promise((resolve) => {
         const sharedStringsXform = new SharedStringsXform();
         const xml = sharedStringsXform.toXml(this.sharedStrings);
-        this.zip.append(xml, {name: '/xl/sharedStrings.xml'});
+        this.zip.append(xml, { name: "/xl/sharedStrings.xml" });
         resolve();
       });
     }
@@ -285,17 +305,17 @@ class WorkbookWriter {
   addWorkbookRels() {
     let count = 1;
     const relationships = [
-      {Id: `rId${count++}`, Type: RelType.Styles, Target: 'styles.xml'},
-      {Id: `rId${count++}`, Type: RelType.Theme, Target: 'theme/theme1.xml'},
+      { Id: `rId${count++}`, Type: RelType.Styles, Target: "styles.xml" },
+      { Id: `rId${count++}`, Type: RelType.Theme, Target: "theme/theme1.xml" },
     ];
     if (this.sharedStrings.count) {
       relationships.push({
         Id: `rId${count++}`,
         Type: RelType.SharedStrings,
-        Target: 'sharedStrings.xml',
+        Target: "sharedStrings.xml",
       });
     }
-    this._worksheets.forEach(worksheet => {
+    this._worksheets.forEach((worksheet) => {
       if (worksheet) {
         worksheet.rId = `rId${count++}`;
         relationships.push({
@@ -305,16 +325,16 @@ class WorkbookWriter {
         });
       }
     });
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       const xform = new RelationshipsXform();
       const xml = xform.toXml(relationships);
-      this.zip.append(xml, {name: '/xl/_rels/workbook.xml.rels'});
+      this.zip.append(xml, { name: "/xl/_rels/workbook.xml.rels" });
       resolve();
     });
   }
 
   addWorkbook() {
-    const {zip} = this;
+    const { zip } = this;
     const model = {
       worksheets: this._worksheets.filter(Boolean),
       definedNames: this._definedNames.model,
@@ -323,21 +343,21 @@ class WorkbookWriter {
       calcProperties: {},
     };
 
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       const xform = new WorkbookXform();
       xform.prepare(model);
-      zip.append(xform.toXml(model), {name: '/xl/workbook.xml'});
+      zip.append(xform.toXml(model), { name: "/xl/workbook.xml" });
       resolve();
     });
   }
 
   _finalize() {
     return new Promise((resolve, reject) => {
-      this.stream.on('error', reject);
-      this.stream.on('finish', () => {
+      this.stream.on("error", reject);
+      this.stream.on("finish", () => {
         resolve(this);
       });
-      this.zip.on('error', reject);
+      this.zip.on("error", reject);
 
       this.zip.finalize();
     });

package/package.json

@@ -1,149 +1,151 @@
-{
-  "name": "@alienkarma/exceljs",
-  "version": "4.4.0-fork.1",
-  "description": "Excel Workbook Manager - Read and Write xlsx and csv Files.",
-  "private": false,
-  "license": "MIT",
-  "author": {
-    "name": "Guyon Roche",
-    "email": "guyon@live.com"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/exceljs/exceljs.git"
-  },
-  "engines": {
-    "node": ">=8.3.0"
-  },
-  "main": "./excel.js",
-  "browser": "./dist/exceljs.min.js",
-  "types": "./index.d.ts",
-  "files": [
-    "dist",
-    "lib",
-    "excel.js",
-    "LICENSE",
-    "README.md",
-    "README_zh.md",
-    "index.ts",
-    "index.d.ts"
-  ],
-  "scripts": {
-    "test": "npm run test:full",
-    "test:es5": "export EXCEL_BUILD=es5 && npm run test:full",
-    "test:full": "npm run build && npm run test:unit && npm run test:integration && npm run test:end-to-end && npm run test:jasmine",
-    "test:version": "npm run build && npm run test:unit && npm run test:integration && npm run test:end-to-end && npm run test:browser && npm run test:dist",
-    "test:all": "npm run test:native && npm run test:es5",
-    "test:native": "npm run test:full",
-    "test:unit": "mocha --require spec/config/setup --require spec/config/setup-unit spec/unit --recursive",
-    "test:integration": "mocha --require spec/config/setup spec/integration --recursive",
-    "test:end-to-end": "mocha --require spec/config/setup spec/end-to-end --recursive",
-    "test:browser": "if [ ! -f .disable-test-browser ]; then npm run build && npm run test:jasmine; fi",
-    "test:jasmine": "grunt jasmine",
-    "test:unit:es5": "export EXCEL_BUILD=es5 && npm run test:unit",
-    "test:integration:es5": "export EXCEL_BUILD=es5 && npm run test:integration",
-    "test:end-to-end:es5": "export EXCEL_BUILD=es5 && npm run test:end-to-end",
-    "test:dist": "mocha --require spec/config/setup spec/dist --recursive",
-    "test:manual": "node spec/manual/app.js",
-    "test:typescript": "mocha -r ts-node/register spec/typescript/**/*.spec.ts",
-    "clean-build": "npm run clean && npm run build",
-    "lint": "eslint --format node_modules/eslint-friendly-formatter .",
-    "lint:fix": "prettier-eslint --write $(pwd)'/**/*.js'",
-    "lint:staged": "lint-staged",
-    "clean": "rm -rf build/ && rm -rf dist",
-    "benchmark": "node --expose-gc benchmark",
-    "benchmark:debug": "node --expose-gc --inspect-brk --trace-deopt benchmark",
-    "build": "grunt build",
-    "install-build": "npm install && grunt build",
-    "preversion": "npm run clean && npm run build && npm run test:version",
-    "postversion": "git push --no-verify && git push --tags --no-verify"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.js": [
-      "prettier-eslint --write",
-      "eslint --format node_modules/eslint-friendly-formatter",
-      "git add"
-    ]
-  },
-  "keywords": [
-    "xlsx",
-    "json",
-    "csv",
-    "excel",
-    "font",
-    "border",
-    "fill",
-    "number",
-    "format",
-    "number format",
-    "alignment",
-    "office",
-    "spreadsheet",
-    "workbook",
-    "defined names",
-    "data validations",
-    "rich text",
-    "in-cell format",
-    "outlineLevel",
-    "views",
-    "frozen",
-    "split",
-    "pageSetup"
-  ],
-  "dependencies": {
-    "archiver": "^7.0.1",
-    "dayjs": "^1.8.34",
-    "fast-csv": "^4.3.1",
-    "jszip": "^3.10.1",
-    "readable-stream": "^3.6.0",
-    "saxes": "^5.0.1",
-    "tmp": "^0.2.0",
-    "unzipper": "^0.10.11",
-    "uuid": "^8.3.0"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.10.5",
-    "@babel/core": "^7.11.4",
-    "@babel/preset-env": "^7.11.0",
-    "@types/chai": "^4.2.12",
-    "@types/mocha": "^8.0.3",
-    "@types/node": "^14.11.2",
-    "babelify": "^10.0.0",
-    "browserify": "^16.5.2",
-    "chai": "^4.2.0",
-    "chai-datetime": "^1.7.0",
-    "chai-xml": "^0.3.2",
-    "core-js": "^3.6.5",
-    "dirty-chai": "^2.0.1",
-    "eslint": "^6.5.1",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-config-prettier": "^6.12.0",
-    "eslint-friendly-formatter": "^4.0.1",
-    "eslint-plugin-import": "^2.22.0",
-    "eslint-plugin-node": "^11.1.0",
-    "express": "^4.16.4",
-    "got": "^9.0.0",
-    "grunt": "^1.3.0",
-    "grunt-babel": "^8.0.0",
-    "grunt-browserify": "^5.3.0",
-    "grunt-contrib-copy": "^1.0.0",
-    "grunt-contrib-jasmine": "^2.2.0",
-    "grunt-contrib-watch": "^1.1.0",
-    "grunt-exorcise": "^2.1.1",
-    "grunt-terser": "^1.0.0",
-    "husky": "^4.3.0",
-    "lint-staged": "^10.2.13",
-    "mocha": "^7.2.0",
-    "prettier-eslint": "^11.0.0",
-    "prettier-eslint-cli": "^5.0.0",
-    "regenerator-runtime": "^0.13.7",
-    "sax": "^1.2.4",
-    "ts-node": "^8.10.2",
-    "typescript": "^3.9.7"
-  }
-}
+{
+  "name": "@alienkarma/exceljs",
+  "version": "4.4.0-fork.11",
+  "description": "Excel Workbook Manager - Read and Write xlsx and csv Files.",
+  "private": false,
+  "license": "MIT",
+  "type": "module",
+  "author": {
+    "name": "Guyon Roche",
+    "email": "guyon@live.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/exceljs/exceljs.git"
+  },
+  "engines": {
+    "node": ">=8.3.0"
+  },
+  "main": "./excel.js",
+  "browser": "./dist/exceljs.min.js",
+  "types": "./index.d.ts",
+  "files": [
+    "dist",
+    "lib",
+    "excel.js",
+    "LICENSE",
+    "README.md",
+    "README_zh.md",
+    "index.ts",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "npm run test:full",
+    "test:es5": "export EXCEL_BUILD=es5 && npm run test:full",
+    "test:full": "npm run build && npm run test:unit && npm run test:integration && npm run test:end-to-end && npm run test:jasmine",
+    "test:version": "npm run build && npm run test:unit && npm run test:integration && npm run test:end-to-end && npm run test:browser && npm run test:dist",
+    "test:all": "npm run test:native && npm run test:es5",
+    "test:native": "npm run test:full",
+    "test:unit": "mocha --require spec/config/setup --require spec/config/setup-unit spec/unit --recursive",
+    "test:integration": "mocha --require spec/config/setup spec/integration --recursive",
+    "test:end-to-end": "mocha --require spec/config/setup spec/end-to-end --recursive",
+    "test:browser": "if [ ! -f .disable-test-browser ]; then npm run build && npm run test:jasmine; fi",
+    "test:jasmine": "grunt jasmine",
+    "test:unit:es5": "export EXCEL_BUILD=es5 && npm run test:unit",
+    "test:integration:es5": "export EXCEL_BUILD=es5 && npm run test:integration",
+    "test:end-to-end:es5": "export EXCEL_BUILD=es5 && npm run test:end-to-end",
+    "test:dist": "mocha --require spec/config/setup spec/dist --recursive",
+    "test:manual": "node spec/manual/app.js",
+    "test:typescript": "mocha -r ts-node/register spec/typescript/**/*.spec.ts",
+    "clean-build": "npm run clean && npm run build",
+    "lint": "eslint --format node_modules/eslint-friendly-formatter .",
+    "lint:fix": "prettier-eslint --write $(pwd)'/**/*.js'",
+    "lint:staged": "lint-staged",
+    "clean": "rm -rf build/ && rm -rf dist",
+    "benchmark": "node --expose-gc benchmark",
+    "benchmark:debug": "node --expose-gc --inspect-brk --trace-deopt benchmark",
+    "build": "grunt build",
+    "install-build": "npm install && grunt build",
+    "preversion": "npm run clean && npm run build && npm run test:version",
+    "postversion": "git push --no-verify && git push --tags --no-verify"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "prettier-eslint --write",
+      "eslint --format node_modules/eslint-friendly-formatter",
+      "git add"
+    ]
+  },
+  "keywords": [
+    "xlsx",
+    "json",
+    "csv",
+    "excel",
+    "font",
+    "border",
+    "fill",
+    "number",
+    "format",
+    "number format",
+    "alignment",
+    "office",
+    "spreadsheet",
+    "workbook",
+    "defined names",
+    "data validations",
+    "rich text",
+    "in-cell format",
+    "outlineLevel",
+    "views",
+    "frozen",
+    "split",
+    "pageSetup"
+  ],
+  "dependencies": {
+    "@alienkarma/archiver": "^7.0.1-fork.3",
+    "brace-expansion": "^2.0.2",
+    "dayjs": "^1.8.34",
+    "fast-csv": "^4.3.1",
+    "jszip": "^3.10.1",
+    "readable-stream": "^3.6.0",
+    "saxes": "^5.0.1",
+    "tmp": "^0.2.4",
+    "unzipper": "^0.12.3",
+    "uuid": "^8.3.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.10.5",
+    "@babel/core": "^7.11.4",
+    "@babel/preset-env": "^7.11.0",
+    "@types/chai": "^4.2.12",
+    "@types/mocha": "^8.0.3",
+    "@types/node": "^14.11.2",
+    "babelify": "^10.0.0",
+    "browserify": "^16.5.2",
+    "chai": "^4.2.0",
+    "chai-datetime": "^1.7.0",
+    "chai-xml": "^0.3.2",
+    "core-js": "^3.6.5",
+    "dirty-chai": "^2.0.1",
+    "eslint": "^6.5.1",
+    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-config-prettier": "^6.12.0",
+    "eslint-friendly-formatter": "^4.0.1",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-node": "^11.1.0",
+    "express": "^4.16.4",
+    "got": "^9.0.0",
+    "grunt": "^1.3.0",
+    "grunt-babel": "^8.0.0",
+    "grunt-browserify": "^5.3.0",
+    "grunt-contrib-copy": "^1.0.0",
+    "grunt-contrib-jasmine": "^2.2.0",
+    "grunt-contrib-watch": "^1.1.0",
+    "grunt-exorcise": "^2.1.1",
+    "grunt-terser": "^1.0.0",
+    "husky": "^4.3.0",
+    "lint-staged": "^10.2.13",
+    "mocha": "^7.2.0",
+    "prettier-eslint": "^11.0.0",
+    "prettier-eslint-cli": "^5.0.0",
+    "regenerator-runtime": "^0.13.7",
+    "sax": "^1.2.4",
+    "ts-node": "^8.10.2",
+    "typescript": "^3.9.7"
+  }
+}