Match the gate to the actual EOI's structure (Section 2 vs Section 3) so
the rep can generate the document the moment they have what they need —
and not before.
Required (Section 2 — top paragraph):
- Client name
- Client primary email
- Client primary address
Optional (Section 3 — left blank when absent):
- Linked yacht (name, dimensions)
- Linked berth (mooring number)
Previously the dialog blocked generation unless yacht AND berth were both
linked, which was overzealous — early-stage EOIs are routinely sent before
a specific berth is pinned down.
- eoi-context.ts: yacht and berth are now nullable in the returned
context. The hard ValidationError is now driven by the EOI's Section
2 fields (name/email/address) rather than yacht/berth presence. The
owner block falls back to the interest's client when no yacht is
linked, so signing parties remain resolvable.
- documenso-payload.ts + fill-eoi-form.ts: Section 3 form values
render as empty strings when yacht or berth are absent, so the
rendered PDF leaves those template inputs blank.
- document-templates.ts: yacht.* and berth.* tokens fall back to
empty strings; the legacy-fallback catch handler also recognises
the new "missing required client details" error.
- interests.service.ts: getInterestById now also returns
`clientPrimaryEmail` and `clientHasAddress` so the Documents tab
can compute the EOI prerequisites checklist client-side without an
extra fetch.
- eoi-generate-dialog.tsx: prereqs split into two groups visually —
Required (with red ✗ when missing) and Optional (with grey – when
absent). The Generate button only requires the Required block to
pass. A small amber banner surfaces when Required is incomplete so
the rep knows where to add the missing data.
Tests: 835/835 pass. Replaces the obsolete "throws on missing yacht/
berth" tests with parity coverage for the new behaviour ("builds a
valid context when yacht/berth missing", "throws when client email/
address missing"). Adds a payload test for the empty-Section-3 case.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
104 lines
3.6 KiB
TypeScript
104 lines
3.6 KiB
TypeScript
import { promises as fs } from 'node:fs';
|
|
import path from 'node:path';
|
|
|
|
import { PDFDocument } from 'pdf-lib';
|
|
|
|
import type { EoiContext } from '@/lib/services/eoi-context';
|
|
|
|
/**
|
|
* Source PDF for the in-app EOI pathway. Must contain AcroForm fields whose
|
|
* names match the Documenso template's `formValues` keys exactly:
|
|
*
|
|
* Text: Name, Email, Address, Yacht Name, Length, Width, Draft,
|
|
* Berth Number
|
|
* Checkbox: Lease_10, Purchase
|
|
*
|
|
* See assets/eoi-template/README.md for full details and the field mapping
|
|
* doc at docs/eoi-documenso-field-mapping.md for the canonical list.
|
|
*/
|
|
const DEFAULT_EOI_TEMPLATE_PATH = path.join(process.cwd(), 'assets', 'eoi-template.pdf');
|
|
|
|
function eoiTemplatePath(): string {
|
|
return process.env.EOI_TEMPLATE_PDF_PATH ?? DEFAULT_EOI_TEMPLATE_PATH;
|
|
}
|
|
|
|
export async function loadEoiTemplatePdf(): Promise<Uint8Array> {
|
|
const filePath = eoiTemplatePath();
|
|
try {
|
|
return await fs.readFile(filePath);
|
|
} catch (err) {
|
|
throw new Error(
|
|
`EOI source PDF not found at ${filePath}. Drop the same PDF used by the Documenso template (with AcroForm fields: Name, Email, Address, Yacht Name, Length, Width, Draft, Berth Number, Lease_10, Purchase) at this path, or override via EOI_TEMPLATE_PDF_PATH. Original error: ${(err as Error).message}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
function formatAddress(address: EoiContext['client']['address']): string {
|
|
if (!address) return '';
|
|
return [address.street, address.city, address.country].filter(Boolean).join(', ');
|
|
}
|
|
|
|
function setText(form: ReturnType<PDFDocument['getForm']>, name: string, value: string): void {
|
|
try {
|
|
form.getTextField(name).setText(value);
|
|
} catch {
|
|
// Field absent or wrong type — skip silently so a slightly different PDF
|
|
// template still produces output. Missing field issues surface in QA, not
|
|
// at runtime as a 500.
|
|
}
|
|
}
|
|
|
|
function setCheckbox(
|
|
form: ReturnType<PDFDocument['getForm']>,
|
|
name: string,
|
|
checked: boolean,
|
|
): void {
|
|
try {
|
|
const cb = form.getCheckBox(name);
|
|
if (checked) cb.check();
|
|
else cb.uncheck();
|
|
} catch {
|
|
// See comment in setText.
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fills the AcroForm fields of the EOI source PDF with values drawn from
|
|
* EoiContext. Field names mirror the Documenso template `formValues` keys so
|
|
* a single source PDF can serve both pathways.
|
|
*
|
|
* The form is left interactive (not flattened) so a recipient can still tweak
|
|
* fields if needed before signing.
|
|
*/
|
|
export async function fillEoiFormFields(
|
|
pdfBytes: Uint8Array,
|
|
context: EoiContext,
|
|
): Promise<Uint8Array> {
|
|
const doc = await PDFDocument.load(pdfBytes);
|
|
const form = doc.getForm();
|
|
|
|
setText(form, 'Name', context.client.fullName);
|
|
setText(form, 'Email', context.client.primaryEmail ?? '');
|
|
setText(form, 'Address', formatAddress(context.client.address));
|
|
// Yacht + berth (EOI Section 3) are optional — leave the AcroForm fields
|
|
// blank when the interest hasn't been linked to either.
|
|
setText(form, 'Yacht Name', context.yacht?.name ?? '');
|
|
setText(form, 'Length', context.yacht?.lengthFt ?? '');
|
|
setText(form, 'Width', context.yacht?.widthFt ?? '');
|
|
setText(form, 'Draft', context.yacht?.draftFt ?? '');
|
|
setText(form, 'Berth Number', context.berth?.mooringNumber ?? '');
|
|
|
|
setCheckbox(form, 'Purchase', true);
|
|
setCheckbox(form, 'Lease_10', false);
|
|
|
|
return doc.save();
|
|
}
|
|
|
|
/**
|
|
* Convenience: loads the source PDF from disk and returns the filled bytes.
|
|
*/
|
|
export async function generateEoiPdfFromTemplate(context: EoiContext): Promise<Uint8Array> {
|
|
const bytes = await loadEoiTemplatePdf();
|
|
return fillEoiFormFields(bytes, context);
|
|
}
|