UNPKG

open-agreements

Version:

Open-source legal template filling CLI and library

273 lines • 10.9 kB
/** * Post-fill formatter for closing-checklist DOCX files. * * After docx-templates fills the template, every row looks identical. * This formatter opens the DOCX, finds the Documents table, classifies * each row (stage heading, main entry, citation, signatory, action, issue), * and applies semantic XML formatting: bold, italic, color, indentation. */ import AdmZip from 'adm-zip'; import { DOMParser, XMLSerializer } from '@xmldom/xmldom'; import { rezipWithoutDirEntries } from '../field-selector/ooxml-parts.js'; import { classifyRow, getDirectChildRows, getDirectChildCells, getCellText, findTableByHeaders, DOCUMENTS_HEADERS, RENDER_VERSION_MARKER, } from './docx-table-helpers.js'; const W_NS = 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'; // --------------------------------------------------------------------------- // XML helpers (same patterns as field-selector/patcher.ts) // --------------------------------------------------------------------------- function ensureRunProperties(run) { const doc = run.ownerDocument; const children = run.childNodes; for (let i = 0; i < children.length; i++) { const child = children[i]; if (child.localName === 'rPr' && child.namespaceURI === W_NS) { return child; } } const rPr = doc.createElementNS(W_NS, 'w:rPr'); run.insertBefore(rPr, run.firstChild); return rPr; } function setRunBold(run) { const rPr = ensureRunProperties(run); // Check if <w:b/> already exists const children = rPr.childNodes; for (let i = 0; i < children.length; i++) { const child = children[i]; if (child.localName === 'b' && child.namespaceURI === W_NS) return; } const doc = run.ownerDocument; const b = doc.createElementNS(W_NS, 'w:b'); rPr.appendChild(b); } function setRunItalic(run) { const rPr = ensureRunProperties(run); const children = rPr.childNodes; for (let i = 0; i < children.length; i++) { const child = children[i]; if (child.localName === 'i' && child.namespaceURI === W_NS) return; } const doc = run.ownerDocument; const iEl = doc.createElementNS(W_NS, 'w:i'); rPr.appendChild(iEl); } function setRunColor(run, colorHex) { const rPr = ensureRunProperties(run); const doc = run.ownerDocument; const children = rPr.childNodes; for (let i = 0; i < children.length; i++) { const child = children[i]; if (child.localName === 'color' && child.namespaceURI === W_NS) { child.setAttributeNS(W_NS, 'w:val', colorHex); return; } } const color = doc.createElementNS(W_NS, 'w:color'); color.setAttributeNS(W_NS, 'w:val', colorHex); rPr.appendChild(color); } function ensureParagraphProperties(para) { const doc = para.ownerDocument; const children = para.childNodes; for (let i = 0; i < children.length; i++) { const child = children[i]; if (child.localName === 'pPr' && child.namespaceURI === W_NS) { return child; } } const pPr = doc.createElementNS(W_NS, 'w:pPr'); para.insertBefore(pPr, para.firstChild); return pPr; } function setParagraphIndent(para, leftDxa) { const pPr = ensureParagraphProperties(para); const doc = para.ownerDocument; // Find or create <w:ind> const children = pPr.childNodes; for (let i = 0; i < children.length; i++) { const child = children[i]; if (child.localName === 'ind' && child.namespaceURI === W_NS) { child.setAttributeNS(W_NS, 'w:left', String(leftDxa)); return; } } const ind = doc.createElementNS(W_NS, 'w:ind'); ind.setAttributeNS(W_NS, 'w:left', String(leftDxa)); pPr.appendChild(ind); } // --------------------------------------------------------------------------- // NBSP indent handling // --------------------------------------------------------------------------- const NBSP = '\u00A0'; const DXA_PER_LEVEL = 360; /** * Count leading NBSP pairs in all text nodes of a table cell, * strip them from the text content, and return the indent level. */ function countAndStripNbspIndent(tc) { const paragraphs = tc.getElementsByTagNameNS(W_NS, 'p'); let maxLevel = 0; for (let p = 0; p < paragraphs.length; p++) { const runs = paragraphs[p].getElementsByTagNameNS(W_NS, 'r'); if (runs.length === 0) continue; // Collect full text to count leading NBSPs let fullText = ''; for (let r = 0; r < runs.length; r++) { const tEls = runs[r].getElementsByTagNameNS(W_NS, 't'); for (let t = 0; t < tEls.length; t++) { fullText += tEls[t].textContent ?? ''; } } // Count leading NBSP pairs let nbspCount = 0; for (let i = 0; i < fullText.length; i++) { if (fullText[i] === NBSP) { nbspCount++; } else { break; } } const level = Math.floor(nbspCount / 2); if (level > maxLevel) maxLevel = level; if (nbspCount > 0) { // Strip leading NBSPs from text runs let remaining = nbspCount; for (let r = 0; r < runs.length && remaining > 0; r++) { const tEls = runs[r].getElementsByTagNameNS(W_NS, 't'); for (let t = 0; t < tEls.length && remaining > 0; t++) { const text = tEls[t].textContent ?? ''; let stripCount = 0; for (let c = 0; c < text.length && remaining > 0; c++) { if (text[c] === NBSP) { stripCount++; remaining--; } else { break; } } if (stripCount > 0) { const newText = text.slice(stripCount); tEls[t].textContent = newText; if (newText.startsWith(' ') || newText.endsWith(' ') || newText === '') { tEls[t].setAttribute('xml:space', 'preserve'); } } } } // Set paragraph indent if (level > 0) { setParagraphIndent(paragraphs[p], level * DXA_PER_LEVEL); } } } return maxLevel; } // --------------------------------------------------------------------------- // Apply formatting to all runs in a cell // --------------------------------------------------------------------------- function getAllRunsInCell(tc) { const runs = []; const rNodes = tc.getElementsByTagNameNS(W_NS, 'r'); for (let i = 0; i < rNodes.length; i++) { runs.push(rNodes[i]); } return runs; } function formatCellRuns(tc, format) { const runs = getAllRunsInCell(tc); for (const run of runs) { if (format.bold) setRunBold(run); if (format.italic) setRunItalic(run); if (format.color) setRunColor(run, format.color); } } // --------------------------------------------------------------------------- // Main formatter // --------------------------------------------------------------------------- export async function formatChecklistDocx(docxPath) { const zip = new AdmZip(docxPath); const entry = zip.getEntry('word/document.xml'); if (!entry) return; const xmlStr = entry.getData().toString('utf-8'); const xmlDoc = new DOMParser().parseFromString(xmlStr, 'text/xml'); const docsTable = findTableByHeaders(xmlDoc, DOCUMENTS_HEADERS); if (!docsTable) return; // 5-column layout: ID at 0, Title at 1 const idColIdx = 0; const titleColIdx = 1; const rows = getDirectChildRows(docsTable); // Skip header row (index 0) for (let r = 1; r < rows.length; r++) { const cells = getDirectChildCells(rows[r]); if (cells.length < titleColIdx + 1) continue; const idText = getCellText(cells[idColIdx]); const titleText = getCellText(cells[titleColIdx]); const rowType = classifyRow(idText, titleText); // Convert NBSP indentation to OOXML indent on title cell countAndStripNbspIndent(cells[titleColIdx]); const titleCell = cells[titleColIdx]; switch (rowType) { case 'stage_heading': formatCellRuns(titleCell, { italic: true, color: '8C8D8E' }); break; case 'main_entry': formatCellRuns(titleCell, { bold: true }); break; case 'citation': formatCellRuns(titleCell, { italic: true, color: '494A4B' }); break; case 'signatory': case 'action': case 'issue': // Normal formatting; checkboxes already in text break; case 'unknown': break; } } // Inject render version marker (hidden paragraph, 1pt white text) const body = xmlDoc.getElementsByTagNameNS(W_NS, 'body').item(0); if (body) { const markerP = xmlDoc.createElementNS(W_NS, 'w:p'); const markerR = xmlDoc.createElementNS(W_NS, 'w:r'); const markerRPr = xmlDoc.createElementNS(W_NS, 'w:rPr'); const markerSz = xmlDoc.createElementNS(W_NS, 'w:sz'); markerSz.setAttributeNS(W_NS, 'w:val', '2'); const markerColor = xmlDoc.createElementNS(W_NS, 'w:color'); markerColor.setAttributeNS(W_NS, 'w:val', 'FFFFFF'); markerRPr.appendChild(markerSz); markerRPr.appendChild(markerColor); markerR.appendChild(markerRPr); const markerT = xmlDoc.createElementNS(W_NS, 'w:t'); markerT.appendChild(xmlDoc.createTextNode(RENDER_VERSION_MARKER)); markerR.appendChild(markerT); markerP.appendChild(markerR); // Insert before sectPr if present, else append const sectPr = body.getElementsByTagNameNS(W_NS, 'sectPr').item(0); if (sectPr) { body.insertBefore(markerP, sectPr); } else { body.appendChild(markerP); } } // Serialize and write back const serializer = new XMLSerializer(); const updatedXml = serializer.serializeToString(xmlDoc); zip.updateFile('word/document.xml', Buffer.from(updatedXml, 'utf-8')); // Rebuild dropping any zip directory entries so the output is a valid flat OPC // package (Word rejects directory entries as unreadable content). See [OA-FIL-030]. rezipWithoutDirEntries(zip).writeZip(docxPath); } //# sourceMappingURL=format-checklist-docx.js.map