commonform-docx 10.1.1 → 11.0.0

package/bin.js

@@ -1,8 +1,16 @@
 #!/usr/bin/env node
-const docopt = require('@kemitchell/docopt').docopt
-const fs = require('fs')
-const has = require('has')
-const path = require('path')
+import meta from './package.json' with { type: 'json' }
+import { docopt } from '@kemitchell/docopt'
+import { readFileSync } from 'fs'
+import ooxmlSignaturePages from 'ooxml-signature-pages'
+import { resolve } from 'path'
+import docx from './index.js'
+
+import rse from 'resolutions-schedules-exhibits-numbering',
+import ase from 'agreement-schedules-exhibits-numbering',
+import pae from 'plan-addenda-exhibits-numbering',
+import decimal from 'decimal-numbering',
+import outline from 'outline-numbering'
 
 // Parse arguments and options.
 
@@ -14,7 +22,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,11 +40,11 @@ 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')
 
-const parsed = docopt(usage, { version: require('./package.json').version })
+const parsed = docopt(usage, { version: meta.version })
 
 // Parse arguments and options.
 
@@ -53,13 +61,13 @@ if (parsed['--title']) options.title = parsed['--title']
 if (parsed['--number']) {
   const numberStyle = parsed['--number']
   const supportedNumberingStyles = {
-    rse: 'resolutions-schedules-exhibits-numbering',
-    ase: 'agreement-schedules-exhibits-numbering',
-    pae: 'plan-addenda-exhibits-numbering',
-    decimal: 'decimal-numbering',
-    outline: 'outline-numbering'
+    rse,
+    ase,
+    pae,
+    decimal,
+    outline,
   }
-  if (!has(supportedNumberingStyles, numberStyle)) {
+  if (!Object.hasOwn(supportedNumberingStyles, numberStyle)) {
     process.stderr.write([
       `"${numberStyle}" is not a valid numbering style.`,
       'Valid styles are ' +
@@ -69,20 +77,20 @@ if (parsed['--number']) {
     ].join('\n') + '\n')
     process.exit(1)
   } else {
-    options.numberStyle = require(supportedNumberingStyles[numberStyle])
+    options.numberStyle = supportedNumberingStyles[numberStyle]
   }
 } else {
-  options.numberStyle = require('decimal-numbering')
+  options.numberStyle = decimal
 }
 
 if (parsed['--signatures']) {
-  options.after = require('ooxml-signature-pages')(
-    JSON.parse(fs.readFileSync(parsed['--signatures']))
+  options.after = ooxmlSignaturePages(
+    JSON.parse(readFileSync(parsed['--signatures']))
   )
 }
 
 if (parsed['--styles']) {
-  options.styles = JSON.parse(fs.readFileSync(parsed['--styles']))
+  options.styles = JSON.parse(readFileSync(parsed['--styles']))
 }
 
 if (parsed['--title']) options.title = parsed['--title']
@@ -115,10 +123,10 @@ if (parsed['--quote-component-text']) options.quoteComponentText = parsed['--quo
 options.incorporateComponentText = parsed['--incorporate-component-text']
 
 function readJSON (file) {
-  return JSON.parse(fs.readFileSync(path.resolve(file)))
+  return JSON.parse(readFileSync(resolve(file)))
 }
 
 // Render and print.
-const rendered = require('./')(form, blanks, options)
+const rendered = docs(form, blanks, options)
 
 rendered.generateNodeStream().pipe(process.stdout)

package/escape.js

@@ -1,4 +1,4 @@
-module.exports = string => {
+export default string => {
   const special = {
     '&': /&/g,
     ''': /'/g,

package/index.js

@@ -1,10 +1,11 @@
-const JSZip = require('jszip')
-const commonformHash = require('commonform-hash')
-const decimalNumbering = require('decimal-numbering')
-const smartify = require('commonform-smartify')
+import JSZip from 'jszip'
+import commonformHash from 'commonform-hash'
+import decimalNumbering from 'decimal-numbering'
+import smartify from 'commonform-smartify'
+import scaffold from './data/scaffold.json' with { type: 'json' }
 
-const doc = require('./templates/document')
-const docRels = require('./templates/document-relationships')
+import doc from './templates/document.js'
+import docRels from './templates/document-relationships.js'
 
 function defaultStyles (smart) {
   return {
@@ -25,7 +26,7 @@ function defaultStyles (smart) {
   }
 }
 
-module.exports = (form, values = [], options = {}) => {
+export default (form, values = [], options = {}) => {
   let {
     a4 = false,
     after = '',
@@ -80,7 +81,6 @@ module.exports = (form, values = [], options = {}) => {
       version
     }
   )
-  const scaffold = require('./data/scaffold.json')
   const clone = structuredClone(scaffold)
   clone.word['document.xml'] = result.xml
   clone.word._rels['document.xml.rels'] = docRels(result.hrefs)

package/package.json

@@ -1,27 +1,24 @@
 {
   "name": "commonform-docx",
   "description": "render Common Forms in Office Open XML (Microsoft Word .docx format)",
-  "version": "10.1.1",
+  "version": "11.0.0",
   "author": "Kyle E. Mitchell <kyle@kemitchell.com> (http://kemitchell.com)",
   "bin": "bin.js",
+  "type": "module",
+  "main": "index.js",
   "files": [
-    "bin.js",
     "data/scaffold.json",
     "escape.js",
-    "index.js",
-    "LICENSE.md",
-    "README.md",
     "templates"
   ],
   "dependencies": {
     "@kemitchell/docopt": "^1.0.0",
     "agreement-schedules-exhibits-numbering": "^3.0.0",
-    "commonform-flatten": "^3.0.0",
-    "commonform-hash": "^1.0.0",
-    "commonform-prepare-blanks": "^1.0.1",
-    "commonform-smartify": "^1.0.1",
+    "commonform-flatten": "^4.0.0",
+    "commonform-hash": "^2.0.0",
+    "commonform-prepare-blanks": "^2.0.0",
+    "commonform-smartify": "^2.0.0",
     "decimal-numbering": "^4.0.0",
-    "has": "^1.0.3",
     "jszip": "^3.2.1",
     "number-to-words-en": "^1.2.5",
     "ooxml-signature-pages": "^3.0.2",
@@ -30,9 +27,7 @@
     "resolutions-schedules-exhibits-numbering": "^2.0.0"
   },
   "devDependencies": {
-    "istanbul": "^0.4.0",
     "run-series": "^1.1.8",
-    "standard": "^17.0.0",
     "tape": "^5.0.1",
     "textract": "^2.5.0"
   },
@@ -49,11 +44,11 @@
   "license": "BlueOak-1.0.0",
   "repository": "commonform/commonform-docx",
   "scripts": {
-    "lint": "standard",
-    "precoverage": "npm run pretest && istanbul cover -- tape test.js",
-    "coverage": "FORCE_COLOR=true istanbul check-coverage coverage/coverage.json",
-    "prepublishOnly": "node build/scaffold.js data/scaffold.docx > data/scaffold.json",
-    "pretest": "npm run prepublishOnly",
-    "test": "tape test.js"
+    "precoverage": "npm run build",
+    "coverage": "node --experimental-test-coverage --test --test-concurrency=1 test.js",
+    "build": "node build/scaffold.js data/scaffold.docx > data/scaffold.json",
+    "prepublishOnly": "npm run build",
+    "pretest": "npm run build",
+    "test": "node --test --test-concurrency=1 test.js"
   }
 }

package/templates/document-relationships.js

@@ -1,7 +1,8 @@
-const escape = require('../escape')
+import escape from '../escape.js'
+import scaffold from '../data/scaffold.json' with { type: 'json' }
 
-module.exports = array => {
-  const scaffolded = require('../data/scaffold.json').word._rels['document.xml.rels']
+export default array => {
+  const scaffolded = scaffold.word._rels['document.xml.rels']
   if (array.length === 0) return scaffolded
   const appended = []
   for (let index = 0; index < array.length; index++) {

package/templates/document.js

@@ -1,7 +1,7 @@
-const flatten = require('commonform-flatten')
-const hashRun = require('./hash')
-const titleRun = require('./title')
-const paragraph = require('./paragraph')
+import flatten from 'commonform-flatten'
+import hashRun from './hash.js'
+import titleRun from './title.js'
+import paragraph from './paragraph.js'
 
 const DOCUMENT_XMLNS = (
 /* jscs:disable maximumLineLength */
@@ -40,7 +40,7 @@ function section (a4) {
   return returned
 }
 
-module.exports = (form, values, options) => {
+export default (form, values, options) => {
   // Hyperlinks in documents must refer to Relationships by rId.
   // Set up a running list of HREFs to turn into Relationships,
   // then pass a helper function that assigns rIds to HREFs.

package/templates/hash.js

@@ -1,6 +1,6 @@
-const paragraph = require('./paragraph')
+import paragraph from './paragraph.js'
 
-module.exports = (string, options) => {
+export default (string, options) => {
   return paragraph({
     title: true,
     alignment: options.leftAlignTitle ? 'left' : 'center',

package/templates/hyperlink.js

@@ -1,6 +1,6 @@
-const escape = require('../escape')
+import escape from '../escape.js'
 
-module.exports = (options, url) => {
+export default (options, url) => {
   const rId = options.rIdForHREF(url)
   return `<w:hyperlink r:id="${rId}"><w:r><w:rPr><w:color w:val="0000EE"/><w:u w:val="single"/></w:rPr><w:t>${escape(url)}</w:t></w:r></w:hyperlink>`
 }

package/templates/paragraph.js

@@ -1,8 +1,7 @@
-const has = require('has')
-const hyperlink = require('./hyperlink')
-const numberToWords = require('number-to-words-en')
-const run = require('./run')
-const tag = require('./tag')
+import hyperlink from './hyperlink.js'
+import numberToWords from 'number-to-words-en'
+import run from './run.js'
+import tag from './tag.js'
 
 // Half an inch in twentieths of a point
 const HALF_INCH = 720
@@ -46,20 +45,20 @@ function properties (o, number, indentMargins) {
 
 const TAB = '<w:r><w:tab/></w:r>'
 
-module.exports = (element, options) => {
-  if (!has(element, 'alignment')) {
+export default (element, options) => {
+  if (!Object.hasOwn(element, 'alignment')) {
     element.alignment = options.styles.alignment || 'justify'
   }
-  const number = has(element, 'numbering')
+  const number = Object.hasOwn(element, 'numbering')
     ? options.numberStyle(element.numbering, true)
     : ''
-  const conspicuous = has(element, 'conspicuous')
-  const hasComponent = has(element, 'component')
-  const hasContent = has(element, 'content')
+  const conspicuous = Object.hasOwn(element, 'conspicuous')
+  const hasComponent = Object.hasOwn(element, 'component')
+  const hasContent = Object.hasOwn(element, 'content')
   let returned = '<w:p>'
   returned += properties(element, number, options.indentMargins)
   returned += number ? makeRun(number, false) + TAB : ''
-  if (has(element, 'heading')) {
+  if (Object.hasOwn(element, 'heading')) {
     returned += makeRun({ caption: element.heading }, conspicuous)
     if (!/\.$/.test(element.heading)) {
       returned += makeRun('.', false)
@@ -100,7 +99,7 @@ module.exports = (element, options) => {
   return returned
 
   function childContent (element) {
-    const conspicuous = has(element, 'conspicuous')
+    const conspicuous = Object.hasOwn(element, 'conspicuous')
     return element.content
       .map(element => makeRun(element, conspicuous, options))
       .join('')

package/templates/run.js

@@ -1,7 +1,6 @@
-const escape = require('../escape')
-const has = require('has')
-const hyperlink = require('./hyperlink')
-const tag = require('./tag')
+import escape from '../escape.js'
+import hyperlink from './hyperlink.js'
+import tag from './tag.js'
 
 const defaults = {
   highlight: false,
@@ -10,7 +9,7 @@ const defaults = {
   underline: false
 }
 
-module.exports = function run (element, conspicuous, options) {
+export default function run (element, conspicuous, options) {
   const { styles } = options
   const properties = Object.assign({}, defaults)
   if (conspicuous === true) {
@@ -21,16 +20,16 @@ module.exports = function run (element, conspicuous, options) {
   if (typeof element === 'string') {
     Object.assign(properties, styles.text)
     text = element
-  } else if (has(element, 'caption')) {
+  } else if (Object.hasOwn(element, 'caption')) {
     Object.assign(properties, styles.heading)
     text = element.caption
-  } else if (has(element, 'title')) {
+  } else if (Object.hasOwn(element, 'title')) {
     Object.assign(properties, styles.title)
     text = element.title
-  } else if (has(element, 'monospaced')) {
+  } else if (Object.hasOwn(element, 'monospaced')) {
     Object.assign(properties, styles.monospaced)
     text = element.monospaced
-  } else if (has(element, 'definition')) {
+  } else if (Object.hasOwn(element, 'definition')) {
     const term = element.definition
     return (
       (
@@ -45,7 +44,7 @@ module.exports = function run (element, conspicuous, options) {
           : ''
       )
     )
-  } else if (has(element, 'blank')) {
+  } else if (Object.hasOwn(element, 'blank')) {
     Object.assign(properties, styles.text)
     if (element.blank !== undefined) {
       text = element.blank
@@ -55,15 +54,15 @@ module.exports = function run (element, conspicuous, options) {
       text = options.blanks.text
       if (options.blanks.highlight) Object.assign(properties, styles.highlighted)
     }
-  } else if (has(element, 'use')) {
+  } else if (Object.hasOwn(element, 'use')) {
     Object.assign(properties, styles.use)
     text = element.use
-  } else if (has(element, 'heading')) {
+  } else if (Object.hasOwn(element, 'heading')) {
     const numbering = element.numbering
     const heading = element.heading
     if (
-      has(element, 'broken') ||
-      has(element, 'ambiguous')
+      Object.hasOwn(element, 'broken') ||
+      Object.hasOwn(element, 'ambiguous')
     ) {
       Object.assign(properties, styles.broken)
       text = '[Broken Cross-Reference to "' + heading + '"]'
@@ -84,7 +83,7 @@ module.exports = function run (element, conspicuous, options) {
         )
       )
     }
-  } else if (has(element, 'link')) {
+  } else if (Object.hasOwn(element, 'link')) {
     return hyperlink(options, element.link)
   } else {
     throw new Error('Invalid type: ' + JSON.stringify(element, null, 2))

package/templates/tag.js

@@ -1,3 +1,3 @@
-module.exports = (name, content) => {
+export default (name, content) => {
   return `<${name}>${content}</${name}>`
 }

package/templates/title.js

@@ -1,6 +1,6 @@
-const paragraph = require('./paragraph')
+import paragraph from './paragraph.js'
 
-module.exports = (string, options) => {
+export default (string, options) => {
   const argument = {
     title: true,
     alignment: 'center',