@docx4j/core-ts 0.1.5 → 0.2.1

package/dist/parts/wml/spliceableStyles.mjs

@@ -0,0 +1,122 @@
+// The style definitions docx4j's own `styles.xml` carries but leaves **commented out**, so that
+// `createPackage()` - which writes that file verbatim (`DEFAULT_STYLES_XML`, generated, faithful to
+// docx4j) - produces a document without them. `pkg.styles.ensure(ids)` splices them in when a caller
+// needs one: inserting a footnote into such a document otherwise shows the note in Normal
+// (CR-002 section 22.2).
+//
+// Taken verbatim from the two comments in
+// docx4j-core/src/main/resources/org/docx4j/openpackaging/parts/WordprocessingML/styles.xml
+// (a UTF-16 file; docx4j VERSION_17_3_0), which is where Word's own definitions of these came from.
+// 9 styles: BlockText, EndnoteText, EndnoteTextChar, Footer, FooterChar, FootnoteText, FootnoteTextChar, FootnoteReference, EndnoteReference.
+export const SPLICEABLE_STYLES_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:styles xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+<w:style w:type="paragraph" w:styleId="BlockText">
+    <w:name w:val="Block Text" />
+    <w:basedOn w:val="Normal" />
+    <w:uiPriority w:val="99" />
+    <w:unhideWhenUsed />
+    <w:rsid w:val="00841CD9" />
+    <w:pPr>
+      <w:pBdr>
+        <w:top w:val="single" w:sz="2" w:space="10" w:color="4F81BD" w:themeColor="accent1" w:shadow="1" />
+        <w:left w:val="single" w:sz="2" w:space="10" w:color="4F81BD" w:themeColor="accent1" w:shadow="1" />
+        <w:bottom w:val="single" w:sz="2" w:space="10" w:color="4F81BD" w:themeColor="accent1" w:shadow="1" />
+        <w:right w:val="single" w:sz="2" w:space="10" w:color="4F81BD" w:themeColor="accent1" w:shadow="1" />
+      </w:pBdr>
+      <w:ind w:left="1152" w:right="1152" />
+    </w:pPr>
+    <w:rPr>
+      <w:rFonts w:eastAsiaTheme="minorEastAsia" />
+      <w:i />
+      <w:iCs />
+      <w:color w:val="4F81BD" w:themeColor="accent1" />
+    </w:rPr>
+  </w:style>
+  <w:style w:type="paragraph" w:styleId="EndnoteText">
+    <w:name w:val="endnote text" />
+    <w:basedOn w:val="Normal" />
+    <w:link w:val="EndnoteTextChar" />
+    <w:uiPriority w:val="99" />
+    <w:unhideWhenUsed />
+    <w:rsid w:val="00841CD9" />
+    <w:rPr>
+      <w:sz w:val="20" />
+      <w:szCs w:val="20" />
+    </w:rPr>
+  </w:style>
+  <w:style w:type="character" w:customStyle="1" w:styleId="EndnoteTextChar">
+    <w:name w:val="Endnote Text Char" />
+    <w:basedOn w:val="DefaultParagraphFont" />
+    <w:link w:val="EndnoteText" />
+    <w:uiPriority w:val="99" />
+    <w:rsid w:val="00841CD9" />
+    <w:rPr>
+      <w:sz w:val="20" />
+      <w:szCs w:val="20" />
+    </w:rPr>
+  </w:style>
+  <w:style w:type="paragraph" w:styleId="Footer">
+    <w:name w:val="footer" />
+    <w:basedOn w:val="Normal" />
+    <w:link w:val="FooterChar" />
+    <w:uiPriority w:val="99" />
+    <w:unhideWhenUsed />
+    <w:rsid w:val="00841CD9" />
+    <w:pPr>
+      <w:tabs>
+        <w:tab w:val="center" w:pos="4680" />
+        <w:tab w:val="right" w:pos="9360" />
+      </w:tabs>
+    </w:pPr>
+  </w:style>
+  <w:style w:type="character" w:customStyle="1" w:styleId="FooterChar">
+    <w:name w:val="Footer Char" />
+    <w:basedOn w:val="DefaultParagraphFont" />
+    <w:link w:val="Footer" />
+    <w:uiPriority w:val="99" />
+    <w:rsid w:val="00841CD9" />
+  </w:style>
+  <w:style w:type="paragraph" w:styleId="FootnoteText">
+    <w:name w:val="footnote text" />
+    <w:basedOn w:val="Normal" />
+    <w:link w:val="FootnoteTextChar" />
+    <w:uiPriority w:val="99" />
+    <w:unhideWhenUsed />
+    <w:rsid w:val="00841CD9" />
+    <w:rPr>
+      <w:sz w:val="20" />
+      <w:szCs w:val="20" />
+    </w:rPr>
+  </w:style>
+  <w:style w:type="character" w:customStyle="1" w:styleId="FootnoteTextChar">
+    <w:name w:val="Footnote Text Char" />
+    <w:basedOn w:val="DefaultParagraphFont" />
+    <w:link w:val="FootnoteText" />
+    <w:uiPriority w:val="99" />
+    <w:rsid w:val="00841CD9" />
+    <w:rPr>
+      <w:sz w:val="20" />
+      <w:szCs w:val="20" />
+    </w:rPr>
+  </w:style>
+<w:style w:type="character" w:styleId="FootnoteReference">
+    <w:name w:val="footnote reference" />
+    <w:basedOn w:val="DefaultParagraphFont" />
+    <w:uiPriority w:val="99" />
+    <w:unhideWhenUsed />
+    <w:rsid w:val="00D1197D" />
+    <w:rPr>
+      <w:vertAlign w:val="superscript" />
+    </w:rPr>
+  </w:style>
+  <w:style w:type="character" w:styleId="EndnoteReference">
+    <w:name w:val="endnote reference" />
+    <w:basedOn w:val="DefaultParagraphFont" />
+    <w:uiPriority w:val="99" />
+    <w:unhideWhenUsed />
+    <w:rsid w:val="00D1197D" />
+    <w:rPr>
+      <w:vertAlign w:val="superscript" />
+    </w:rPr>
+  </w:style>
+</w:styles>`;

package/dist/xml/dom.d.mts

@@ -1,6 +1,15 @@
 /** The declaration docx4j writes on every XML part. */
 export declare const XML_DECLARATION = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>";
-/** Parses XML text to a DOM document; throws on malformed input. */
+/**
+ * Parses XML text to a DOM document; throws on malformed input, in a browser as in Node.
+ *
+ * xmldom throws. A browser's `DOMParser` does not: Chromium returns the document up to the error
+ * with an XHTML `parsererror` element first in the root, and Firefox a `parsererror` root in its
+ * own namespace, and handing that on unmarshalled a truncated part without complaint - a settings
+ * part with a stray `<` kept its first child and lost the rest, which a save would have written
+ * (CR-002 section 33). Such a document is refused here, with the parser's own message, which
+ * carries the line and column in both browsers.
+ */
 export declare function parseXml(text: string): Document;
 /** Serialises a node (document or element) without an XML declaration. */
 export declare function serializeXml(node: Node): string;

package/dist/xml/dom.mjs

@@ -1,12 +1,56 @@
 // DOM, text and base64 helpers over the runtime's DOM implementation. In Node the runtime brings
 // @xmldom/xmldom; in browsers it uses the native DOM. Jsonix.DOM is typed since @docx4j/jsonix 3.2.1.
 import { Jsonix } from '@docx4j/generated-objects-ts';
+import { Docx4JException } from '../opc/exceptions.mjs';
 const DOM = Jsonix.DOM;
 /** The declaration docx4j writes on every XML part. */
 export const XML_DECLARATION = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>';
-/** Parses XML text to a DOM document; throws on malformed input. */
+/**
+ * Parses XML text to a DOM document; throws on malformed input, in a browser as in Node.
+ *
+ * xmldom throws. A browser's `DOMParser` does not: Chromium returns the document up to the error
+ * with an XHTML `parsererror` element first in the root, and Firefox a `parsererror` root in its
+ * own namespace, and handing that on unmarshalled a truncated part without complaint - a settings
+ * part with a stray `<` kept its first child and lost the rest, which a save would have written
+ * (CR-002 section 33). Such a document is refused here, with the parser's own message, which
+ * carries the line and column in both browsers.
+ */
 export function parseXml(text) {
-    return DOM.parse(text);
+    const doc = DOM.parse(text);
+    const error = parserErrorOf(doc);
+    if (error !== undefined)
+        throw new Docx4JException(`Malformed XML: ${error}`);
+    return doc;
+}
+/** The namespaces a browser puts its `parsererror` element in: Chromium and WebKit's, Firefox's. */
+const PARSER_ERROR_NAMESPACES = new Set([
+    'http://www.w3.org/1999/xhtml',
+    'http://www.mozilla.org/newlayout/xml/parsererror.xml',
+]);
+/**
+ * The message of a browser's `parsererror` document - the root, or the root's first element child,
+ * named `parsererror` in one of the parser-error namespaces - or undefined for a document that
+ * parsed. Chromium's message is the `div` in its element; its `h3`s are boilerplate.
+ */
+function parserErrorOf(doc) {
+    var _a, _b;
+    const root = doc.documentElement;
+    if (!root)
+        return undefined;
+    let first = null;
+    for (let child = root.firstChild; child; child = child.nextSibling) {
+        if (child.nodeType === 1) {
+            first = child;
+            break;
+        }
+    }
+    for (const element of [root, first]) {
+        if (element === null || element.localName !== 'parsererror' || !PARSER_ERROR_NAMESPACES.has((_a = element.namespaceURI) !== null && _a !== void 0 ? _a : ''))
+            continue;
+        const div = element.getElementsByTagNameNS('http://www.w3.org/1999/xhtml', 'div')[0];
+        return ((_b = (div !== null && div !== void 0 ? div : element).textContent) !== null && _b !== void 0 ? _b : '').replace(/\s+/g, ' ').trim() || 'the parser reported an error';
+    }
+    return undefined;
 }
 /** Serialises a node (document or element) without an XML declaration. */
 export function serializeXml(node) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docx4j/core-ts",
-  "version": "0.1.5",
+  "version": "0.2.1",
   "description": "docx4j-core for TypeScript: Open Packaging (docx/pptx/xlsx zip and flat OPC), typed parts and relationships, style, numbering and font resolution over @docx4j/generated-objects-ts. Node, browsers, Word add-ins.",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -79,7 +79,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@docx4j/generated-objects-ts": "^0.2.0",
+    "@docx4j/generated-objects-ts": "^0.3.0",
     "fflate": "^0.8.2"
   },
   "devDependencies": {