@docx4j/core-ts 0.1.5 → 0.2.0

package/dist/parts/sml/index.mjs

@@ -1,10 +1,13 @@
 import { XmlPart } from '../XmlPart.mjs';
-import { DefaultXmlPart } from '../DefaultXmlPart.mjs';
 import { BinaryPart } from '../BinaryPart.mjs';
 import { ContentTypes } from '../../opc/ContentTypes.mjs';
 import { Namespaces } from '../Namespaces.mjs';
 import { Xlsx4jException } from '../../opc/exceptions.mjs';
 const S = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main';
+/** The Excel 2010 extension namespace (x14; docx4j's org.xlsx4j...x2009.x9.main). */
+const X14 = 'http://schemas.microsoft.com/office/spreadsheetml/2009/9/main';
+/** The Excel 2013 extension namespace (x15; docx4j's org.xlsx4j...x2010.x11.main). */
+const X15 = 'http://schemas.microsoft.com/office/spreadsheetml/2010/11/main';
 export class WorkbookPart extends XmlPart {
     constructor(partName = '/xl/workbook.xml', contentType = ContentTypes.SPREADSHEETML_WORKBOOK) {
         super(partName, contentType, Namespaces.SPREADSHEETML_WORKBOOK, { namespaceURI: S, localPart: 'workbook' });
@@ -196,50 +199,51 @@ export class PrinterSettingsPart extends BinaryPart {
         super(partName, ContentTypes.SPREADSHEETML_PRINTER_SETTINGS, Namespaces.SPREADSHEETML_PRINTER_SETTINGS);
     }
 }
-// The Excel 2010 and 2013 extension parts (CR-004 phase A; docx4j
-// org.docx4j.openpackaging.parts.SpreadsheetML).  The seven XML ones are `DefaultXmlPart`s for
-// now: their DOM round-trips byte for byte, and nothing re-marshals them, so an `mc:Ignorable`
-// they carry is untouched.  Phase B makes them `XmlPart`s over the `x14` and `x15` roots.
+// The Excel 2010 and 2013 extension parts (CR-004; docx4j
+// org.docx4j.openpackaging.parts.SpreadsheetML).  Phase A held the seven XML ones as DOM; phase B
+// types them over the x14 and x15 roots the objects package's CR-022 regeneration bound, so their
+// contents read like any other part's and a re-marshalled root is Excel's own shape (the
+// mc:Ignorable Excel writes on them is a property of each root, re-declared by `XmlPart`).
 /** A slicer cache (`x14:slicerCacheDefinition`), from the workbook. docx4j `SlicerCachePart`. */
-export class SlicerCachePart extends DefaultXmlPart {
+export class SlicerCachePart extends XmlPart {
     constructor(partName = '/xl/slicerCaches/slicerCache1.xml') {
-        super(partName, ContentTypes.SPREADSHEETML_SLICER_CACHE, Namespaces.SPREADSHEETML_SLICER_CACHE);
+        super(partName, ContentTypes.SPREADSHEETML_SLICER_CACHE, Namespaces.SPREADSHEETML_SLICER_CACHE, { namespaceURI: X14, localPart: 'slicerCacheDefinition' });
     }
 }
 /** A sheet's slicers (`x14:slicers`). docx4j `SlicersPart`. */
-export class SlicersPart extends DefaultXmlPart {
+export class SlicersPart extends XmlPart {
     constructor(partName = '/xl/slicers/slicer1.xml') {
-        super(partName, ContentTypes.SPREADSHEETML_SLICERS, Namespaces.SPREADSHEETML_SLICERS);
+        super(partName, ContentTypes.SPREADSHEETML_SLICERS, Namespaces.SPREADSHEETML_SLICERS, { namespaceURI: X14, localPart: 'slicers' });
     }
 }
 /** A timeline cache (`x15:timelineCacheDefinition`), from the workbook. docx4j `TimelineCachePart`. */
-export class TimelineCachePart extends DefaultXmlPart {
+export class TimelineCachePart extends XmlPart {
     constructor(partName = '/xl/timelineCaches/timelineCache1.xml') {
-        super(partName, ContentTypes.SPREADSHEETML_TIMELINE_CACHE, Namespaces.SPREADSHEETML_TIMELINE_CACHE);
+        super(partName, ContentTypes.SPREADSHEETML_TIMELINE_CACHE, Namespaces.SPREADSHEETML_TIMELINE_CACHE, { namespaceURI: X15, localPart: 'timelineCacheDefinition' });
     }
 }
 /** A sheet's timelines (`x15:timelines`). docx4j `TimelinesPart`. */
-export class TimelinesPart extends DefaultXmlPart {
+export class TimelinesPart extends XmlPart {
     constructor(partName = '/xl/timelines/timeline1.xml') {
-        super(partName, ContentTypes.SPREADSHEETML_TIMELINES, Namespaces.SPREADSHEETML_TIMELINES);
+        super(partName, ContentTypes.SPREADSHEETML_TIMELINES, Namespaces.SPREADSHEETML_TIMELINES, { namespaceURI: X15, localPart: 'timelines' });
     }
 }
 /** A form control's properties (`x14:formControlPr`), from a worksheet. docx4j `ControlPropertiesPart`. */
-export class ControlPropertiesPart extends DefaultXmlPart {
+export class ControlPropertiesPart extends XmlPart {
     constructor(partName = '/xl/ctrlProps/ctrlProp1.xml') {
-        super(partName, ContentTypes.SPREADSHEETML_CONTROL_PROPERTIES, Namespaces.SPREADSHEETML_CONTROL_PROPERTIES);
+        super(partName, ContentTypes.SPREADSHEETML_CONTROL_PROPERTIES, Namespaces.SPREADSHEETML_CONTROL_PROPERTIES, { namespaceURI: X14, localPart: 'formControlPr' });
     }
 }
 /** The properties of a custom data part (`x14:datastoreItem`). docx4j `CustomDataPropertiesPart`. */
-export class CustomDataPropertiesPart extends DefaultXmlPart {
+export class CustomDataPropertiesPart extends XmlPart {
     constructor(partName = '/xl/customDataProps/customDataProps1.xml') {
-        super(partName, ContentTypes.SPREADSHEETML_CUSTOM_DATA_PROPERTIES, Namespaces.SPREADSHEETML_CUSTOM_DATA_PROPERTIES);
+        super(partName, ContentTypes.SPREADSHEETML_CUSTOM_DATA_PROPERTIES, Namespaces.SPREADSHEETML_CUSTOM_DATA_PROPERTIES, { namespaceURI: X14, localPart: 'datastoreItem' });
     }
 }
 /** A survey (`x15:survey`), from the workbook. docx4j `SurveyPart`. */
-export class SurveyPart extends DefaultXmlPart {
+export class SurveyPart extends XmlPart {
     constructor(partName = '/xl/surveys/survey1.xml') {
-        super(partName, ContentTypes.SPREADSHEETML_SURVEY, Namespaces.SPREADSHEETML_SURVEY);
+        super(partName, ContentTypes.SPREADSHEETML_SURVEY, Namespaces.SPREADSHEETML_SURVEY, { namespaceURI: X15, localPart: 'survey' });
     }
 }
 /**

package/dist/parts/wml/index.d.mts

@@ -85,8 +85,16 @@ export declare class MainDocumentPart extends DocumentPart<wml.Document> {
     /** The style ids used directly in the document (docx4j `getStylesInUse()`); not those that
      *  others are merely based on. */
     getStylesInUse(): Promise<Set<string>>;
-    /** The block-level content of each story, in docx4j's order: the body, then the headers and
-     *  footers, the endnotes, the footnotes and the comments. */
+    /**
+     * The block-level content of each story, in docx4j's order: the body, then the headers and
+     * footers, the endnotes, the footnotes and the comments.
+     *
+     * Every story is read **privately** (`readContents`, which answers the unmarshalled tree when
+     * there is one and parses without keeping it when there is not), so asking a document which
+     * fonts it uses does not cost any part its byte-for-byte round trip. The body used to come from
+     * `getContents()`, which unmarshalled the main part and so re-marshalled it on the next save
+     * (CR-001 section 18).
+     */
     private stories;
     /** The styles part and its `w:default="1"` style ids, read without costing it its round trip. */
     private styleSource;

package/dist/parts/wml/index.mjs

@@ -207,11 +207,19 @@ export class MainDocumentPart extends DocumentPart {
     async getStylesInUse() {
         return walkStories(await this.stories(), await this.styleSource(), undefined, false).styles;
     }
-    /** The block-level content of each story, in docx4j's order: the body, then the headers and
-     *  footers, the endnotes, the footnotes and the comments. */
+    /**
+     * The block-level content of each story, in docx4j's order: the body, then the headers and
+     * footers, the endnotes, the footnotes and the comments.
+     *
+     * Every story is read **privately** (`readContents`, which answers the unmarshalled tree when
+     * there is one and parses without keeping it when there is not), so asking a document which
+     * fonts it uses does not cost any part its byte-for-byte round trip. The body used to come from
+     * `getContents()`, which unmarshalled the main part and so re-marshalled it on the next save
+     * (CR-001 section 18).
+     */
     async stories() {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
-        const out = [(_b = (_a = (await this.getContents()).body) === null || _a === void 0 ? void 0 : _a.content) !== null && _b !== void 0 ? _b : []];
+        const out = [(_b = (_a = (await this.readContents()).body) === null || _a === void 0 ? void 0 : _a.content) !== null && _b !== void 0 ? _b : []];
         const rp = this.relationshipsPart;
         for (const r of (_c = rp === null || rp === void 0 ? void 0 : rp.relationships.relationship) !== null && _c !== void 0 ? _c : []) {
             const part = rp === null || rp === void 0 ? void 0 : rp.getPart(r);

package/dist/parts/wml/spliceableStyles.d.mts

@@ -0,0 +1 @@
+export declare const SPLICEABLE_STYLES_XML = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<w:styles xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\" xmlns:w=\"http://schemas.openxmlformats.org/wordprocessingml/2006/main\">\n<w:style w:type=\"paragraph\" w:styleId=\"BlockText\">\n    <w:name w:val=\"Block Text\" />\n    <w:basedOn w:val=\"Normal\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:unhideWhenUsed />\n    <w:rsid w:val=\"00841CD9\" />\n    <w:pPr>\n      <w:pBdr>\n        <w:top w:val=\"single\" w:sz=\"2\" w:space=\"10\" w:color=\"4F81BD\" w:themeColor=\"accent1\" w:shadow=\"1\" />\n        <w:left w:val=\"single\" w:sz=\"2\" w:space=\"10\" w:color=\"4F81BD\" w:themeColor=\"accent1\" w:shadow=\"1\" />\n        <w:bottom w:val=\"single\" w:sz=\"2\" w:space=\"10\" w:color=\"4F81BD\" w:themeColor=\"accent1\" w:shadow=\"1\" />\n        <w:right w:val=\"single\" w:sz=\"2\" w:space=\"10\" w:color=\"4F81BD\" w:themeColor=\"accent1\" w:shadow=\"1\" />\n      </w:pBdr>\n      <w:ind w:left=\"1152\" w:right=\"1152\" />\n    </w:pPr>\n    <w:rPr>\n      <w:rFonts w:eastAsiaTheme=\"minorEastAsia\" />\n      <w:i />\n      <w:iCs />\n      <w:color w:val=\"4F81BD\" w:themeColor=\"accent1\" />\n    </w:rPr>\n  </w:style>\n  <w:style w:type=\"paragraph\" w:styleId=\"EndnoteText\">\n    <w:name w:val=\"endnote text\" />\n    <w:basedOn w:val=\"Normal\" />\n    <w:link w:val=\"EndnoteTextChar\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:unhideWhenUsed />\n    <w:rsid w:val=\"00841CD9\" />\n    <w:rPr>\n      <w:sz w:val=\"20\" />\n      <w:szCs w:val=\"20\" />\n    </w:rPr>\n  </w:style>\n  <w:style w:type=\"character\" w:customStyle=\"1\" w:styleId=\"EndnoteTextChar\">\n    <w:name w:val=\"Endnote Text Char\" />\n    <w:basedOn w:val=\"DefaultParagraphFont\" />\n    <w:link w:val=\"EndnoteText\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:rsid w:val=\"00841CD9\" />\n    <w:rPr>\n      <w:sz w:val=\"20\" />\n      <w:szCs w:val=\"20\" />\n    </w:rPr>\n  </w:style>\n  <w:style w:type=\"paragraph\" w:styleId=\"Footer\">\n    <w:name w:val=\"footer\" />\n    <w:basedOn w:val=\"Normal\" />\n    <w:link w:val=\"FooterChar\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:unhideWhenUsed />\n    <w:rsid w:val=\"00841CD9\" />\n    <w:pPr>\n      <w:tabs>\n        <w:tab w:val=\"center\" w:pos=\"4680\" />\n        <w:tab w:val=\"right\" w:pos=\"9360\" />\n      </w:tabs>\n    </w:pPr>\n  </w:style>\n  <w:style w:type=\"character\" w:customStyle=\"1\" w:styleId=\"FooterChar\">\n    <w:name w:val=\"Footer Char\" />\n    <w:basedOn w:val=\"DefaultParagraphFont\" />\n    <w:link w:val=\"Footer\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:rsid w:val=\"00841CD9\" />\n  </w:style>\n  <w:style w:type=\"paragraph\" w:styleId=\"FootnoteText\">\n    <w:name w:val=\"footnote text\" />\n    <w:basedOn w:val=\"Normal\" />\n    <w:link w:val=\"FootnoteTextChar\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:unhideWhenUsed />\n    <w:rsid w:val=\"00841CD9\" />\n    <w:rPr>\n      <w:sz w:val=\"20\" />\n      <w:szCs w:val=\"20\" />\n    </w:rPr>\n  </w:style>\n  <w:style w:type=\"character\" w:customStyle=\"1\" w:styleId=\"FootnoteTextChar\">\n    <w:name w:val=\"Footnote Text Char\" />\n    <w:basedOn w:val=\"DefaultParagraphFont\" />\n    <w:link w:val=\"FootnoteText\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:rsid w:val=\"00841CD9\" />\n    <w:rPr>\n      <w:sz w:val=\"20\" />\n      <w:szCs w:val=\"20\" />\n    </w:rPr>\n  </w:style>\n<w:style w:type=\"character\" w:styleId=\"FootnoteReference\">\n    <w:name w:val=\"footnote reference\" />\n    <w:basedOn w:val=\"DefaultParagraphFont\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:unhideWhenUsed />\n    <w:rsid w:val=\"00D1197D\" />\n    <w:rPr>\n      <w:vertAlign w:val=\"superscript\" />\n    </w:rPr>\n  </w:style>\n  <w:style w:type=\"character\" w:styleId=\"EndnoteReference\">\n    <w:name w:val=\"endnote reference\" />\n    <w:basedOn w:val=\"DefaultParagraphFont\" />\n    <w:uiPriority w:val=\"99\" />\n    <w:unhideWhenUsed />\n    <w:rsid w:val=\"00D1197D\" />\n    <w:rPr>\n      <w:vertAlign w:val=\"superscript\" />\n    </w:rPr>\n  </w:style>\n</w:styles>";

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docx4j/core-ts",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "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": {