UNPKG

open-agreements

Version:

Open-source legal template filling CLI and library

233 lines • 8.78 kB
import { existsSync, readFileSync, writeFileSync } from 'node:fs'; import { join } from 'node:path'; import { z } from 'zod'; const PrimitiveSchema = z.union([z.string(), z.boolean()]); const PrimitiveArraySchema = z.array(PrimitiveSchema).min(1); export const ComputedPredicateSchema = z.object({ field: z.string().min(1), op: z.enum(['eq', 'neq', 'in', 'truthy', 'falsy', 'defined']), value: z.union([PrimitiveSchema, PrimitiveArraySchema]).optional(), }).superRefine((predicate, ctx) => { if ((predicate.op === 'eq' || predicate.op === 'neq') && predicate.value === undefined) { ctx.addIssue({ code: z.ZodIssueCode.custom, path: ['value'], message: `Predicate op "${predicate.op}" requires a value`, }); } if (predicate.op === 'in') { if (!Array.isArray(predicate.value) || predicate.value.length === 0) { ctx.addIssue({ code: z.ZodIssueCode.custom, path: ['value'], message: 'Predicate op "in" requires a non-empty array value', }); } return; } if ((predicate.op === 'truthy' || predicate.op === 'falsy' || predicate.op === 'defined') && predicate.value !== undefined) { ctx.addIssue({ code: z.ZodIssueCode.custom, path: ['value'], message: `Predicate op "${predicate.op}" must not define a value`, }); } }); export const ComputedRuleSchema = z.object({ id: z.string().min(1), description: z.string().optional(), when_all: z.array(ComputedPredicateSchema).default([]), when_any: z.array(ComputedPredicateSchema).default([]), set_fill: z.record(z.string().min(1), PrimitiveSchema).default({}), set_audit: z.record(z.string().min(1), PrimitiveSchema).default({}), }).superRefine((rule, ctx) => { if (Object.keys(rule.set_fill).length === 0 && Object.keys(rule.set_audit).length === 0) { ctx.addIssue({ code: z.ZodIssueCode.custom, path: ['set_fill'], message: 'Each rule must define at least one assignment in set_fill or set_audit', }); } }); export const ComputedProfileSchema = z.object({ version: z.string().default('1.0'), max_passes: z.number().int().min(1).max(20).default(4), /** Unconditional defaults applied before any rules evaluate. */ defaults: z.record(z.string().min(1), PrimitiveSchema).default({}), rules: z.array(ComputedRuleSchema).min(1), }); function normalizeComparableValue(value) { if (typeof value !== 'string') { return value; } const normalized = value.trim(); if (normalized.toLowerCase() === 'true') return true; if (normalized.toLowerCase() === 'false') return false; return normalized; } function interpolate(value, state) { if (typeof value !== 'string') { return value; } if (!value.includes('${')) { return value; } return value.replace(/\$\{([A-Za-z0-9_]+)\}/g, (_match, fieldName) => { const fieldValue = state[fieldName]; return fieldValue === undefined ? '' : String(fieldValue); }); } function evaluatePredicate(predicate, state) { const actualRaw = state[predicate.field]; const actual = normalizeComparableValue(actualRaw); if (predicate.op === 'defined') { return actualRaw !== undefined && actualRaw !== null && actualRaw !== ''; } if (predicate.op === 'truthy') { return Boolean(actualRaw); } if (predicate.op === 'falsy') { return !actualRaw; } if (predicate.op === 'in') { const candidates = predicate.value.map((entry) => normalizeComparableValue(entry)); return candidates.some((entry) => entry === actual); } const expected = normalizeComparableValue(predicate.value); if (predicate.op === 'eq') { return actual === expected; } return actual !== expected; } function matchRule(rule, state) { const allPredicatesMatch = rule.when_all.length === 0 ? true : rule.when_all.every((predicate) => evaluatePredicate(predicate, state)); if (!allPredicatesMatch) { return false; } return rule.when_any.length === 0 ? true : rule.when_any.some((predicate) => evaluatePredicate(predicate, state)); } function computeDerivedValues(initialValues, finalValues) { const result = {}; for (const [field, value] of Object.entries(finalValues)) { if (!(field in initialValues) || initialValues[field] !== value) { result[field] = value; } } return result; } export function loadComputedProfile(fieldSelectorDir) { const computedPath = join(fieldSelectorDir, 'computed.json'); if (!existsSync(computedPath)) { return null; } const parsed = JSON.parse(readFileSync(computedPath, 'utf-8')); return ComputedProfileSchema.parse(parsed); } export function evaluateComputedProfile(profile, inputValues) { const fillValues = { ...inputValues }; const auditValues = {}; // Apply unconditional defaults for fields not already provided by input for (const [field, value] of Object.entries(profile.defaults)) { if (!(field in fillValues) || fillValues[field] === undefined || fillValues[field] === '') { fillValues[field] = value; } } const combinedState = { ...fillValues }; const passes = []; let stabilized = false; for (let pass = 1; pass <= profile.max_passes; pass += 1) { let passChanged = false; const ruleTraces = []; for (const rule of profile.rules) { const matched = matchRule(rule, combinedState); const assignments = []; if (matched) { for (const [field, assigned] of Object.entries(rule.set_fill)) { const resolved = interpolate(assigned, combinedState); const previous = fillValues[field]; if (previous !== resolved) { fillValues[field] = resolved; combinedState[field] = resolved; assignments.push({ field, scope: 'fill', previous, next: resolved }); passChanged = true; } } for (const [field, assigned] of Object.entries(rule.set_audit)) { const resolved = interpolate(assigned, combinedState); const previous = auditValues[field]; if (previous !== resolved) { auditValues[field] = resolved; combinedState[field] = resolved; assignments.push({ field, scope: 'audit', previous, next: resolved }); passChanged = true; } } } ruleTraces.push({ rule_id: rule.id, description: rule.description, matched, assignments, }); } passes.push({ pass, changed: passChanged, rules: ruleTraces, }); if (!passChanged) { stabilized = true; break; } } return { fillValues, auditValues, passes, stabilized, maxPasses: profile.max_passes, }; } export function buildComputedArtifact(args) { const { fieldSelectorId, inputValues, evaluated, profileVersion } = args; return { field_selector_id: fieldSelectorId, generated_at: new Date().toISOString(), profile_present: true, profile_version: profileVersion, max_passes: evaluated.maxPasses, stabilized: evaluated.stabilized, pass_count: evaluated.passes.length, inputs: inputValues, final_fill_values: evaluated.fillValues, derived_fill_values: computeDerivedValues(inputValues, evaluated.fillValues), derived_audit_values: evaluated.auditValues, passes: evaluated.passes, }; } export function buildPassthroughArtifact(args) { return { field_selector_id: args.fieldSelectorId, generated_at: new Date().toISOString(), profile_present: false, profile_version: null, max_passes: 0, stabilized: true, pass_count: 0, inputs: { ...args.inputValues }, final_fill_values: { ...args.inputValues }, derived_fill_values: {}, derived_audit_values: {}, passes: [], }; } export function writeComputedArtifact(outputPath, artifact) { writeFileSync(outputPath, `${JSON.stringify(artifact, null, 2)}\n`, 'utf-8'); } //# sourceMappingURL=computed.js.map