@zphhhhh/docx-preview 0.4.20

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2016-2023 Volodymyr Baydalka
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,213 @@
+# docx-preview-sync
+The docx document **synchronously** rendering library
+
+[![npm version](https://badge.fury.io/js/docx-preview-sync.svg)](https://www.npmjs.com/package/docx-preview-sync)
+
+Introduction
+----
+This library is inspired by the [docx-preview](https://github.com/VolodymyrBaydalka/docxjs) library. Thanks to the author [VolodymyrBaydalka](https://github.com/VolodymyrBaydalka) for his hard work.
+I forked the project and modified it to support break pages as much as possible.
+To achieve this goal, I changed the rendering library from asynchronous to synchronous, so that the rendering process can be completed in a synchronous manner, then I can detect all HTML elements that need to be broken and split them into different pages.
+
+Based on the synchronous rendering process, This library will cause **lower** performance.
+
+**This library is still in the development stage, so it is not recommended to use it in production.**
+
+Online Demo
+-----
+[https://millet0328.github.io/docx-preview-sync/](https://millet0328.github.io/docx-preview-sync/)
+
+Goal
+----
+Goal of this project is to render/convert DOCX document into HTML document with keeping HTML semantic as much as possible. 
+That means library is limited by HTML capabilities (for example Google Docs renders *.docx document on canvas as an image).
+
+Installation
+-----
+```
+npm install docx-preview
+```
+
+Usage
+-----
+#### Package managers
+Install library in your Node.js powered apps with the npm package:
+
+```shell
+npm install docx-preview-sync
+```
+```typescript
+import { renderSync } from 'docx-preview-sync';
+
+// fectch document Blob,maybe from input with type = file
+let docData: Blob = document.querySelector('input').files[0];
+
+// synchronously rendering function
+let wordDocument = await renderSync(docData, document.getElementById("container"));
+
+// if you need to get the word document object
+console.log("docx document object", wordDocument);
+```
+
+#### Static HTML without a build step
+
+```html
+<!--dependencies-->
+<script src="https://cdn.jsdelivr.net/npm/jszip@3.10.1/dist/jszip.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.21/lodash.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/konva@9.3.6/konva.min.js"></script>
+
+<script src="./js/docx-preview.min.js"></script>
+
+<body>
+    ...
+    <div id="container"></div>
+    ...
+</body>
+
+<script>
+  // fectch document Blob,maybe from input width type = file
+  let docData = document.querySelector('input').files[0];
+
+  // synchronously rendering function
+  docx.renderSync(docData, document.getElementById("container"))
+      .then(wordDocument => {
+        // if you need to get the Word document object
+        console.log("docx document object", wordDocument);
+      });
+</script>
+```
+
+API
+---
+### renderSync
+
+Render HTML5 Elements Synchronously.
+
+renderSync = praseAsync + renderDocument(sync:true)
+
+```typescript
+// renders document into specified element synchronously
+renderSync(
+    document: Blob | ArrayBuffer | Uint8Array, // could be any type that supported by JSZip.loadAsync
+    bodyContainer: HTMLElement, //element to render document content,
+    styleContainer: HTMLElement, //element to render document styles, numbeings, fonts. If null, bodyContainer will be used.
+    options: {
+        breakPages: boolean = true, //enables page breaking on page breaks
+        className: string = "docx", //class name/prefix for default and document style classes
+        ignoreFonts: boolean = false, //disables fonts rendering
+        ignoreHeight: boolean = false, //disables rendering height of page
+        ignoreImageWrap: boolean = false, //disables image text wrap setting
+        ignoreLastRenderedPageBreak: boolean = true, //disables page breaking on lastRenderedPageBreak elements
+        ignoreTableWrap: boolean = true, //disables table's text wrap setting
+        ignoreWidth: boolean = false, //disables rendering width of page
+        inWrapper: boolean = true, //enables rendering of wrapper around document content
+        renderChanges: false, //enables experimental rendering of document changes (inserions/deletions)
+        renderEndnotes: true, //enables endnotes rendering
+        renderFooters: true, //enables footers rendering
+        renderFootnotes: true, //enables footnotes rendering
+        renderHeaders: true, //enables headers rendering
+        trimXmlDeclaration: boolean = true, //if true, xml declaration will be removed from xml documents before parsing
+        useBase64URL: boolean = false, //if true, images, fonts, etc. will be converted to base 64 URL, otherwise URL.createObjectURL is used
+        debug: boolean = false, //enables additional logging
+        experimental: boolean = false, //enables experimental features (tab stops calculation)
+    }): Promise<WordDocument>
+```
+
+### renderAsync
+
+Render HTML5 Elements Asynchronously
+
+renderSync = praseAsync + renderDocument(sync:false)
+
+```typescript
+// renders document into specified element synchronously
+renderAsync(
+    document: Blob | ArrayBuffer | Uint8Array, // could be any type that supported by JSZip.loadAsync
+    bodyContainer: HTMLElement, //element to render document content,
+    styleContainer: HTMLElement, //element to render document styles, numbeings, fonts. If null, bodyContainer will be used.
+    options: {
+        breakPages: boolean = true, //enables page breaking on page breaks
+        className: string = "docx", //class name/prefix for default and document style classes
+        ignoreFonts: boolean = false, //disables fonts rendering
+        ignoreHeight: boolean = false, //disables rendering height of page
+        ignoreImageWrap: boolean = false, //disables image text wrap setting
+        ignoreLastRenderedPageBreak: boolean = true, //disables page breaking on lastRenderedPageBreak elements
+        ignoreTableWrap: boolean = true, //disables table's text wrap setting
+        ignoreWidth: boolean = false, //disables rendering width of page
+        inWrapper: boolean = true, //enables rendering of wrapper around document content
+        renderChanges: false, //enables experimental rendering of document changes (inserions/deletions)
+        renderEndnotes: true, //enables endnotes rendering
+        renderFooters: true, //enables footers rendering
+        renderFootnotes: true, //enables footnotes rendering
+        renderHeaders: true, //enables headers rendering
+        trimXmlDeclaration: boolean = true, //if true, xml declaration will be removed from xml documents before parsing
+        useBase64URL: boolean = false, //if true, images, fonts, etc. will be converted to base 64 URL, otherwise URL.createObjectURL is used
+        debug: boolean = false, //enables additional logging
+        experimental: boolean = false, //enables experimental features (tab stops calculation)
+    }): Promise<WordDocument>
+```
+
+### parseAsync
+
+Document Parser Asynchronously
+
+parse document and return internal document object. this could be used to modify document object before rendering
+
+```typescript
+// ==== experimental / internal API ====
+parseAsync(document: Blob | ArrayBuffer | Uint8Array, options: Options): Promise<WordDocument>
+```
+
+### renderDocument
+
+render internal document object into specified container.
+
+sync is a boolean parameter which enables synchronous rendering or asynchronous.
+
+```typescript
+// ==== experimental / internal API ====
+renderDocument(
+  wordDocument: WordDocument, 
+  bodyContainer: HTMLElement, 
+  styleContainer: HTMLElement,
+  sync: boolean,
+  options: Options,
+): Promise<void>
+```
+
+Goals
+----
+* Render/convert DOCX document into HTML document with keeping HTML semantic as much as possible.
+* Support break pages strictly
+* Parse all elements from Office Open XML specification
+
+This library is limited by HTML capabilities.If you need to render document on canvas,try the onlyOffice library.
+
+Partially Supported Namespaces
+------------------
+1. [x] DocumentFormat.OpenXml.Wordprocessing
+2. [x] DocumentFormat.OpenXml.Math
+
+Not Supported Namespaces
+------------------------
+1. [ ] DocumentFormat.OpenXml.Drawing
+2. [ ] DocumentFormat.OpenXml.Drawing.Charts
+3. [ ] DocumentFormat.OpenXml.InkML
+4. [ ] DocumentFormat.OpenXml.Vml
+
+Breaks
+------
+
+Currently, library does break pages:
+
+- if user/manual page break `<w:br w:type="page"/>` is inserted - when user insert page break
+- if application page break `<w:lastRenderedPageBreak/>` is inserted - could be inserted by editor application like MS Word (`ignoreLastRenderedPageBreak` should be set to false)
+- if page settings for paragraph is changed - ex: user change settings from portrait to landscape page
+
+Realtime page breaking is not implemented because it's requires re-calculation of sizes on each insertion and that could affect performance a lot.
+
+If page breaking is crutual for you, I would recommend:
+
+- try to insert manual break point as much as you could
+- try to use editors like MS Word, that inserts `<w:lastRenderedPageBreak/>` break points

package/dist/docx-preview.d.ts

@@ -0,0 +1,39 @@
+/*
+ * @license
+ * docx-preview <https://github.com/VolodymyrBaydalka/docxjs>
+ * Released under Apache License 2.0  <https://github.com/VolodymyrBaydalka/docxjs/blob/master/LICENSE>
+ * Copyright Volodymyr Baydalka
+ */
+export interface Options {
+	breakPages: boolean;                    //enables page breaking on page breaks
+	className: string;                      //class name/prefix for default and document style classes
+
+	ignoreFonts: boolean;                   //disables fonts rendering
+	ignoreHeight: boolean;                  //disables rendering height of page
+	ignoreImageWrap: boolean;               //disables image text wrap setting
+	ignoreLastRenderedPageBreak: boolean;   //disables page breaking on lastRenderedPageBreak elements
+	ignoreTableWrap: boolean;               //disables table's text wrap setting
+	ignoreWidth: boolean;                   //disables rendering width of page
+
+	inWrapper: boolean;                     //enables rendering of wrapper around document content
+
+	renderChanges: boolean;                 //enables experimental rendering of document changes (inserions/deletions)
+	renderEndnotes: boolean;                //enables endnotes rendering
+	renderFooters: boolean;                 //enables footers rendering
+	renderFootnotes: boolean;               //enables footnotes rendering
+	renderHeaders: boolean;                 //enables headers rendering
+
+	trimXmlDeclaration: boolean;            //if true, xml declaration will be removed from xml documents before parsing
+	useBase64URL: boolean;                  //if true, images, fonts, etc. will be converted to base 64 URL, otherwise URL.createObjectURL is used
+
+	debug: boolean;                         //enables additional logging
+	experimental: boolean;                  //enables experimental features (tab stops calculation)
+}
+
+export declare const defaultOptions: Options;
+
+export declare function praseAsync(data: Blob | any, userOptions?: Partial<Options>): Promise<any>;
+
+export declare function renderAsync(data: any, bodyContainer: HTMLElement, styleContainer?: HTMLElement, options?: Partial<Options>): Promise<any>;
+
+export declare function renderSync(data: any, bodyContainer: HTMLElement, styleContainer?: HTMLElement, options?: Partial<Options>): Promise<any>;