UNPKG

open-agreements

Version:

Open-source legal template filling CLI and library

318 lines • 12.3 kB
/** * Post-build structural validation of a generated package — the * "no recovery dialog" gate. Each check targets a concrete repair trigger in * reading applications: missing content types, dangling relationship targets, * unresolvable r:id references, malformed section properties, and unbalanced * field characters. * * `auditSectPr` is reused as one component: it flags duplicated or misplaced * body-level sectPr and dangling header/footer references, but tolerates the * zero-sectPr case (legal for parsed third-party documents), so the * required-final-sectPr check lives here. */ import { auditSectPr } from '../primitives/sectPrAudit.js'; import { NODE_TYPE } from '../primitives/dom-helpers.js'; import { OOXML } from '../primitives/namespaces.js'; import { parseXml } from '../primitives/xml.js'; import { DocxZip } from '../primitives/zip.js'; /** Run every structural check against a generated package buffer. */ export async function checkGeneratedPackage(buffer) { const zip = await DocxZip.load(buffer); const files = zip.listFiles().filter((name) => !name.endsWith('/')); const contents = new Map(); for (const name of files) { contents.set(name, await zip.readText(name)); } const issues = [ ...checkXmlDeclarations(contents), ...checkContentTypeCoverage(contents), ...checkRelationshipTargets(contents), ...checkRidResolution(contents), ...checkSectPr(contents), ...checkFieldPairing(contents), ...checkTables(contents), ]; return { ok: issues.length === 0, issues }; } function isXmlPart(name) { return name.endsWith('.xml') || name.endsWith('.rels'); } function checkXmlDeclarations(contents) { const issues = []; for (const [name, text] of contents) { if (!isXmlPart(name)) continue; if (!text.startsWith('<?xml')) { issues.push({ check: 'xml_declaration', part: name, message: 'XML part does not begin with an <?xml declaration', }); } } return issues; } function checkContentTypeCoverage(contents) { const issues = []; const contentTypes = contents.get('[Content_Types].xml'); if (!contentTypes) { return [{ check: 'content_type_coverage', part: '[Content_Types].xml', message: 'Part is missing' }]; } const doc = parseXml(contentTypes); const defaults = new Set(); const overrides = new Set(); for (const el of Array.from(doc.getElementsByTagName('Default'))) { const ext = el.getAttribute('Extension'); if (ext) defaults.add(ext.toLowerCase()); } for (const el of Array.from(doc.getElementsByTagName('Override'))) { const part = el.getAttribute('PartName'); if (part) overrides.add(part); } for (const name of contents.keys()) { if (name === '[Content_Types].xml') continue; const extension = name.split('.').pop()?.toLowerCase() ?? ''; if (!overrides.has(`/${name}`) && !defaults.has(extension)) { issues.push({ check: 'content_type_coverage', part: name, message: 'Part is covered by neither a content-type Default nor an Override', }); } } return issues; } /** Directory ('word/' or '') whose relationships a .rels part declares. */ function relsOwnerDir(relsName) { const marker = '_rels/'; const idx = relsName.lastIndexOf(marker); return idx <= 0 ? '' : relsName.slice(0, idx); } function resolveTarget(ownerDir, target) { const joined = target.startsWith('/') ? target.slice(1) : ownerDir + target; const segments = []; for (const segment of joined.split('/')) { if (segment === '' || segment === '.') continue; if (segment === '..') segments.pop(); else segments.push(segment); } return segments.join('/'); } function checkRelationshipTargets(contents) { const issues = []; for (const [name, text] of contents) { if (!name.endsWith('.rels')) continue; const ownerDir = relsOwnerDir(name); const doc = parseXml(text); for (const rel of Array.from(doc.getElementsByTagName('Relationship'))) { if (rel.getAttribute('TargetMode') === 'External') continue; const target = rel.getAttribute('Target'); if (!target) { issues.push({ check: 'relationship_target', part: name, message: 'Relationship without Target' }); continue; } const resolved = resolveTarget(ownerDir, target); if (!contents.has(resolved)) { issues.push({ check: 'relationship_target', part: name, message: `Relationship target '${target}' resolves to missing part '${resolved}'`, }); } } } return issues; } function relsIdsFor(contents, partName) { const dir = partName.includes('/') ? partName.slice(0, partName.lastIndexOf('/') + 1) : ''; const base = partName.slice(dir.length); const relsName = `${dir}_rels/${base}.rels`; const ids = new Set(); const text = contents.get(relsName); if (!text) return ids; const doc = parseXml(text); for (const rel of Array.from(doc.getElementsByTagName('Relationship'))) { const id = rel.getAttribute('Id'); if (id) ids.add(id); } return ids; } function checkRidResolution(contents) { const issues = []; for (const [name, text] of contents) { if (!name.startsWith('word/') || !name.endsWith('.xml')) continue; const ids = relsIdsFor(contents, name); const doc = parseXml(text); const visit = (el) => { for (let i = 0; i < el.attributes.length; i++) { const attr = el.attributes[i]; const isRid = attr.namespaceURI === OOXML.R_NS || attr.name === 'r:id' || attr.name === 'r:embed'; if (!isRid) continue; if (!ids.has(attr.value)) { issues.push({ check: 'rid_resolution', part: name, message: `<${el.tagName}> references relationship '${attr.value}' missing from this part's rels`, }); } } for (let i = 0; i < el.childNodes.length; i++) { const child = el.childNodes[i]; if (child.nodeType === NODE_TYPE.ELEMENT) visit(child); } }; if (doc.documentElement) visit(doc.documentElement); } return issues; } /** * Generated documents must bind their final section explicitly: exactly one * body-level w:sectPr, positioned last. auditSectPr supplies the placement * and reference checks but allows the zero-sectPr case, hence the count * assertion here. * * @conformance ECMA-376 edition 5, Part 1 § 17.6.17 */ function checkSectPr(contents) { const issues = []; const documentXml = contents.get('word/document.xml'); if (!documentXml) { return [{ check: 'sectpr', part: 'word/document.xml', message: 'Part is missing' }]; } const audit = auditSectPr(documentXml, contents.get('word/_rels/document.xml.rels') ?? null); for (const issue of audit.issues) { issues.push({ check: 'sectpr', part: 'word/document.xml', message: `${issue.type}: ${issue.message}` }); } if (audit.stats.bodyLevelSectPrCount !== 1) { issues.push({ check: 'sectpr', part: 'word/document.xml', message: `Expected exactly one body-level w:sectPr, found ${audit.stats.bodyLevelSectPrCount}`, }); } return issues; } function isStoryPart(name) { return (name === 'word/document.xml' || /^word\/header\d+\.xml$/.test(name) || /^word\/footer\d+\.xml$/.test(name) || name === 'word/footnotes.xml' || name === 'word/endnotes.xml' || name === 'word/comments.xml'); } function checkFieldPairing(contents) { const issues = []; for (const [name, text] of contents) { if (!isStoryPart(name)) continue; const doc = parseXml(text); // Document-order walk over field-relevant leaves; fldChar transitions // drive a begin → separate → end state machine per story part. let state = 'idle'; const visit = (el) => { if (el.tagName === 'w:fldChar') { const type = el.getAttribute('w:fldCharType'); if (type === 'begin') { if (state !== 'idle') { issues.push({ check: 'field_pairing', part: name, message: 'fldChar begin while a field is already open' }); } state = 'instr'; } else if (type === 'separate') { if (state !== 'instr') { issues.push({ check: 'field_pairing', part: name, message: 'fldChar separate without a matching begin' }); } state = 'result'; } else if (type === 'end') { if (state === 'idle') { issues.push({ check: 'field_pairing', part: name, message: 'fldChar end without a matching begin' }); } state = 'idle'; } } else if (el.tagName === 'w:instrText') { if (state !== 'instr') { issues.push({ check: 'field_pairing', part: name, message: 'w:instrText outside a begin→separate range', }); } } for (let i = 0; i < el.childNodes.length; i++) { const child = el.childNodes[i]; if (child.nodeType === NODE_TYPE.ELEMENT) visit(child); } }; if (doc.documentElement) visit(doc.documentElement); if (state !== 'idle') { issues.push({ check: 'field_pairing', part: name, message: 'Unclosed field at end of story part' }); } } return issues; } /** * Table invariants readers actually enforce: every cell ends with a w:p, * and the document body never ends with a table (the element preceding the * body-level sectPr, or the last body child, must not be w:tbl). * * @conformance ECMA-376 edition 5, Part 1 § 17.4.65 */ function checkTables(contents) { const issues = []; for (const [name, text] of contents) { if (!isStoryPart(name)) continue; const doc = parseXml(text); for (const tc of Array.from(doc.getElementsByTagName('w:tc'))) { let last = null; for (let child = tc.firstChild; child; child = child.nextSibling) { if (child.nodeType === NODE_TYPE.ELEMENT) last = child; } if (!last || last.tagName !== 'w:p') { issues.push({ check: 'table', part: name, message: `Table cell ends with <${last?.tagName ?? 'nothing'}> instead of a w:p`, }); } } if (name !== 'word/document.xml') continue; const body = doc.getElementsByTagName('w:body').item(0); if (!body) continue; let lastContent = null; for (let child = body.firstChild; child; child = child.nextSibling) { if (child.nodeType !== NODE_TYPE.ELEMENT) continue; const el = child; if (el.tagName === 'w:sectPr') continue; lastContent = el; } if (lastContent && lastContent.tagName === 'w:tbl') { issues.push({ check: 'table', part: name, message: 'Document body ends with a w:tbl' }); } } return issues; } //# sourceMappingURL=structural-checks.js.map