@open-agreements/open-agreements 0.2.0

package/dist/core/engine.js

@@ -0,0 +1,182 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { loadMetadata, loadCleanConfig } from './metadata.js';
+import { loadSelectionsConfig } from './selector.js';
+import { runFillPipeline } from './unified-pipeline.js';
+import { BLANK_PLACEHOLDER, verifyTemplateFill } from './fill-utils.js';
+/**
+ * Compute display fields for radio/checkbox groups in table rows.
+ * docx-templates only allows one {IF} per table row, so multi-option rows
+ * use a single computed display tag that the engine populates from input fields.
+ *
+ * This is template-specific logic — only activates when metadata declares
+ * the relevant display field names.
+ */
+function computeDisplayFields(data, fieldNames) {
+    const str = (key) => String(data[key] ?? '');
+    const bool = (key) => data[key] === true;
+    const isBlankPlaceholder = (value) => typeof value === 'string' && value.trim() === BLANK_PLACEHOLDER;
+    const toGoogleDocUrl = (value) => {
+        const raw = value.trim();
+        if (raw === '')
+            return '';
+        if (/^https?:\/\//i.test(raw))
+            return raw;
+        if (/^docs\.google\.com\/document\/d\//i.test(raw))
+            return `https://${raw}`;
+        if (/^[A-Za-z0-9_-]{20,}$/.test(raw))
+            return `https://docs.google.com/document/d/${raw}/`;
+        return raw;
+    };
+    // Optional cover-table rows in employment templates should disappear when blank.
+    // The default blank placeholder is intentionally visible in most contexts,
+    // but for these optional rows we normalize blank placeholders to empty strings
+    // so {IF field} conditions evaluate false and remove the row.
+    if (isBlankPlaceholder(data['bonus_terms'])) {
+        data['bonus_terms'] = '';
+    }
+    if (isBlankPlaceholder(data['equity_terms'])) {
+        data['equity_terms'] = '';
+    }
+    if (isBlankPlaceholder(data['cloud_drive_id'])) {
+        data['cloud_drive_id'] = '';
+    }
+    const cloudDriveId = typeof data['cloud_drive_id'] === 'string' ? data['cloud_drive_id'].trim() : '';
+    if (fieldNames.has('cloud_drive_id_footer')) {
+        const docUrl = cloudDriveId ? toGoogleDocUrl(cloudDriveId) : '';
+        data['cloud_drive_id_footer'] = docUrl ? `Document URL: ${docUrl}` : '';
+    }
+    // Order Date: "Date of last signature" or custom date
+    if (fieldNames.has('order_date_display') && !data['order_date_display']) {
+        data['order_date_display'] = bool('order_date_is_last_signature')
+            ? '( x )\tDate of last signature on this Order Form'
+            : `( x )\t${str('custom_order_date')}`;
+    }
+    // Pilot fee: paid or free trial
+    if (fieldNames.has('pilot_fee_display') && !data['pilot_fee_display']) {
+        data['pilot_fee_display'] = bool('pilot_is_free')
+            ? '( x )\tFree trial'
+            : `( x )\tFee for Pilot Period: ${str('pilot_fee')}`;
+    }
+    // Cloud Service Fees: build from selected checkboxes
+    if (fieldNames.has('fees_display') && !data['fees_display']) {
+        const lines = [];
+        if (bool('fee_is_per_unit')) {
+            lines.push(`[ x ] ${str('fees')} per ${str('fee_unit')}`);
+        }
+        if (bool('fee_is_other')) {
+            lines.push(`[ x ] Other fee structure: ${str('other_fee_structure')}`);
+        }
+        if (bool('fee_may_increase')) {
+            lines.push(`[ x ] Fees may increase up to ${str('fee_increase_cap_pct')}% per renewal`);
+        }
+        if (bool('fee_will_increase')) {
+            lines.push(`[ x ] Fees will increase ${str('fee_increase_fixed_pct')}% per renewal`);
+        }
+        if (bool('fee_inclusive_of_taxes')) {
+            lines.push('[ x ] Fees are inclusive of taxes (modifies Standard Terms Section 4.1)');
+        }
+        data['fees_display'] = lines.join('\n');
+    }
+    // Payment Process: invoice or automatic
+    if (fieldNames.has('payment_display') && !data['payment_display']) {
+        if (bool('payment_by_invoice')) {
+            const freq = str('payment_frequency');
+            const days = str('payment_terms_days');
+            const from = str('payment_due_from');
+            data['payment_display'] =
+                `( x )\tPay by invoice\n` +
+                    `Provider will invoice Customer ${freq}.\n` +
+                    `Customer will pay each invoice within ${days} days of ${from}.`;
+        }
+        else {
+            const freq = str('payment_frequency');
+            data['payment_display'] =
+                `( x )\tAutomatic payment\n` +
+                    `Customer authorizes Provider to charge the payment method on file ${freq}.`;
+        }
+    }
+    // Auto-renewal
+    if (fieldNames.has('auto_renewal_display') && !data['auto_renewal_display']) {
+        if (bool('auto_renew')) {
+            const days = str('non_renewal_notice_days');
+            data['auto_renewal_display'] =
+                `( x )\tNon-Renewal Notice Date is ${days} days before the end of the current Subscription Period.`;
+        }
+        else {
+            data['auto_renewal_display'] = '( x )\tThis Order does not automatically renew.';
+        }
+    }
+    // Effective Date
+    if (fieldNames.has('effective_date_display') && !data['effective_date_display']) {
+        data['effective_date_display'] = bool('effective_date_is_last_signature')
+            ? '( x )\tDate of last Cover Page signature'
+            : `( x )\t${str('custom_effective_date')}`;
+    }
+    // Covered Claims
+    if (fieldNames.has('covered_claims_display') && !data['covered_claims_display']) {
+        const lines = [];
+        if (bool('has_provider_covered_claims')) {
+            lines.push('[ x ] Provider Covered Claims: [Any action, proceeding, or claim that the Cloud Service, when used by Customer as permitted under the Agreement, infringes or misappropriates a third party\u2019s intellectual property rights.]');
+        }
+        if (bool('has_customer_covered_claims')) {
+            lines.push('[ x ] Customer Covered Claims: [Any action, proceeding, or claim that (1) the Customer Content, when used according to the Agreement, infringes or misappropriates a third party\u2019s intellectual property rights; or (2) results from the Customer\u2019s breach of Section 2.4.]');
+        }
+        data['covered_claims_display'] = lines.join('\n');
+    }
+    // General Cap Amount
+    if (fieldNames.has('general_cap_display') && !data['general_cap_display']) {
+        if (bool('general_cap_is_multiplier')) {
+            data['general_cap_display'] = `( x )\t${str('general_cap_multiplier')}x the Fees paid or payable by Customer in the 12 month period immediately preceding the claim`;
+        }
+        else if (bool('general_cap_is_dollar')) {
+            data['general_cap_display'] = `( x )\t$${str('general_cap_dollar')}`;
+        }
+        else if (bool('general_cap_is_greater_of')) {
+            data['general_cap_display'] = `( x )\tThe greater of $${str('general_cap_greater_dollar')} or ${str('general_cap_greater_multiplier')}x the Fees paid or payable by Customer in the 12 month period immediately preceding the claim`;
+        }
+    }
+}
+export async function fillTemplate(options) {
+    const { templateDir, values, outputPath } = options;
+    const metadata = loadMetadata(templateDir);
+    const fieldNames = new Set(metadata.fields.map((f) => f.name));
+    // Warn about unknown keys not in metadata
+    const unknownKeys = Object.keys(values).filter((k) => !fieldNames.has(k));
+    if (unknownKeys.length > 0) {
+        console.warn(`Warning: unknown field(s) not in metadata: ${unknownKeys.join(', ')}`);
+    }
+    // Build cleanPatch if replacements.json exists
+    const templatePath = join(templateDir, 'template.docx');
+    const replacementsPath = join(templateDir, 'replacements.json');
+    const cleanPatch = existsSync(replacementsPath)
+        ? {
+            cleanConfig: loadCleanConfig(templateDir),
+            replacements: JSON.parse(readFileSync(replacementsPath, 'utf-8')),
+        }
+        : undefined;
+    // Load selectionsConfig if selections.json exists
+    const selectionsPath = join(templateDir, 'selections.json');
+    const selectionsConfig = existsSync(selectionsPath)
+        ? loadSelectionsConfig(selectionsPath)
+        : undefined;
+    const result = await runFillPipeline({
+        inputPath: templatePath,
+        outputPath,
+        values,
+        fields: metadata.fields,
+        requiredFieldNames: metadata.required_fields,
+        cleanPatch,
+        selectionsConfig,
+        coerceBooleans: true,
+        computeDisplayFields: (d) => computeDisplayFields(d, fieldNames),
+        fixSmartQuotes: true,
+        verify: (p) => verifyTemplateFill(p),
+    });
+    return {
+        outputPath: result.outputPath,
+        metadata,
+        fieldsUsed: result.fieldsUsed,
+    };
+}
+//# sourceMappingURL=engine.js.map

package/dist/core/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../../src/core/engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,YAAY,EAAE,eAAe,EAAyB,MAAM,eAAe,CAAC;AACrF,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAexE;;;;;;;GAOG;AACH,SAAS,oBAAoB,CAAC,IAA6B,EAAE,UAAuB;IAClF,MAAM,GAAG,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;IAC1D,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAW,EAAE,CACrD,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,iBAAiB,CAAC;IAClE,MAAM,cAAc,GAAG,CAAC,KAAa,EAAU,EAAE;QAC/C,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,GAAG,KAAK,EAAE;YAAE,OAAO,EAAE,CAAC;QAC1B,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC;QAC1C,IAAI,oCAAoC,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,OAAO,WAAW,GAAG,EAAE,CAAC;QAC5E,IAAI,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,OAAO,sCAAsC,GAAG,GAAG,CAAC;QAC1F,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEF,iFAAiF;IACjF,2EAA2E;IAC3E,+EAA+E;IAC/E,8DAA8D;IAC9D,IAAI,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;IAC3B,CAAC;IACD,IAAI,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC;IAC5B,CAAC;IACD,IAAI,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC;IAC9B,CAAC;IACD,MAAM,YAAY,GAAG,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACrG,IAAI,UAAU,CAAC,GAAG,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1E,CAAC;IAED,sDAAsD;IACtD,IAAI,UAAU,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACxE,IAAI,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,8BAA8B,CAAC;YAC/D,CAAC,CAAC,kDAAkD;YACpD,CAAC,CAAC,UAAU,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAC3C,CAAC;IAED,gCAAgC;IAChC,IAAI,UAAU,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACtE,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;YAC/C,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,gCAAgC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;IACzD,CAAC;IAED,qDAAqD;IACrD,IAAI,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACzB,KAAK,CAAC,IAAI,CAAC,8BAA8B,GAAG,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,iCAAiC,GAAG,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,4BAA4B,GAAG,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC;QACvF,CAAC;QACD,IAAI,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAC;QACxF,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,wCAAwC;IACxC,IAAI,UAAU,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAClE,IAAI,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,GAAG,CAAC,oBAAoB,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC;YACrC,IAAI,CAAC,iBAAiB,CAAC;gBACrB,yBAAyB;oBACzB,kCAAkC,IAAI,KAAK;oBAC3C,yCAAyC,IAAI,YAAY,IAAI,GAAG,CAAC;QACrE,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACtC,IAAI,CAAC,iBAAiB,CAAC;gBACrB,4BAA4B;oBAC5B,qEAAqE,IAAI,GAAG,CAAC;QACjF,CAAC;IACH,CAAC;IAED,eAAe;IACf,IAAI,UAAU,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,GAAG,CAAC,yBAAyB,CAAC,CAAC;YAC5C,IAAI,CAAC,sBAAsB,CAAC;gBAC1B,qCAAqC,IAAI,0DAA0D,CAAC;QACxG,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,sBAAsB,CAAC,GAAG,iDAAiD,CAAC;QACnF,CAAC;IACH,CAAC;IAED,iBAAiB;IACjB,IAAI,UAAU,CAAC,GAAG,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAChF,IAAI,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,kCAAkC,CAAC;YACvE,CAAC,CAAC,0CAA0C;YAC5C,CAAC,CAAC,UAAU,GAAG,CAAC,uBAAuB,CAAC,EAAE,CAAC;IAC/C,CAAC;IAED,iBAAiB;IACjB,IAAI,UAAU,CAAC,GAAG,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAChF,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,6BAA6B,CAAC,EAAE,CAAC;YACxC,KAAK,CAAC,IAAI,CAAC,mOAAmO,CAAC,CAAC;QAClP,CAAC;QACD,IAAI,IAAI,CAAC,6BAA6B,CAAC,EAAE,CAAC;YACxC,KAAK,CAAC,IAAI,CAAC,uRAAuR,CAAC,CAAC;QACtS,CAAC;QACD,IAAI,CAAC,wBAAwB,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,qBAAqB;IACrB,IAAI,UAAU,CAAC,GAAG,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC1E,IAAI,IAAI,CAAC,2BAA2B,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,qBAAqB,CAAC,GAAG,UAAU,GAAG,CAAC,wBAAwB,CAAC,+FAA+F,CAAC;QACvK,CAAC;aAAM,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,qBAAqB,CAAC,GAAG,WAAW,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACvE,CAAC;aAAM,IAAI,IAAI,CAAC,2BAA2B,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,qBAAqB,CAAC,GAAG,0BAA0B,GAAG,CAAC,4BAA4B,CAAC,OAAO,GAAG,CAAC,gCAAgC,CAAC,+FAA+F,CAAC;QACvO,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAoB;IACrD,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAEpD,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;IAC3C,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/D,0CAA0C;IAC1C,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,8CAA8C,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvF,CAAC;IAED,+CAA+C;IAC/C,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IACxD,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAChE,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,CAAC;QAC7C,CAAC,CAAC;YACE,WAAW,EAAE,eAAe,CAAC,WAAW,CAAC;YACzC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAA2B;SAC5F;QACH,CAAC,CAAC,SAAS,CAAC;IAEd,kDAAkD;IAClD,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAC5D,MAAM,gBAAgB,GAAG,UAAU,CAAC,cAAc,CAAC;QACjD,CAAC,CAAC,oBAAoB,CAAC,cAAc,CAAC;QACtC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC;QACnC,SAAS,EAAE,YAAY;QACvB,UAAU;QACV,MAAM;QACN,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,kBAAkB,EAAE,QAAQ,CAAC,eAAe;QAC5C,UAAU;QACV,gBAAgB;QAChB,cAAc,EAAE,IAAI;QACpB,oBAAoB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,EAAE,UAAU,CAAC;QAChE,cAAc,EAAE,IAAI;QACpB,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;KACrC,CAAC,CAAC;IAEH,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ;QACR,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC;AACJ,CAAC"}

package/dist/core/external/index.d.ts

@@ -0,0 +1,8 @@
+import type { ExternalFillOptions, ExternalFillResult } from './types.js';
+/**
+ * Run the external fill pipeline: integrity check → clean → patch → fill → verify.
+ * Uses the local DOCX file from the external/ directory (never modifies the original).
+ */
+export declare function runExternalFill(options: ExternalFillOptions): Promise<ExternalFillResult>;
+export type { ExternalFillOptions, ExternalFillResult } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/external/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/external/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAE1E;;;GAGG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA+C/F;AAED,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/core/external/index.js

@@ -0,0 +1,50 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { createHash } from 'node:crypto';
+import { loadExternalMetadata, loadCleanConfig } from '../metadata.js';
+import { resolveExternalDir } from '../../utils/paths.js';
+import { verifyOutput } from '../recipe/verifier.js';
+import { runFillPipeline } from '../unified-pipeline.js';
+/**
+ * Run the external fill pipeline: integrity check → clean → patch → fill → verify.
+ * Uses the local DOCX file from the external/ directory (never modifies the original).
+ */
+export async function runExternalFill(options) {
+    const { externalId, outputPath, values, keepIntermediate } = options;
+    const externalDir = resolveExternalDir(externalId);
+    const metadata = loadExternalMetadata(externalDir);
+    // SHA-256 integrity check
+    const docxPath = join(externalDir, 'template.docx');
+    const docxBuf = readFileSync(docxPath);
+    const actualHash = createHash('sha256').update(docxBuf).digest('hex');
+    if (actualHash !== metadata.source_sha256) {
+        throw new Error(`Integrity check failed for "${externalId}": DOCX has been modified.\n` +
+            `  Expected SHA-256: ${metadata.source_sha256}\n` +
+            `  Actual SHA-256:   ${actualHash}`);
+    }
+    // CC-BY-ND redistribution warning
+    console.log(`\nNote: This is an external document (${metadata.license}). ` +
+        `You may fill it for your own use, but do not redistribute modified versions.\n` +
+        `See: ${metadata.source_url}\n`);
+    // Load clean config and replacements
+    const cleanConfig = loadCleanConfig(externalDir);
+    const replacementsPath = join(externalDir, 'replacements.json');
+    const replacements = JSON.parse(readFileSync(replacementsPath, 'utf-8'));
+    const result = await runFillPipeline({
+        inputPath: docxPath,
+        outputPath,
+        values,
+        fields: metadata.fields,
+        requiredFieldNames: metadata.required_fields,
+        cleanPatch: { cleanConfig, replacements },
+        verify: (p) => verifyOutput(p, values, replacements, cleanConfig),
+        keepIntermediate,
+    });
+    return {
+        outputPath: result.outputPath,
+        metadata,
+        fieldsUsed: result.fieldsUsed,
+        stages: result.stages,
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/core/external/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/external/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAGzD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAA4B;IAChE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;IACrE,MAAM,WAAW,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAEnD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAEnD,0BAA0B;IAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACtE,IAAI,UAAU,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CACb,+BAA+B,UAAU,8BAA8B;YACvE,uBAAuB,QAAQ,CAAC,aAAa,IAAI;YACjD,uBAAuB,UAAU,EAAE,CACpC,CAAC;IACJ,CAAC;IAED,kCAAkC;IAClC,OAAO,CAAC,GAAG,CACT,yCAAyC,QAAQ,CAAC,OAAO,KAAK;QAC9D,gFAAgF;QAChF,QAAQ,QAAQ,CAAC,UAAU,IAAI,CAChC,CAAC;IAEF,qCAAqC;IACrC,MAAM,WAAW,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAChE,MAAM,YAAY,GAA2B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;IAEjG,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC;QACnC,SAAS,EAAE,QAAQ;QACnB,UAAU;QACV,MAAM;QACN,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,kBAAkB,EAAE,QAAQ,CAAC,eAAe;QAC5C,UAAU,EAAE,EAAE,WAAW,EAAE,YAAY,EAAE;QACzC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC;QACjE,gBAAgB;KACjB,CAAC,CAAC;IAEH,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ;QACR,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,MAAM,EAAE,MAAM,CAAC,MAAO;KACvB,CAAC;AACJ,CAAC"}

package/dist/core/external/types.d.ts

@@ -0,0 +1,18 @@
+import type { ExternalMetadata } from '../metadata.js';
+export interface ExternalFillOptions {
+    externalId: string;
+    outputPath: string;
+    values: Record<string, unknown>;
+    keepIntermediate?: boolean;
+}
+export interface ExternalFillResult {
+    outputPath: string;
+    metadata: ExternalMetadata;
+    fieldsUsed: string[];
+    stages: {
+        clean: string;
+        patch: string;
+        fill: string;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/core/external/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/core/external/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEvD,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH"}

package/dist/core/external/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/core/external/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/core/external/types.ts"],"names":[],"mappings":""}

package/dist/core/fill-pipeline.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Shared fill pipeline used by all three fill paths (template, external, recipe).
+ * Centralizes: defaults, boolean coercion, display fields, currency sanitization,
+ * drafting note removal, and the docx-templates createReport() call.
+ */
+import type { FieldDefinition } from './metadata.js';
+export interface PrepareFillDataOptions {
+    /** User-provided values. */
+    values: Record<string, unknown>;
+    /** Field definitions from metadata. */
+    fields: FieldDefinition[];
+    /** Required field names from metadata.required_fields. */
+    requiredFieldNames?: string[];
+    /**
+     * When true, unfilled optional fields default to BLANK_PLACEHOLDER ('_______')
+     * so omissions are visible. When false, they default to '' (empty string).
+     * All fill paths use true by default.
+     */
+    useBlankPlaceholder?: boolean;
+    /** Coerce boolean-typed fields to actual JS booleans for IF conditions. */
+    coerceBooleans?: boolean;
+    /**
+     * Optional callback for computing display fields (template-specific).
+     * Called after defaults and boolean coercion are applied.
+     */
+    computeDisplayFields?: (data: Record<string, unknown>) => void;
+}
+export interface FillDocxOptions {
+    /** Template DOCX buffer (already patched with {tags}). */
+    templateBuffer: Buffer;
+    /** Prepared fill data from prepareFillData(). */
+    data: Record<string, unknown>;
+    /** Apply docx-templates smart quote normalization. */
+    fixSmartQuotes?: boolean;
+    /**
+     * Regex patterns for paragraphs to remove before filling.
+     * Paragraphs whose text matches any pattern are stripped from the DOCX.
+     * If a matched paragraph is the only content in a table row, the entire
+     * row is removed to avoid empty highlighted rows.
+     *
+     * Default: `[/\bDrafting note\b/i]` — removes Common Paper drafting notes.
+     * Pass `[]` to disable.
+     */
+    stripParagraphPatterns?: RegExp[];
+}
+/**
+ * Prepare fill data with all normalization steps:
+ * 1. Validate required fields are present
+ * 2. Apply defaults for optional fields not provided
+ * 3. Coerce boolean fields (optional)
+ * 4. Compute display fields (optional, template-specific)
+ */
+export declare function prepareFillData(options: PrepareFillDataOptions): Record<string, unknown>;
+/**
+ * Fill a DOCX template with prepared data:
+ * 1. Strip drafting note paragraphs (configurable, on by default)
+ * 2. Strip highlighting from runs with filled fields (unfilled keep their highlight)
+ * 3. Sanitize currency values by scanning the template buffer for ${field} patterns
+ * 4. Call docx-templates createReport() with standard delimiters
+ * 5. Remove structurally empty table rows left by conditional rendering
+ * 6. Return the filled buffer
+ */
+export declare function fillDocx(options: FillDocxOptions): Promise<Uint8Array>;
+//# sourceMappingURL=fill-pipeline.d.ts.map

package/dist/core/fill-pipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fill-pipeline.d.ts","sourceRoot":"","sources":["../../src/core/fill-pipeline.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAQH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAIrD,MAAM,WAAW,sBAAsB;IACrC,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC,uCAAuC;IACvC,MAAM,EAAE,eAAe,EAAE,CAAC;IAE1B,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B,2EAA2E;IAC3E,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;CAChE;AAED,MAAM,WAAW,eAAe;IAC9B,0DAA0D;IAC1D,cAAc,EAAE,MAAM,CAAC;IAEvB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B,sDAAsD;IACtD,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAKD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAkDxF;AAgRD;;;;;;;;GAQG;AACH,wBAAsB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CA0C5E"}