open-agreements
Version:
Open-source legal template filling CLI and library
165 lines • 5.58 kB
JavaScript
import { parseXml } from './xml.js';
import { childElements } from './dom-helpers.js';
import { OOXML } from './namespaces.js';
function elementSiblingIndex(node) {
const parent = node.parentNode;
if (!parent)
return 1;
let idx = 0;
for (const sibling of childElements(parent)) {
if (sibling.tagName === node.tagName) {
idx++;
}
if (sibling === node) {
return idx;
}
}
return idx || 1;
}
function nodePath(node) {
const parts = [];
let current = node;
while (current) {
parts.push(`${current.tagName}[${elementSiblingIndex(current)}]`);
const parentNode = current.parentNode;
if (!parentNode || parentNode.nodeType !== 1) {
break;
}
current = parentNode;
}
return parts.reverse().join('/');
}
function collectRelationshipIds(documentRelsXml) {
if (!documentRelsXml) {
return new Set();
}
try {
const relDoc = parseXml(documentRelsXml);
const ids = new Set();
const relationships = relDoc.getElementsByTagName('Relationship');
for (let i = 0; i < relationships.length; i++) {
const rel = relationships.item(i);
const id = rel?.getAttribute('Id');
if (id) {
ids.add(id);
}
}
return ids;
}
catch {
return new Set();
}
}
function getRid(ref) {
return (ref.getAttribute('r:id') ??
ref.getAttributeNS(OOXML.R_NS, 'id') ??
ref.getAttribute('id') ??
undefined);
}
export function auditSectPr(documentXml, documentRelsXml) {
const issues = [];
const relIds = collectRelationshipIds(documentRelsXml);
const doc = parseXml(documentXml);
const body = doc.getElementsByTagName('w:body').item(0);
if (!body) {
return {
ok: false,
issues: [
{
type: 'missing_body',
path: 'w:document',
message: 'Missing w:body element',
},
],
stats: {
bodyLevelSectPrCount: 0,
paragraphLevelSectPrCount: 0,
totalSectPrCount: 0,
referenceCount: 0,
},
};
}
const bodyChildren = childElements(body);
const bodyLevelSectPrNodes = bodyChildren.filter((child) => child.tagName === 'w:sectPr');
if (bodyLevelSectPrNodes.length > 1) {
for (const sectPr of bodyLevelSectPrNodes) {
issues.push({
type: 'multiple_body_level_sectpr',
path: nodePath(sectPr),
message: 'Multiple body-level w:sectPr elements found; expected at most one final w:sectPr',
});
}
}
if (bodyLevelSectPrNodes.length > 0) {
const lastChild = bodyChildren[bodyChildren.length - 1];
for (const sectPr of bodyLevelSectPrNodes) {
if (sectPr !== lastChild) {
issues.push({
type: 'body_level_sectpr_not_last',
path: nodePath(sectPr),
message: 'Body-level w:sectPr is not the final direct child of w:body',
});
}
}
}
const sectPrNodes = Array.from(doc.getElementsByTagName('w:sectPr'));
let paragraphLevelSectPrCount = 0;
let referenceCount = 0;
for (const sectPr of sectPrNodes) {
const parent = sectPr.parentNode;
const parentTag = parent && parent.nodeType === 1 ? parent.tagName : '';
if (parentTag === 'w:pPr') {
paragraphLevelSectPrCount++;
const grand = parent.parentNode;
const grandTag = grand && grand.nodeType === 1 ? grand.tagName : '';
if (grandTag !== 'w:p') {
issues.push({
type: 'sectpr_in_ppr_without_paragraph_parent',
path: nodePath(sectPr),
message: 'w:sectPr in w:pPr does not have w:p as parent',
});
}
}
else if (parentTag !== 'w:body') {
issues.push({
type: 'sectpr_invalid_parent',
path: nodePath(sectPr),
message: `w:sectPr has invalid parent '${parentTag || '(none)'}'`,
});
}
for (const child of childElements(sectPr)) {
if (child.tagName !== 'w:headerReference' && child.tagName !== 'w:footerReference') {
continue;
}
referenceCount++;
const rid = getRid(child);
if (!rid) {
issues.push({
type: 'sectpr_reference_missing_rid',
path: nodePath(child),
message: `${child.tagName} is missing r:id`,
});
continue;
}
if (relIds.size > 0 && !relIds.has(rid)) {
issues.push({
type: 'sectpr_reference_dangling_rid',
path: nodePath(child),
message: `${child.tagName} references missing relationship id '${rid}'`,
rid,
});
}
}
}
return {
ok: issues.length === 0,
issues,
stats: {
bodyLevelSectPrCount: bodyLevelSectPrNodes.length,
paragraphLevelSectPrCount,
totalSectPrCount: sectPrNodes.length,
referenceCount,
},
};
}
//# sourceMappingURL=sectPrAudit.js.map