UNPKG

open-agreements

Version:

Open-source legal template filling CLI and library

138 lines • 6.6 kB
import { existsSync, readFileSync, mkdtempSync, rmSync } from 'node:fs'; import { join } from 'node:path'; import { tmpdir } from 'node:os'; import { createHash } from 'node:crypto'; import { validateExternalMetadata, loadExternalMetadata, CleanConfigSchema } from '../metadata.js'; import { bindAnchoredParagraphFields, loadAnchoredParagraphBindingsConfig } from '../field-selector/anchored-paragraph-bindings.js'; import { parseReplacementKey } from '../field-selector/replacement-keys.js'; /** Pattern for valid template tags within replacement values */ const TAG_RE = /\{[a-z_][a-z0-9_]*\}/g; /** Pattern for any curly-brace token */ const ANY_BRACE_RE = /\{[^}]+\}/g; /** Only simple identifiers inside braces are allowed */ const SAFE_TAG_RE = /^\{[a-z_][a-z0-9_]*\}$/; /** * Validate an external template directory: * - metadata.yaml validates against ExternalMetadataSchema * - template.docx exists and SHA-256 matches source_sha256 * - replacements.json is present and valid * - clean.json is valid if present * - Replacement targets reference metadata fields */ export function validateExternal(externalDir, externalId) { const errors = []; const warnings = []; // Validate metadata const metaResult = validateExternalMetadata(externalDir); if (!metaResult.valid) { errors.push(...metaResult.errors.map((e) => `metadata: ${e}`)); return { externalId, valid: false, errors, warnings }; } const metadata = loadExternalMetadata(externalDir); // Validate template.docx exists const docxPath = join(externalDir, 'template.docx'); if (!existsSync(docxPath)) { errors.push('template.docx not found'); return { externalId, valid: false, errors, warnings }; } // SHA-256 integrity check const docxBuf = readFileSync(docxPath); const actualHash = createHash('sha256').update(docxBuf).digest('hex'); if (actualHash !== metadata.source_sha256) { errors.push(`DOCX integrity check failed:\n` + ` Expected SHA-256: ${metadata.source_sha256}\n` + ` Actual SHA-256: ${actualHash}`); } // Validate replacements.json const replacementsPath = join(externalDir, 'replacements.json'); if (!existsSync(replacementsPath)) { errors.push('replacements.json not found (required for external templates)'); } else { try { const raw = readFileSync(replacementsPath, 'utf-8'); const replacements = JSON.parse(raw); if (typeof replacements !== 'object' || replacements === null) { errors.push('replacements.json must be a JSON object'); } else { const metadataFieldNames = new Set(metadata.fields.map((f) => f.name)); for (const [key, value] of Object.entries(replacements)) { if (typeof value !== 'string') { errors.push(`replacements.json: value for "${key}" must be a string`); continue; } const tags = value.match(TAG_RE); if (!tags || tags.length === 0) { errors.push(`replacements.json: value for "${key}" must contain at least one {identifier} tag, got "${value}"`); } const allBraces = value.match(ANY_BRACE_RE); if (allBraces) { for (const token of allBraces) { if (!SAFE_TAG_RE.test(token)) { errors.push(`replacements.json: unsafe tag "${token}" in value for "${key}". Only {identifier} tags allowed.`); } } } // For qualified keys, check against the searchText, not the full key. const parsed = parseReplacementKey(key, value); if (parsed.type === 'simple' && value.includes(parsed.searchText)) { errors.push(`replacements.json: value for "${key}" contains the key itself (would cause infinite loop)`); } else if (parsed.type === 'context' && value.includes(parsed.searchText)) { errors.push(`replacements.json: value for "${key}" contains the search text "${parsed.searchText}" (would cause infinite loop)`); } // Check field coverage if (tags) { for (const tag of tags) { const fieldName = tag.slice(1, -1); if (!metadataFieldNames.has(fieldName)) { warnings.push(`Replacement target {${fieldName}} not found in metadata fields`); } } } } } } catch (err) { errors.push(`replacements.json: ${err.message}`); } } const bindingsPath = join(externalDir, 'anchored-paragraph-bindings.json'); if (existsSync(bindingsPath)) { try { const bindings = loadAnchoredParagraphBindingsConfig(bindingsPath); const fields = new Set(metadata.fields.map((field) => field.name)); for (const group of bindings.groups) { for (const binding of group.bindings) { if (!fields.has(binding.field)) errors.push(`Anchored binding {${binding.field}} not found in metadata fields`); } } // Verify real anchor/label uniqueness without modifying the canonical file. const scratch = mkdtempSync(join(tmpdir(), 'oa-external-bindings-validate-')); try { bindAnchoredParagraphFields(docxPath, join(scratch, 'bound.docx'), bindings); } finally { rmSync(scratch, { recursive: true, force: true }); } } catch (error) { errors.push(`anchored-paragraph-bindings.json: ${error.message}`); } } // Validate clean.json if present const cleanPath = join(externalDir, 'clean.json'); if (existsSync(cleanPath)) { try { const raw = readFileSync(cleanPath, 'utf-8'); CleanConfigSchema.parse(JSON.parse(raw)); } catch { errors.push('clean.json: invalid format'); } } return { externalId, valid: errors.length === 0, errors, warnings }; } //# sourceMappingURL=external.js.map