commonform-docx 10.1.0 → 10.1.2

package/README.md

@@ -12,7 +12,7 @@ The exported function takes three arguments:
 
 The options object must contain:
 
-1. a `numbering` property whose value is an [abstract numbering](https://npmjs.com/packages/abstract-numbering)
+1. a `numbering` property whose value is an [abstract numbering](https://npmjs.com/package/abstract-numbering)
 
 It may contain:
 
@@ -26,4 +26,17 @@ It may contain:
 
 5. other properties you can find in function exported from `index.js`
 
-The function returns a [JSZip](https://npmjs.com/packages/jszip) Object primed with `.docx` document data.
+The function returns a [JSZip](https://npmjs.com/package/jszip) Object primed with `.docx` document data.
+
+For example:
+
+```javascript
+const zip = docx(form, {
+  title: 'Example Document',
+  version: 'Version 1.0.0'
+})
+await writeFile(
+  'example.docx',
+  await zip.generateAsync({ type: 'nodebuffer' })
+)
+```

package/bin.js

@@ -14,7 +14,7 @@ const usage = [
   '  -h, --help                          Show this screen.',
   '  -v, --version                       Show version.',
   '  -H, --hash                          Render form hash',
-  '  -a, --a4-paper                      A4 paper',
+  '  -a, --a4-paper                      Set paper size to A4',
   '  -b TEXT, --blank-text TEXT          Render blanks with custom text',
   '  --complete                          Throw an error if any blank does not have a value.',
   '  --component-style STYLE             Change component style [default: both]',
@@ -32,7 +32,7 @@ const usage = [
   '  -r --left-align-body                Left-align body paragraphs.',
   '  -s PAGES, --signatures PAGES        Signature page data',
   '  -t TITLE, --title TITLE             Render title as <h1>',
-  '  -v JSON --values JSON               Use values to fill in blanks',
+  '  --values JSON                       Use values to fill in blanks',
   '  -y JSON, --styles JSON              Render with custom styles'
 ].join('\n')
 

package/index.js

@@ -81,7 +81,7 @@ module.exports = (form, values = [], options = {}) => {
     }
   )
   const scaffold = require('./data/scaffold.json')
-  const clone = Object.assign({}, scaffold)
+  const clone = structuredClone(scaffold)
   clone.word['document.xml'] = result.xml
   clone.word._rels['document.xml.rels'] = docRels(result.hrefs)
   // Set default font size.  We need to replace <w:sz> and <w:szCs>
@@ -101,9 +101,122 @@ module.exports = (form, values = [], options = {}) => {
     clone.word['styles.xml'] = clone.word['styles.xml']
       .replaceAll(
         '<w:rFonts w:ascii="Times New Roman" w:hAnsi="Times New Roman"/>',
-        `<w:rFonts w:ascii="${font}" w:hAnsi="${font}"/>`
+        `<w:rFonts w:ascii="${font}" w:hAnsi="${font}" w:cs="${font}"/>`
       )
   }
+  // Set styles for comment bubble text to match main body.
+  // It's not exactly clear what each of these styles apply to.  It at
+  // least appears that some versions of Word, like 365 and For Mac, use
+  // primarily or exclusively the "Balloon" styles, while Word for
+  // Windows seems to use primarily the "Comment" styles.
+  const rsid = '<w:rsid w:val="009714CB"/>'
+  const fontAndSizeTags = `<w:rFonts w:ascii="${font}" w:hAnsi="${font}" w:cs="${font}"/><w:sz w:val="${fontSizeInHalfPoints}"/><w:szCs w:val="${fontSizeInHalfPoints}"/>`
+  clone.word['styles.xml'] = clone.word['styles.xml']
+    .replace(
+      '</w:styles>',
+      [
+        // Balloon Text
+        '<w:style w:type="paragraph" w:styleId="BalloonText">',
+        '<w:name w:val="Balloon Text"/>',
+        '<w:basedOn w:val="Normal"/>',
+        '<w:link w:val="BalloonTextChar"/>',
+        '<w:uiPriority w:val="99"/>',
+        '<w:semiHidden/>',
+        '<w:unhideWhenUsed/>',
+        rsid,
+        '<w:pPr><w:spacing w:before="0" w:after="0"/></w:pPr>',
+        '<w:rPr>',
+        fontAndSizeTags,
+        '</w:rPr>',
+        '</w:style>',
+
+        // Balloon Text Char
+        '<w:style w:type="character" w:customStyle="1" w:styleId="BalloonTextChar">',
+        '<w:name w:val="Balloon Text Char"/>',
+        '<w:basedOn w:val="DefaultParagraphFont"/>',
+        '<w:link w:val="BalloonText"/>',
+        '<w:uiPriority w:val="99"/>',
+        '<w:semiHidden/>',
+        rsid,
+        '<w:rPr>',
+        fontAndSizeTags,
+        '</w:rPr>',
+        '</w:style>',
+
+        // Comment Reference
+        '<w:style w:type="character" w:styleId="CommentReference">',
+        '<w:name w:val="annotation reference"/>',
+        '<w:basedOn w:val="DefaultParagraphFont"/>',
+        '<w:uiPriority w:val="99"/>',
+        '<w:semiHidden/>',
+        '<w:unhideWhenUsed/>',
+        rsid,
+        '<w:rPr>',
+        fontAndSizeTags,
+        '</w:rPr>',
+        '</w:style>',
+
+        // Comment Text
+        '<w:style w:type="paragraph" w:styleId="CommentText">',
+        '<w:name w:val="annotation text"/>',
+        '<w:basedOn w:val="Normal"/>',
+        '<w:link w:val="CommentTextChar"/>',
+        '<w:uiPriority w:val="99"/>',
+        '<w:semiHidden/>',
+        '<w:unhideWhenUsed/>',
+        rsid,
+        '<w:pPr><w:spacing w:line="240" w:lineRule="auto"/></w:pPr>',
+        '<w:rPr>',
+        fontAndSizeTags,
+        '</w:rPr>',
+        '</w:style>',
+
+        // Comment Text Char
+        '<w:style w:type="character" w:customStyle="1" w:styleId="CommentTextChar">',
+        '<w:name w:val="Comment Text Char"/>',
+        '<w:basedOn w:val="DefaultParagraphFont"/>',
+        '<w:link w:val="CommentText"/>',
+        '<w:uiPriority w:val="99"/>',
+        '<w:semiHidden/>',
+        rsid,
+        '<w:rPr>',
+        fontAndSizeTags,
+        '</w:rPr>',
+        '</w:style>',
+
+        // Comment Subject
+        '<w:style w:type="paragraph" w:styleId="CommentSubject">',
+        '<w:name w:val="annotation subject"/>',
+        '<w:basedOn w:val="CommentText"/>',
+        '<w:next w:val="CommentText"/>',
+        '<w:link w:val="CommentSubjectChar"/>',
+        '<w:uiPriority w:val="99"/>',
+        '<w:semiHidden/>',
+        '<w:unhideWhenUsed/>',
+        rsid,
+        '<w:rPr>',
+        '<w:b/><w:bCs/>',
+        fontAndSizeTags,
+        '</w:rPr>',
+        '</w:style>',
+
+        // Comment Subject Char
+        '<w:style w:type="character" w:customStyle="1" w:styleId="CommentSubjectChar">',
+        '<w:name w:val="Comment Subject Char"/>',
+        '<w:basedOn w:val="CommentTextChar"/>',
+        '<w:link w:val="CommentSubject"/>',
+        '<w:uiPriority w:val="99"/>',
+        '<w:semiHidden/>',
+        rsid,
+        '<w:rPr>',
+        '<w:b/><w:bCs/>',
+        fontAndSizeTags,
+        '</w:rPr>',
+        '</w:style>',
+
+        '</w:styles>'
+      ].join('')
+    )
   const zip = new JSZip()
   zipObject(zip, clone)
   return zip

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "commonform-docx",
   "description": "render Common Forms in Office Open XML (Microsoft Word .docx format)",
-  "version": "10.1.0",
+  "version": "10.1.2",
   "author": "Kyle E. Mitchell <kyle@kemitchell.com> (http://kemitchell.com)",
   "bin": "bin.js",
   "files": [