UNPKG

open-agreements

Version:

Open-source legal template filling CLI and library

143 lines • 5.61 kB
import { existsSync, writeFileSync } from 'node:fs'; import AdmZip from 'adm-zip'; import { enumerateTextParts, getGeneralTextPartNames } from '../core/field-selector/ooxml-parts.js'; import { findRenderedTextArtifacts } from '../core/field-selector/verifier.js'; /** * Collect bracket placeholder information from a DOCX file. * * This is the programmatic counterpart to the user-facing `scan` command and * can be reused by tests and validation tools. */ export function scanDocxBrackets(inputPath) { const zip = new AdmZip(inputPath); const parts = enumerateTextParts(zip); const partNames = getGeneralTextPartNames(parts); const bracketsByPart = new Map(); const allBrackets = []; for (const partName of partNames) { const text = extractPartText(zip, partName); const brackets = [...text.matchAll(/\[([^\]]+)\]/g)].map((m) => m[1]); if (brackets.length > 0) { bracketsByPart.set(partName, new Set(brackets)); allBrackets.push(...brackets); } } const unique = [...new Set(allBrackets)].sort(); const shortPlaceholders = []; const longClauses = []; for (const b of unique) { if (b.length <= 80) { shortPlaceholders.push(`[${b}]`); } else { longClauses.push(`[${b.slice(0, 60)}...]`); } } let underscoreBlankCount = 0; for (const partName of partNames) { const text = extractPartText(zip, partName); const blanks = text.match(/_{3,}/g) ?? []; underscoreBlankCount += blanks.length; } return { partNames, bracketsByPart, unique, shortPlaceholders, longClauses, footnoteCount: countFootnotes(zip), underscoreBlankCount, artifactFindings: findRenderedTextArtifacts(inputPath), }; } /** * Scan a DOCX file and report all bracketed placeholders. * Classifies them as short (fill-in fields) vs long (alternative clauses). * Optionally outputs a draft replacements.json. * * Scans all general OOXML text parts (document, headers, footers, endnotes). */ export function runScan(args) { if (!existsSync(args.input)) { console.error(`File not found: ${args.input}`); process.exit(1); } const scan = scanDocxBrackets(args.input); const { partNames, bracketsByPart, shortPlaceholders, longClauses, footnoteCount, underscoreBlankCount, artifactFindings, } = scan; console.log(`\n=== Scan of ${args.input} ===`); // Report parts scanned const nonDocParts = partNames.filter((p) => p !== 'word/document.xml'); if (nonDocParts.length > 0) { console.log(`Parts scanned: document.xml + ${nonDocParts.length} additional (${nonDocParts.join(', ')})`); } console.log(`\nShort placeholders (${shortPlaceholders.length}):`); for (const p of shortPlaceholders) { // Note which parts contain this placeholder (if outside document.xml) const inner = p.slice(1, -1); const locations = []; for (const [partName, brackets] of bracketsByPart) { if (partName !== 'word/document.xml' && brackets.has(inner)) { locations.push(partName.replace('word/', '')); } } const suffix = locations.length > 0 ? ` (also in: ${locations.join(', ')})` : ''; console.log(` ${p}${suffix}`); } console.log(`\nLong clauses/alternatives (${longClauses.length}) — skipped by field-selector:`); for (const c of longClauses) { console.log(` ${c}`); } // Footnote count console.log(`\nFootnotes: ${footnoteCount} explanatory footnote(s)`); console.log(`Underscore blanks: ${underscoreBlankCount} occurrence(s)`); console.log(`Rendered text artifacts: ${artifactFindings.length} finding(s)`); for (const finding of artifactFindings) console.log(` ${finding}`); // Output draft replacements.json if (args.outputReplacements) { const replacements = {}; for (const p of shortPlaceholders) { const inner = p.slice(1, -1); const tagName = inner .toLowerCase() .replace(/[^a-z0-9]+/g, '_') .replace(/^_|_$/g, ''); replacements[p] = `{${tagName}}`; } writeFileSync(args.outputReplacements, JSON.stringify(replacements, null, 2) + '\n'); console.log(`\nDraft replacements written to: ${args.outputReplacements}`); } console.log(''); } function extractPartText(zip, partName) { const entry = zip.getEntry(partName); if (!entry) return ''; const xml = entry.getData().toString('utf-8'); const paragraphs = []; const paraRegex = /<w:p[\s>][\s\S]*?<\/w:p>/g; let paraMatch; while ((paraMatch = paraRegex.exec(xml)) !== null) { const paraXml = paraMatch[0]; const textParts = []; const tRegex = /<w:t[^>]*>([^<]*)<\/w:t>/g; let tMatch; while ((tMatch = tRegex.exec(paraXml)) !== null) { textParts.push(tMatch[1]); } if (textParts.length > 0) { paragraphs.push(textParts.join('')); } } return paragraphs.join('\n'); } function countFootnotes(zip) { const entry = zip.getEntry('word/footnotes.xml'); if (!entry) return 0; const xml = entry.getData().toString('utf-8'); const all = xml.match(/<w:footnote\s/g) ?? []; const separators = xml.match(/w:type="(separator|continuationSeparator)"/g) ?? []; return all.length - separators.length; } //# sourceMappingURL=scan.js.map