open-agreements
Version:
Open-source legal template filling CLI and library
87 lines • 3.69 kB
JavaScript
import { parseReplacementKey, resolveReplacementValue } from '../field-selector/replacement-keys.js';
const FIELD_TAG_RE = /\{([a-z_][a-z0-9_]*)\}/g;
function extractFieldTags(template) {
const out = new Set();
let match = null;
while ((match = FIELD_TAG_RE.exec(template)) !== null) {
out.add(match[1]);
}
return [...out];
}
/**
* Compare short placeholders discovered via scan against field-selector/template metadata
* coverage inferred from replacements mapping.
*/
export function assessScanMetadataCoverage(input) {
const metadataFieldSet = new Set(input.metadataFields);
const ignored = new Set(input.ignoredPlaceholders ?? []);
const extraCovered = new Set(input.extraCoveredFields ?? []);
const placeholderFieldMap = new Map();
const mappedFieldsNotInMetadata = new Set();
for (const [key, rawValue] of Object.entries(input.replacements)) {
const value = resolveReplacementValue(rawValue);
const parsed = parseReplacementKey(key, value);
const searchText = parsed.searchText;
const tags = extractFieldTags(value);
if (!placeholderFieldMap.has(searchText)) {
placeholderFieldMap.set(searchText, new Set());
}
const fieldSet = placeholderFieldMap.get(searchText);
for (const tag of tags) {
fieldSet.add(tag);
if (!metadataFieldSet.has(tag)) {
mappedFieldsNotInMetadata.add(tag);
}
}
}
// Brackets embedded inside longer simple-key searchTexts are still covered
// by those keys (the patcher replaces the full key including the bracket).
const embeddedBracketCoverage = new Map();
for (const [searchText, fields] of placeholderFieldMap.entries()) {
for (const match of searchText.matchAll(/\[[^\]]+\]/g)) {
const bracket = match[0];
if (bracket !== searchText && fields.size > 0) {
if (!embeddedBracketCoverage.has(bracket)) {
embeddedBracketCoverage.set(bracket, new Set());
}
for (const field of fields) {
embeddedBracketCoverage.get(bracket).add(field);
}
}
}
}
const coveredShort = new Set();
const uncoveredShort = new Set();
const ignoredShort = new Set();
const coveredFields = new Set(extraCovered);
for (const placeholder of input.scannedShortPlaceholders) {
if (ignored.has(placeholder)) {
ignoredShort.add(placeholder);
continue;
}
const mapped = placeholderFieldMap.get(placeholder) ?? embeddedBracketCoverage.get(placeholder);
if (!mapped || mapped.size === 0) {
uncoveredShort.add(placeholder);
continue;
}
coveredShort.add(placeholder);
for (const field of mapped) {
coveredFields.add(field);
}
}
const placeholderToFields = Object.fromEntries([...placeholderFieldMap.entries()]
.sort(([a], [b]) => a.localeCompare(b))
.map(([placeholder, fields]) => [placeholder, [...fields].sort()]));
const metadataFieldsWithoutPlaceholderCoverage = [...metadataFieldSet]
.filter((field) => !coveredFields.has(field))
.sort();
return {
coveredShortPlaceholders: [...coveredShort].sort(),
uncoveredShortPlaceholders: [...uncoveredShort].sort(),
ignoredShortPlaceholders: [...ignoredShort].sort(),
placeholderToFields,
mappedFieldsNotInMetadata: [...mappedFieldsNotInMetadata].sort(),
metadataFieldsWithoutPlaceholderCoverage,
};
}
//# sourceMappingURL=scan-metadata.js.map