office-viewer 0.1.0 → 0.1.3

package/lib/Word.js

@@ -2,7 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var tslib_es6 = require('./node_modules/tslib/tslib.es6.js');
+var tslib = require('tslib');
+var FontTable = require('./openxml/word/FontTable.js');
 var parseRelationship = require('./parse/parseRelationship.js');
 var ContentType = require('./openxml/ContentType.js');
 var Style = require('./openxml/Style.js');
@@ -17,20 +18,38 @@ var WDocument = require('./openxml/word/WDocument.js');
 var renderRun = require('./render/renderRun.js');
 var ZipPackageParser = require('./package/ZipPackageParser.js');
 var xml = require('./util/xml.js');
+var Font = require('./openxml/word/Font.js');
+var renderFont = require('./render/renderFont.js');
+var replaceVar = require('./util/replaceVar.js');
+var Footnotes = require('./parse/Footnotes.js');
+var parseEndnotes = require('./parse/parseEndnotes.js');
+var renderNotes = require('./render/renderNotes.js');
+var print = require('./util/print.js');
+var Settings = require('./openxml/Settings.js');
 
-/**
- * 总入口，它将包括所有 word 文档信息，后续渲染的时候依赖它来获取关联信息
- */
 var defaultRenderOptions = {
-    imageDataURL: false,
     classPrefix: 'docx-viewer',
-    inWrap: true,
+    page: false,
+    pageWrap: true,
     bulletUseFont: true,
     ignoreHeight: true,
-    ignoreWidth: true,
+    ignoreWidth: false,
     minLineHeight: 1.0,
     enableVar: false,
-    debug: false
+    debug: false,
+    pageWrapPadding: 20,
+    pageMarginBottom: 20,
+    pageShadow: true,
+    pageBackground: '#FFFFFF',
+    pageWrapBackground: '#ECECEC',
+    printWaitTime: 100,
+    zoomFitWidth: false,
+    renderHeader: true,
+    renderFooter: true,
+    data: {},
+    evalVar: function (t) {
+        return t;
+    }
 };
 var Word = /** @class */ (function () {
     /**
@@ -55,11 +74,21 @@ var Word = /** @class */ (function () {
          */
         this.styleIdNum = 0;
         this.wrapClassName = 'docx-viewer-wrapper';
+        this.footNotes = {};
+        this.endNotes = {};
         this.inited = false;
+        /**
+         * 分页标记，如果为 true，那么在渲染的时候会强制分页
+         */
+        this.breakPage = false;
         parser.load(docFile);
         this.id = Word.globalId++;
         this.parser = parser;
-        this.renderOptions = tslib_es6.__assign(tslib_es6.__assign({}, defaultRenderOptions), renderOptions);
+        this.renderOptions = tslib.__assign(tslib.__assign({}, defaultRenderOptions), renderOptions);
+        if (this.renderOptions.page) {
+            this.renderOptions.ignoreHeight = false;
+            this.renderOptions.ignoreWidth = false;
+        }
     }
     /**
      * 初始化一些公共资源，比如
@@ -70,10 +99,14 @@ var Word = /** @class */ (function () {
         }
         // 这个必须在最前面，因为后面很多依赖它来查找文件的
         this.initContentType();
+        // relation 需要排第二
+        this.initRelation();
+        this.initSettings();
         this.initTheme();
+        this.initFontTable();
         this.initStyle();
-        this.initRelation();
         this.initNumbering();
+        this.initNotes();
         this.inited = true;
     };
     /**
@@ -82,7 +115,7 @@ var Word = /** @class */ (function () {
     Word.prototype.initTheme = function () {
         var e_1, _a;
         try {
-            for (var _b = tslib_es6.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
+            for (var _b = tslib.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var override = _c.value;
                 if (override.partName.startsWith('/word/theme')) {
                     var theme = this.parser.getXML(override.partName);
@@ -104,7 +137,7 @@ var Word = /** @class */ (function () {
     Word.prototype.initStyle = function () {
         var e_2, _a;
         try {
-            for (var _b = tslib_es6.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
+            for (var _b = tslib.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var override = _c.value;
                 if (override.partName.startsWith('/word/styles.xml')) {
                     this.styles = Style.parseStyles(this, this.parser.getXML('/word/styles.xml'));
@@ -119,6 +152,48 @@ var Word = /** @class */ (function () {
             finally { if (e_2) throw e_2.error; }
         }
     };
+    /**
+     * 解析全局配置
+     */
+    Word.prototype.initSettings = function () {
+        var e_3, _a;
+        try {
+            for (var _b = tslib.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var override = _c.value;
+                if (override.partName.startsWith('/word/settings.xml')) {
+                    this.settings = Settings.Settings.parse(this, this.parser.getXML('/word/settings.xml'));
+                }
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_3) throw e_3.error; }
+        }
+    };
+    /**
+     * 解析字体表
+     */
+    Word.prototype.initFontTable = function () {
+        var e_4, _a;
+        try {
+            for (var _b = tslib.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var override = _c.value;
+                if (override.partName.startsWith('/word/fontTable.xml')) {
+                    this.fontTable = FontTable.FontTable.fromXML(this, this.parser.getXML('/word/fontTable.xml'));
+                }
+            }
+        }
+        catch (e_4_1) { e_4 = { error: e_4_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_4) throw e_4.error; }
+        }
+    };
     /**
      * 解析关系
      */
@@ -127,11 +202,17 @@ var Word = /** @class */ (function () {
         if (this.parser.fileExists('/_rels/.rels')) {
             rels = parseRelationship.parseRelationships(this.parser.getXML('/_rels/.rels'), 'root');
         }
+        this.relationships = rels;
         var documentRels = {};
         if (this.parser.fileExists('/word/_rels/document.xml.rels')) {
             documentRels = parseRelationship.parseRelationships(this.parser.getXML('/word/_rels/document.xml.rels'), 'word');
         }
-        this.relationships = tslib_es6.__assign(tslib_es6.__assign({}, rels), documentRels);
+        this.documentRels = documentRels;
+        var fontTableRels = {};
+        if (this.parser.fileExists('/word/_rels/fontTable.xml.rels')) {
+            fontTableRels = parseRelationship.parseRelationships(this.parser.getXML('/word/_rels/fontTable.xml.rels'), 'word');
+        }
+        this.fontTableRels = fontTableRels;
     };
     /**
      * 解析全局配置
@@ -144,9 +225,9 @@ var Word = /** @class */ (function () {
      * 解析 numbering
      */
     Word.prototype.initNumbering = function () {
-        var e_3, _a;
+        var e_5, _a;
         try {
-            for (var _b = tslib_es6.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
+            for (var _b = tslib.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var override = _c.value;
                 if (override.partName.startsWith('/word/numbering')) {
                     var numberingData = this.parser.getXML(override.partName);
@@ -154,32 +235,88 @@ var Word = /** @class */ (function () {
                 }
             }
         }
-        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        catch (e_5_1) { e_5 = { error: e_5_1 }; }
         finally {
             try {
                 if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
             }
-            finally { if (e_3) throw e_3.error; }
+            finally { if (e_5) throw e_5.error; }
+        }
+    };
+    Word.prototype.initNotes = function () {
+        var e_6, _a;
+        try {
+            for (var _b = tslib.__values(this.conentTypes.overrides), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var override = _c.value;
+                if (override.partName.startsWith('/word/footnotes.xml')) {
+                    var notesData = this.parser.getXML(override.partName);
+                    this.footNotes = Footnotes.parseFootnotes(this, notesData);
+                }
+                if (override.partName.startsWith('/word/endnotes.xml')) {
+                    var notesData = this.parser.getXML(override.partName);
+                    this.endNotes = parseEndnotes.parseEndnotes(this, notesData);
+                }
+            }
+        }
+        catch (e_6_1) { e_6 = { error: e_6_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_6) throw e_6.error; }
         }
     };
     /**
-     * 根据 id 获取关系
+     * 获取全局关系
      */
     Word.prototype.getRelationship = function (id) {
-        if (id) {
+        if (id && this.relationships) {
             return this.relationships[id];
         }
         return null;
     };
     /**
-     * 进行文本替换
+     * 获取文档对应的关系
+     */
+    Word.prototype.getDocumentRels = function (id) {
+        if (id && this.documentRels) {
+            return this.documentRels[id];
+        }
+        return null;
+    };
+    /**
+     * 获取字体对应的关系
+     */
+    Word.prototype.getFontTableRels = function (id) {
+        if (id && this.fontTableRels) {
+            return this.fontTableRels[id];
+        }
+        return null;
+    };
+    /**
+     * 进行单个文本替换
      */
     Word.prototype.replaceText = function (text) {
-        if (this.renderOptions.enableVar === false ||
-            !this.renderOptions.replaceText) {
+        if (this.renderOptions.enableVar === false) {
             return text;
         }
-        return this.renderOptions.replaceText(text);
+        var data = this.renderOptions.data;
+        if (text.indexOf('{{') !== -1) {
+            text = text.replace(/^{{/g, '').replace(/}}$/g, '');
+            var result = this.renderOptions.evalVar(text, data);
+            if (typeof result === 'undefined') {
+                return '';
+            }
+            return String(result);
+        }
+        return text;
+    };
+    Word.prototype.loadWordRelXML = function (relation) {
+        var path = relation.target;
+        if (relation.part === 'word') {
+            path = 'word/' + path;
+        }
+        return this.getXML(path);
     };
     /**
      * 加载图片
@@ -191,14 +328,22 @@ var Word = /** @class */ (function () {
         }
         var data = this.parser.getFileByType(path, 'blob');
         if (data) {
-            if (this.renderOptions.imageDataURL) {
-                return blob.blobToDataURL(data);
-            }
-            else {
-                return new Promise(function (resolve, reject) {
-                    resolve(URL.createObjectURL(data));
-                });
-            }
+            return URL.createObjectURL(data);
+        }
+        return null;
+    };
+    Word.prototype.loadFont = function (rId, key) {
+        var relation = this.getFontTableRels(rId);
+        if (!relation) {
+            return null;
+        }
+        var path = relation.target;
+        if (relation.part === 'word') {
+            path = 'word/' + path;
+        }
+        var data = this.parser.getFileByType(path, 'uint8array');
+        if (data) {
+            return URL.createObjectURL(new Blob([Font.deobfuscate(data, key)]));
         }
         return null;
     };
@@ -237,8 +382,9 @@ var Word = /** @class */ (function () {
      * 添加新样式，主要用于表格的单元格样式
      */
     Word.prototype.appendStyle = function (style) {
-        var styleElement = document.createElement('style');
-        styleElement.innerHTML = style;
+        if (style === void 0) { style = ''; }
+        var styleElement = dom.createElement('style');
+        styleElement.textContent = style;
         this.rootElement.appendChild(styleElement);
     };
     /**
@@ -257,6 +403,13 @@ var Word = /** @class */ (function () {
         }
         return classNames;
     };
+    /**
+     * 根据 id 获取样式
+     * @param styleId
+     */
+    Word.prototype.getStyle = function (styleId) {
+        return this.styles.styleMap[styleId];
+    };
     /**
      * 渲染时的 css 类前缀
      */
@@ -264,11 +417,28 @@ var Word = /** @class */ (function () {
         return "".concat(this.renderOptions.classPrefix, "-").concat(this.id);
     };
     /**
-     * 获取主题色，目前基于 css 变量实现，方便动态修改
+     * 获取主题色
      */
     Word.prototype.getThemeColor = function (name) {
-        return "var(--docx-".concat(this.id, "-theme-").concat(name, "-color)");
+        var _a, _b, _c;
+        if (this.settings.clrSchemeMapping) {
+            name = this.settings.clrSchemeMapping[name] || name;
+        }
+        if (this.themes && this.themes.length > 0) {
+            var theme = this.themes[0];
+            var color = (_c = (_b = (_a = theme.themeElements) === null || _a === void 0 ? void 0 : _a.clrScheme) === null || _b === void 0 ? void 0 : _b.colors) === null || _c === void 0 ? void 0 : _c[name];
+            if (color) {
+                return color;
+            }
+            else {
+                console.warn('unknown theme color: ' + name);
+            }
+        }
+        return '';
     };
+    /**
+     * 添加类，自动加上前缀
+     */
     Word.prototype.addClass = function (element, className) {
         element.classList.add("".concat(this.getClassPrefix(), "-").concat(className));
     };
@@ -276,9 +446,7 @@ var Word = /** @class */ (function () {
      * 更新页面中的变量，这个要在 render 后运行
      */
     Word.prototype.updateVariable = function () {
-        if (!this.rootElement ||
-            this.renderOptions.enableVar === false ||
-            !this.renderOptions.replaceText) {
+        if (!this.rootElement || this.renderOptions.enableVar === false) {
             return;
         }
         renderRun.updateVariableText(this);
@@ -289,12 +457,13 @@ var Word = /** @class */ (function () {
     Word.prototype.download = function (fileName) {
         if (fileName === void 0) { fileName = 'document.docx'; }
         var documentData = this.getXML('word/document.xml');
-        if (this.renderOptions.enableVar && this.renderOptions.replaceText) {
+        if (this.renderOptions.enableVar) {
             mergeRun.mergeRun(this, documentData);
+            replaceVar.replaceVar(this, documentData);
             // 对文本进行替换
             var ts = documentData.getElementsByTagName('w:t');
             for (var i = 0; i < ts.length; i++) {
-                ts[i].textContent = this.replaceText(ts[i].textContent || '');
+                replaceVar.replaceT(this, ts[i], this.renderOptions.data);
             }
         }
         var blob$1 = this.parser.generateZip(xml.buildXML(documentData));
@@ -304,26 +473,28 @@ var Word = /** @class */ (function () {
      * 打印功能
      */
     Word.prototype.print = function () {
-        var _a, _b;
-        return tslib_es6.__awaiter(this, void 0, void 0, function () {
-            var iframe;
-            return tslib_es6.__generator(this, function (_c) {
-                switch (_c.label) {
+        return tslib.__awaiter(this, void 0, void 0, function () {
+            var iframe, printDocument;
+            return tslib.__generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
                         iframe = document.createElement('iframe');
                         iframe.style.position = 'absolute';
                         iframe.style.top = '-10000px';
                         document.body.appendChild(iframe);
-                        (_a = iframe.contentDocument) === null || _a === void 0 ? void 0 : _a.write('<div id="print"></div>');
-                        return [4 /*yield*/, this.render((_b = iframe.contentDocument) === null || _b === void 0 ? void 0 : _b.getElementById('print'))];
+                        printDocument = iframe.contentDocument;
+                        if (!printDocument) {
+                            console.warn('printDocument is null');
+                            return [2 /*return*/, null];
+                        }
+                        printDocument.write("<style>\n      html, body { margin:0; padding:0 }\n      @page { size: auto; margin: 0mm; }\n      </style>\n      <div id=\"print\"></div>");
+                        return [4 /*yield*/, this.render(printDocument.getElementById('print'), tslib.__assign({ page: true, pageWrap: false, pageShadow: false, pageMarginBottom: 0, pageWrapPadding: undefined, zoom: 1 }, this.renderOptions.printOptions))];
                     case 1:
-                        _c.sent();
+                        _a.sent();
                         setTimeout(function () {
-                            var _a, _b;
                             iframe.focus();
-                            (_a = iframe.contentWindow) === null || _a === void 0 ? void 0 : _a.print();
-                            (_b = iframe.parentNode) === null || _b === void 0 ? void 0 : _b.removeChild(iframe);
-                        }, 100);
+                            print.printIframe(iframe);
+                        }, this.renderOptions.printWaitTime || 100); // 需要等一下图片渲染
                         window.focus();
                         return [2 /*return*/];
                 }
@@ -334,32 +505,40 @@ var Word = /** @class */ (function () {
      * 渲染文档入口
      *
      * @param root 渲染的根节点
+     * @param renderOptionsOverride 临时覆盖某些渲选项
      */
-    Word.prototype.render = function (root) {
-        return tslib_es6.__awaiter(this, void 0, void 0, function () {
+    Word.prototype.render = function (root, renderOptionsOverride) {
+        if (renderOptionsOverride === void 0) { renderOptionsOverride = {}; }
+        return tslib.__awaiter(this, void 0, void 0, function () {
             var renderOptions, isDebug, documentData, document, documentElement;
-            return tslib_es6.__generator(this, function (_a) {
+            return tslib.__generator(this, function (_a) {
                 this.init();
-                renderOptions = this.renderOptions;
+                this.currentPage = 0;
+                renderOptions = tslib.__assign(tslib.__assign({}, this.renderOptions), renderOptionsOverride);
                 isDebug = renderOptions.debug;
                 isDebug && console.log('init', this);
                 this.rootElement = root;
                 root.innerHTML = '';
                 documentData = this.getXML('word/document.xml');
                 isDebug && console.log('documentData', documentData);
-                if (renderOptions.enableVar && renderOptions.replaceText) {
+                if (renderOptions.enableVar) {
                     mergeRun.mergeRun(this, documentData);
+                    replaceVar.replaceVar(this, documentData);
                     // 这里不进行变量替换，方便后续进行局部替换来更新变量
                 }
                 document = WDocument.WDocument.fromXML(this, documentData);
                 isDebug && console.log('document', document);
-                documentElement = renderDocument["default"](this, document);
+                documentElement = renderDocument["default"](root, this, document, renderOptions);
                 root.classList.add(this.getClassPrefix());
-                if (renderOptions.inWrap) {
+                if (renderOptions.page && renderOptions.pageWrap) {
                     root.classList.add(this.wrapClassName);
+                    root.style.padding = "".concat(renderOptions.pageWrapPadding || 0, "pt");
+                    root.style.background = renderOptions.pageWrapBackground || '#ECECEC';
                 }
                 dom.appendChild(root, renderStyle.renderStyle(this));
+                dom.appendChild(root, renderFont.renderFont(this.fontTable));
                 dom.appendChild(root, documentElement);
+                dom.appendChild(root, renderNotes.renderNotes(this));
                 return [2 /*return*/];
             });
         });

package/lib/openxml/ContentType.js

@@ -2,17 +2,31 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var tslib = require('tslib');
+
 /**
  * 解析 [Content_Types].xml
  */
 function parseContentType(doc) {
+    var e_1, _a;
     var types = { overrides: [] };
-    doc.querySelectorAll('Override').forEach(function (item) {
-        types.overrides.push({
-            partName: item.getAttribute('PartName'),
-            contentType: item.getAttribute('ContentType')
-        });
-    });
+    var overrides = [].slice.call(doc.getElementsByTagName('Override'));
+    try {
+        for (var overrides_1 = tslib.__values(overrides), overrides_1_1 = overrides_1.next(); !overrides_1_1.done; overrides_1_1 = overrides_1.next()) {
+            var item = overrides_1_1.value;
+            types.overrides.push({
+                partName: item.getAttribute('PartName'),
+                contentType: item.getAttribute('ContentType')
+            });
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (overrides_1_1 && !overrides_1_1.done && (_a = overrides_1.return)) _a.call(overrides_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
     return types;
 }
 

package/lib/openxml/Settings.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 解析 settings.xml，只支持一小部分
+ *
+ */
+import Word from '../Word';
+export declare class Settings {
+    clrSchemeMapping: Record<string, string>;
+    autoHyphenation: boolean;
+    static parse(word: Word, doc: Document): Settings;
+}

package/lib/openxml/Settings.js

@@ -0,0 +1,97 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var OpenXML = require('../OpenXML.js');
+
+/**
+ * 解析 settings.xml，只支持一小部分
+ *
+ */
+/**
+ * 解析颜色映射
+ * http://webapp.docx4java.org/OnlineDemo/ecma376/WordML/clrSchemeMapping.html
+ */
+function parseClrSchemeMapping(element) {
+    var e_1, _a;
+    var clrSchemeMapping = {};
+    try {
+        for (var _b = tslib.__values(element.attributes), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var attribute = _c.value;
+            var name_1 = attribute.name.replace('w:', '');
+            var value = attribute.value;
+            // 文档里也说了这个等于 lt1
+            if (value === 'light1') {
+                value = 'lt1';
+            }
+            else if (value === 'light2') {
+                value = 'lt2';
+            }
+            else if (value === 'dark1') {
+                value = 'dk1';
+            }
+            else if (value === 'dark2') {
+                value = 'dk2';
+            }
+            clrSchemeMapping[name_1] = value;
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    if (!clrSchemeMapping.bg1) {
+        clrSchemeMapping.bg1 = 'lt1';
+    }
+    if (!clrSchemeMapping.bg2) {
+        clrSchemeMapping.bg2 = 'lt2';
+    }
+    if (!clrSchemeMapping.tx1) {
+        clrSchemeMapping.tx1 = 'dk1';
+    }
+    return clrSchemeMapping;
+}
+var Settings = /** @class */ (function () {
+    function Settings() {
+        this.clrSchemeMapping = {};
+        this.autoHyphenation = false;
+    }
+    Settings.parse = function (word, doc) {
+        var e_2, _a;
+        var settings = new Settings();
+        var rootElement = doc;
+        if (doc.firstElementChild &&
+            doc.firstElementChild.tagName === 'w:settings') {
+            rootElement = doc.getElementsByTagName('w:settings').item(0);
+        }
+        try {
+            for (var _b = tslib.__values(Array.from(rootElement.children)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var child = _c.value;
+                var tag = child.tagName;
+                switch (tag) {
+                    case 'w:clrSchemeMapping':
+                        settings.clrSchemeMapping = parseClrSchemeMapping(child);
+                        break;
+                    case 'w:autoHyphenation':
+                        settings.autoHyphenation = OpenXML.getValBoolean(child, false);
+                        break;
+                }
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+        return settings;
+    };
+    return Settings;
+}());
+
+exports.Settings = Settings;

package/lib/openxml/Style.d.ts

@@ -9,7 +9,7 @@ import { TablePr } from './word/Table';
 import { TcPr } from './word/table/Tc';
 import { TrPr } from './word/table/Tr';
 export interface CSSStyle {
-    [key: string]: string;
+    [key: string]: string | number;
 }
 export interface TblStylePrStyle {
     rPr?: RunPr;