@protobi/exceljs
Version:
Excel Workbook Manager - Temporary fork with pivot table enhancements and bug fixes pending upstream merge
443 lines (437 loc) • 21.4 kB
JavaScript
"use strict";
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _regeneratorRuntime() { "use strict"; var r = _regenerator(), e = r.m(_regeneratorRuntime), t = (Object.getPrototypeOf ? Object.getPrototypeOf(e) : e.__proto__).constructor; function n(r) { var e = "function" == typeof r && r.constructor; return !!e && (e === t || "GeneratorFunction" === (e.displayName || e.name)); } var o = { throw: 1, return: 2, break: 3, continue: 3 }; function a(r) { var e, t; return function (n) { e || (e = { stop: function stop() { return t(n.a, 2); }, catch: function _catch() { return n.v; }, abrupt: function abrupt(r, e) { return t(n.a, o[r], e); }, delegateYield: function delegateYield(r, o, a) { return e.resultName = o, t(n.d, _regeneratorValues(r), a); }, finish: function finish(r) { return t(n.f, r); } }, t = function t(r, _t, o) { n.p = e.prev, n.n = e.next; try { return r(_t, o); } finally { e.next = n.n; } }), e.resultName && (e[e.resultName] = n.v, e.resultName = void 0), e.sent = n.v, e.next = n.n; try { return r.call(this, e); } finally { n.p = e.prev, n.n = e.next; } }; } return (_regeneratorRuntime = function _regeneratorRuntime() { return { wrap: function wrap(e, t, n, o) { return r.w(a(e), t, n, o && o.reverse()); }, isGeneratorFunction: n, mark: r.m, awrap: function awrap(r, e) { return new _OverloadYield(r, e); }, AsyncIterator: _regeneratorAsyncIterator, async: function async(r, e, t, o, u) { return (n(e) ? _regeneratorAsyncGen : _regeneratorAsync)(a(r), e, t, o, u); }, keys: _regeneratorKeys, values: _regeneratorValues }; })(); }
function _regeneratorValues(e) { if (null != e) { var t = e["function" == typeof Symbol && Symbol.iterator || "@@iterator"], r = 0; if (t) return t.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) return { next: function next() { return e && r >= e.length && (e = void 0), { value: e && e[r++], done: !e }; } }; } throw new TypeError(_typeof(e) + " is not iterable"); }
function _regeneratorKeys(e) { var n = Object(e), r = []; for (var t in n) r.unshift(t); return function e() { for (; r.length;) if ((t = r.pop()) in n) return e.value = t, e.done = !1, e; return e.done = !0, e; }; }
function _regeneratorAsync(n, e, r, t, o) { var a = _regeneratorAsyncGen(n, e, r, t, o); return a.next().then(function (n) { return n.done ? n.value : a.next(); }); }
function _regeneratorAsyncGen(r, e, t, o, n) { return new _regeneratorAsyncIterator(_regenerator().w(r, e, t, o), n || Promise); }
function _regeneratorAsyncIterator(t, e) { function n(r, o, i, f) { try { var c = t[r](o), u = c.value; return u instanceof _OverloadYield ? e.resolve(u.v).then(function (t) { n("next", t, i, f); }, function (t) { n("throw", t, i, f); }) : e.resolve(u).then(function (t) { c.value = t, i(c); }, function (t) { return n("throw", t, i, f); }); } catch (t) { f(t); } } var r; this.next || (_regeneratorDefine2(_regeneratorAsyncIterator.prototype), _regeneratorDefine2(_regeneratorAsyncIterator.prototype, "function" == typeof Symbol && Symbol.asyncIterator || "@asyncIterator", function () { return this; })), _regeneratorDefine2(this, "_invoke", function (t, o, i) { function f() { return new e(function (e, r) { n(t, i, e, r); }); } return r = r ? r.then(f, f) : f(); }, !0); }
function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i.return) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
function _OverloadYield(e, d) { this.v = e, this.k = d; }
function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
var fs = require('fs');
var Archiver = require('archiver');
var StreamBuf = require('../../utils/stream-buf');
var RelType = require('../../xlsx/rel-type');
var StylesXform = require('../../xlsx/xform/style/styles-xform');
var SharedStrings = require('../../utils/shared-strings');
var DefinedNames = require('../../doc/defined-names');
var CoreXform = require('../../xlsx/xform/core/core-xform');
var RelationshipsXform = require('../../xlsx/xform/core/relationships-xform');
var ContentTypesXform = require('../../xlsx/xform/core/content-types-xform');
var AppXform = require('../../xlsx/xform/core/app-xform');
var WorkbookXform = require('../../xlsx/xform/book/workbook-xform');
var SharedStringsXform = require('../../xlsx/xform/strings/shared-strings-xform');
var WorksheetWriter = require('./worksheet-writer');
var theme1Xml = require('../../xlsx/xml/theme1.js');
var WorkbookWriter = /*#__PURE__*/function () {
function WorkbookWriter(options) {
_classCallCheck(this, WorkbookWriter);
options = options || {};
this.created = options.created || new Date();
this.modified = options.modified || this.created;
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
this.useSharedStrings = options.useSharedStrings || false;
this.sharedStrings = new SharedStrings();
// style manager
this.styles = options.useStyles ? new StylesXform(true) : new StylesXform.Mock(true);
// defined names
this._definedNames = new DefinedNames();
this._worksheets = [];
this.views = [];
this.zipOptions = options.zip;
this.media = [];
this.commentRefs = [];
this.zip = Archiver('zip', this.zipOptions);
if (options.stream) {
this.stream = options.stream;
} else if (options.filename) {
this.stream = fs.createWriteStream(options.filename);
} else {
this.stream = new StreamBuf();
}
this.zip.pipe(this.stream);
// these bits can be added right now
this.promise = Promise.all([this.addThemes(), this.addOfficeRels()]);
}
_createClass(WorkbookWriter, [{
key: "definedNames",
get: function get() {
return this._definedNames;
}
}, {
key: "_openStream",
value: function _openStream(path) {
var stream = new StreamBuf({
bufSize: 65536,
batch: true
});
this.zip.append(stream, {
name: path
});
stream.on('finish', function () {
stream.emit('zipped');
});
return stream;
}
}, {
key: "_commitWorksheets",
value: function _commitWorksheets() {
var commitWorksheet = function commitWorksheet(worksheet) {
if (!worksheet.committed) {
return new Promise(function (resolve) {
worksheet.stream.on('zipped', function () {
resolve();
});
worksheet.commit();
});
}
return Promise.resolve();
};
// if there are any uncommitted worksheets, commit them now and wait
var promises = this._worksheets.map(commitWorksheet);
if (promises.length) {
return Promise.all(promises);
}
return Promise.resolve();
}
}, {
key: "commit",
value: function () {
var _commit = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
return _regeneratorRuntime().wrap(function _callee$(_context) {
while (1) switch (_context.prev = _context.next) {
case 0:
_context.next = 2;
return this.promise;
case 2:
_context.next = 4;
return this.addMedia();
case 4:
_context.next = 6;
return this._commitWorksheets();
case 6:
_context.next = 8;
return Promise.all([this.addContentTypes(), this.addApp(), this.addCore(), this.addSharedStrings(), this.addStyles(), this.addWorkbookRels()]);
case 8:
_context.next = 10;
return this.addWorkbook();
case 10:
return _context.abrupt("return", this._finalize());
case 11:
case "end":
return _context.stop();
}
}, _callee, this);
}));
function commit() {
return _commit.apply(this, arguments);
}
return commit;
}()
}, {
key: "nextId",
get: function get() {
// find the next unique spot to add worksheet
var i;
for (i = 1; i < this._worksheets.length; i++) {
if (!this._worksheets[i]) {
return i;
}
}
return this._worksheets.length || 1;
}
}, {
key: "addImage",
value: function addImage(image) {
var id = this.media.length;
var medium = Object.assign({}, image, {
type: 'image',
name: "image".concat(id, ".").concat(image.extension)
});
this.media.push(medium);
return id;
}
}, {
key: "getImage",
value: function getImage(id) {
return this.media[id];
}
}, {
key: "addWorksheet",
value: function addWorksheet(name, options) {
// it's possible to add a worksheet with different than default
// shared string handling
// in fact, it's even possible to switch it mid-sheet
options = options || {};
var 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: {...} }');
options.properties = Object.assign({
tabColor: options.tabColor
}, options.properties);
}
var id = this.nextId;
name = name || "sheet".concat(id);
var worksheet = new WorksheetWriter({
id: id,
name: name,
workbook: this,
useSharedStrings: useSharedStrings,
properties: options.properties,
state: options.state,
pageSetup: options.pageSetup,
views: options.views,
autoFilter: options.autoFilter,
headerFooter: options.headerFooter
});
this._worksheets[id] = worksheet;
return worksheet;
}
}, {
key: "getWorksheet",
value: function getWorksheet(id) {
if (id === undefined) {
return this._worksheets.find(function () {
return true;
});
}
if (typeof id === 'number') {
return this._worksheets[id];
}
if (typeof id === 'string') {
return this._worksheets.find(function (worksheet) {
return worksheet && worksheet.name === id;
});
}
return undefined;
}
}, {
key: "addStyles",
value: function addStyles() {
var _this = this;
return new Promise(function (resolve) {
_this.zip.append(_this.styles.xml, {
name: 'xl/styles.xml'
});
resolve();
});
}
}, {
key: "addThemes",
value: function addThemes() {
var _this2 = this;
return new Promise(function (resolve) {
_this2.zip.append(theme1Xml, {
name: 'xl/theme/theme1.xml'
});
resolve();
});
}
}, {
key: "addOfficeRels",
value: function addOfficeRels() {
var _this3 = this;
return new Promise(function (resolve) {
var xform = new RelationshipsXform();
var 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'
}]);
_this3.zip.append(xml, {
name: '/_rels/.rels'
});
resolve();
});
}
}, {
key: "addContentTypes",
value: function addContentTypes() {
var _this4 = this;
return new Promise(function (resolve) {
var model = {
worksheets: _this4._worksheets.filter(Boolean),
sharedStrings: _this4.sharedStrings,
commentRefs: _this4.commentRefs,
media: _this4.media
};
var xform = new ContentTypesXform();
var xml = xform.toXml(model);
_this4.zip.append(xml, {
name: '[Content_Types].xml'
});
resolve();
});
}
}, {
key: "addMedia",
value: function addMedia() {
var _this5 = this;
return Promise.all(this.media.map(function (medium) {
if (medium.type === 'image') {
var filename = "xl/media/".concat(medium.name);
if (medium.filename) {
return _this5.zip.file(medium.filename, {
name: filename
});
}
if (medium.buffer) {
return _this5.zip.append(medium.buffer, {
name: filename
});
}
if (medium.base64) {
var dataimg64 = medium.base64;
var content = dataimg64.substring(dataimg64.indexOf(',') + 1);
return _this5.zip.append(content, {
name: filename,
base64: true
});
}
}
throw new Error('Unsupported media');
}));
}
}, {
key: "addApp",
value: function addApp() {
var _this6 = this;
return new Promise(function (resolve) {
var model = {
worksheets: _this6._worksheets.filter(Boolean)
};
var xform = new AppXform();
var xml = xform.toXml(model);
_this6.zip.append(xml, {
name: 'docProps/app.xml'
});
resolve();
});
}
}, {
key: "addCore",
value: function addCore() {
var _this7 = this;
return new Promise(function (resolve) {
var coreXform = new CoreXform();
var xml = coreXform.toXml(_this7);
_this7.zip.append(xml, {
name: 'docProps/core.xml'
});
resolve();
});
}
}, {
key: "addSharedStrings",
value: function addSharedStrings() {
var _this8 = this;
if (this.sharedStrings.count) {
return new Promise(function (resolve) {
var sharedStringsXform = new SharedStringsXform();
var xml = sharedStringsXform.toXml(_this8.sharedStrings);
_this8.zip.append(xml, {
name: '/xl/sharedStrings.xml'
});
resolve();
});
}
return Promise.resolve();
}
}, {
key: "addWorkbookRels",
value: function addWorkbookRels() {
var _this9 = this;
var count = 1;
var relationships = [{
Id: "rId".concat(count++),
Type: RelType.Styles,
Target: 'styles.xml'
}, {
Id: "rId".concat(count++),
Type: RelType.Theme,
Target: 'theme/theme1.xml'
}];
if (this.sharedStrings.count) {
relationships.push({
Id: "rId".concat(count++),
Type: RelType.SharedStrings,
Target: 'sharedStrings.xml'
});
}
this._worksheets.forEach(function (worksheet) {
if (worksheet) {
worksheet.rId = "rId".concat(count++);
relationships.push({
Id: worksheet.rId,
Type: RelType.Worksheet,
Target: "worksheets/sheet".concat(worksheet.id, ".xml")
});
}
});
return new Promise(function (resolve) {
var xform = new RelationshipsXform();
var xml = xform.toXml(relationships);
_this9.zip.append(xml, {
name: '/xl/_rels/workbook.xml.rels'
});
resolve();
});
}
}, {
key: "addWorkbook",
value: function addWorkbook() {
var zip = this.zip;
var model = {
worksheets: this._worksheets.filter(Boolean),
definedNames: this._definedNames.model,
views: this.views,
properties: {},
calcProperties: {}
};
return new Promise(function (resolve) {
var xform = new WorkbookXform();
xform.prepare(model);
zip.append(xform.toXml(model), {
name: '/xl/workbook.xml'
});
resolve();
});
}
}, {
key: "_finalize",
value: function _finalize() {
var _this0 = this;
return new Promise(function (resolve, reject) {
_this0.stream.on('error', reject);
_this0.stream.on('finish', function () {
resolve(_this0);
});
_this0.zip.on('error', reject);
_this0.zip.finalize();
});
}
}]);
return WorkbookWriter;
}();
module.exports = WorkbookWriter;
//# sourceMappingURL=workbook-writer.js.map