open-agreements
Version:
Open-source legal template filling CLI and library
29 lines • 966 B
TypeScript
export interface ScanDocxResult {
partNames: string[];
bracketsByPart: Map<string, Set<string>>;
unique: string[];
shortPlaceholders: string[];
longClauses: string[];
footnoteCount: number;
underscoreBlankCount: number;
artifactFindings: string[];
}
/**
* 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 declare function scanDocxBrackets(inputPath: string): ScanDocxResult;
/**
* 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 declare function runScan(args: {
input: string;
outputReplacements?: string;
}): void;
//# sourceMappingURL=scan.d.ts.map