UNPKG

open-agreements

Version:

Open-source legal template filling CLI and library

165 lines • 9.6 kB
import AdmZip from 'adm-zip'; import { createHash } from 'node:crypto'; import { readFileSync } from 'node:fs'; import { DOMParser } from '@xmldom/xmldom'; import { NumberingContinuationsSchema } from '../metadata.js'; import { createParagraphNumberingResolver } from './paragraph-numbering.js'; const W = 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'; const plans = new WeakMap(); const anchorKey = (text) => text.replaceAll('[', '').replaceAll(']', '').replace(/\s+/g, ' ').trim().replace(/\.$/, ''); const text = (paragraph) => Array.from(paragraph.getElementsByTagNameNS(W, 't')).map(node => node.textContent).join(''); function elements(parent, local) { return Array.from(parent.childNodes).filter((node) => node.nodeType === 1 && node.namespaceURI === W && node.localName === local); } function one(parent, local) { const found = elements(parent, local); if (found.length !== 1) throw new Error(`numbering continuations: expected exactly one ${local}`); return found[0]; } function numbers(numbering) { if (!numbering.documentElement) throw new Error('numbering continuations: missing numbering root'); const result = new Map(); for (const num of elements(numbering.documentElement, 'num')) { const id = num.getAttributeNS(W, 'numId') ?? ''; if (result.has(id)) throw new Error('numbering continuations: duplicate numbering instance'); result.set(id, num); } return result; } // Namespace-aware structural comparison ignores XML serialization details, not // numbering or formatting properties. These fingerprints never leave the plan. function structure(element) { return [element.namespaceURI, element.localName, Array.from(element.attributes).filter(a => a.namespaceURI !== 'http://www.w3.org/2000/xmlns/') .map(a => [a.namespaceURI, a.localName, a.value]).sort((a, b) => JSON.stringify(a).localeCompare(JSON.stringify(b))), Array.from(element.childNodes).filter((n) => n.nodeType === 1).map(structure)]; } function compatibleLevel(level) { const clone = level.cloneNode(true); for (const child of [...elements(clone, 'start'), ...elements(clone, 'pStyle')]) clone.removeChild(child); // Missing font hint and an otherwise empty explicit default hint both select // the default script classification. Never discard font names/theme choices. for (const props of elements(clone, 'rPr')) { for (const fonts of elements(props, 'rFonts')) { const attrs = Array.from(fonts.attributes).filter(a => a.namespaceURI !== 'http://www.w3.org/2000/xmlns/'); if (attrs.length === 1 && attrs[0].namespaceURI === W && attrs[0].localName === 'hint' && attrs[0].value === 'default') props.removeChild(fonts); } } return JSON.stringify(structure(clone)); } function checkShape(numbering, config) { const nums = numbers(numbering); const source = nums.get(config.source_num_id); if (!source) throw new Error('numbering continuations: missing source instance'); const abstractId = one(source, 'abstractNumId').getAttributeNS(W, 'val'); const abstracts = Array.from(numbering.getElementsByTagNameNS(W, 'abstractNum')).filter(node => node.getAttributeNS(W, 'abstractNumId') === abstractId); if (abstracts.length !== 1 || elements(abstracts[0], 'numStyleLink').length || elements(abstracts[0], 'styleLink').length) { throw new Error('numbering continuations: missing, ambiguous or style-linked source abstract'); } if (elements(source, 'lvlOverride').length) throw new Error('numbering continuations: source overrides are unsupported'); const pinned = [structure(source), structure(abstracts[0])]; for (const heading of config.headings) { const num = nums.get(heading.num_id); if (!num || one(num, 'abstractNumId').getAttributeNS(W, 'val') !== heading.expected_abstract_num_id) { throw new Error(`numbering continuations: abstract ID drifted for ${heading.num_id}`); } const targets = Array.from(numbering.getElementsByTagNameNS(W, 'abstractNum')).filter(node => node.getAttributeNS(W, 'abstractNumId') === heading.expected_abstract_num_id); if (targets.length !== 1 || elements(targets[0], 'numStyleLink').length || elements(targets[0], 'styleLink').length) throw new Error('numbering continuations: missing, ambiguous or style-linked target abstract'); if (heading.expected_abstract_num_id !== abstractId) { for (let index = 0; index <= heading.ilvl; index += 1) { const level = (abstract) => elements(abstract, 'lvl').filter(l => l.getAttributeNS(W, 'ilvl') === String(index)); const from = level(targets[0]), to = level(abstracts[0]); if (from.length !== 1 || to.length !== 1 || compatibleLevel(from[0]) !== compatibleLevel(to[0])) { throw new Error(`numbering continuations: incompatible formatting or counter semantics at level ${index}`); } } } pinned.push(structure(num), structure(targets[0])); const starts = {}; for (const child of Array.from(num.childNodes).filter((node) => node.nodeType === 1)) { if (child.namespaceURI !== W || !['abstractNumId', 'lvlOverride'].includes(child.localName ?? '')) { throw new Error('numbering continuations: unsupported instance properties'); } if (child.localName !== 'lvlOverride') continue; const index = child.getAttributeNS(W, 'ilvl') ?? ''; const start = one(child, 'startOverride'); const elementChildren = Array.from(child.childNodes).filter(node => node.nodeType === 1); const raw = start.getAttributeNS(W, 'val') ?? ''; if (elementChildren.length !== 1 || !/^[0-8]$/.test(index) || !/^\d+$/.test(raw) || starts[index] !== undefined) { throw new Error('numbering continuations: expected startOverride-only shape'); } starts[index] = Number(raw); } const keys = Object.keys(starts).sort(); if (keys.join(',') !== Object.keys(heading.expected_starts).sort().join(',') || keys.some(key => starts[key] !== heading.expected_starts[key])) { throw new Error(`numbering continuations: start overrides drifted for ${heading.num_id}`); } } return createHash('sha256').update(JSON.stringify(pinned)).digest('hex'); } function declaredParagraphs(document, styles, config, source) { const resolve = createParagraphNumberingResolver(styles); const paragraphs = Array.from(document.getElementsByTagNameNS(W, 'p')); const result = new Set(); for (const heading of config.headings) { const anchored = paragraphs.filter(paragraph => anchorKey(text(paragraph)) === anchorKey(heading.anchor)); const owned = paragraphs.filter(paragraph => resolve(paragraph)?.numId === heading.num_id); // Selection may remove a validated source heading. It may not leave a // mismatched or multiply-used declared numbering instance behind. if (!source && anchored.length === 0 && owned.length === 0) continue; if (anchored.length !== 1 || owned.length !== 1 || anchored[0] !== owned[0]) { throw new Error(`numbering continuations: missing or ambiguous anchor/instance for ${heading.num_id}`); } const resolved = resolve(anchored[0]); if (resolved?.ilvl !== heading.ilvl || resolved.outlineLvl !== heading.ilvl) { throw new Error(`numbering continuations: heading level/outline drifted for ${heading.num_id}`); } result.add(anchored[0]); } return result; } /** Validate the original source, before selections/fill mutate its bytes. */ export function validateNumberingContinuationSource(sourcePath, input) { const config = NumberingContinuationsSchema.parse(input); const bytes = readFileSync(sourcePath); if (createHash('sha256').update(bytes).digest('hex') !== config.source_sha256) { throw new Error('numbering continuations: source SHA-256 mismatch'); } const zip = new AdmZip(bytes); const parser = new DOMParser({ onError: (level, message) => { if (level !== 'warning') throw new Error(message); } }); const part = (name) => { const entry = zip.getEntry(`word/${name}.xml`); if (!entry) throw new Error(`numbering continuations: missing ${name} part`); return parser.parseFromString(entry.getData().toString('utf8'), 'text/xml'); }; const numbering = part('numbering'); const fingerprint = checkShape(numbering, config); declaredParagraphs(part('document'), part('styles'), config, true); const plan = Object.freeze({ sourceNumId: config.source_num_id, sourceSha256: config.source_sha256 }); plans.set(plan, { config, fingerprint }); return plan; } export function resolveNumberingContinuationParagraphs(document, styles, numbering, plan) { const stored = plans.get(plan); if (!stored) throw new Error('numbering continuations: unvalidated source plan'); const { config, fingerprint } = stored; if (checkShape(numbering, config) !== fingerprint) throw new Error('numbering continuations: pinned instance/abstract fingerprint drifted'); return declaredParagraphs(document, styles, config, false); } //# sourceMappingURL=numbering-continuations.js.map