feat(pdf): import AcroForm widgets as Documenso fields on upload

Detect AcroForm widgets (text, checkbox, radio, dropdown, signature) at upload
time and reuse their geometry as Documenso fields instead of stripping them via
form.flatten(). Imported fields land in the editor as ordinary Field rows
assigned to the first signable recipient, removing the manual re-placement step
users hit when preparing PDFs in Adobe Acrobat.

Extraction runs before normalizePdf so widget geometry is still readable.
Text fields go through a name+format heuristic that maps DATE/NUMBER/EMAIL/
NAME/INITIALS/TEXT, with AcroForm /AA format actions taking precedence over
name tokens. Coordinates are converted via per-rotation transforms (0/90/180/
270) against the rendered page dimensions; widgets fully off-page are
dropped, partial overlap is clamped. Signed signatures (SignatureField.
isSigned()) are detected and skip both the import and the form flatten so
the signature stays valid. Encrypted PDFs, XFA hybrids, malformed PDFs, and
internal extractor errors all return an empty result with skipReason set so
the upload proceeds untouched.

Every imported field carries fieldMeta.source = 'acroform' (new optional on
ZBaseFieldMeta) for future provenance queries. DOCUMENT envelopes emit a
per-field FIELD_CREATED audit entry matching create-envelope-fields.ts.
Recipient assignment picks the first Recipient with role SIGNER or APPROVER
sorted by (signingOrder asc nulls last, id asc); when no signable recipient
exists, a placeholder Recipient 1 SIGNER is created mirroring the
placeholder-pipeline behaviour.
This commit is contained in:
ephraimduncan
2026-05-21 04:05:12 +00:00
parent c0ea4c60e4
commit b8a11df768
13 changed files with 5006 additions and 4 deletions
@@ -1,4 +1,6 @@
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
import type { AcroFormFieldImportInfo } from '@documenso/lib/server-only/pdf/acroform-fields';
import { convertAcroFormFieldsToFieldInputs } from '@documenso/lib/server-only/pdf/acroform-fields';
import type { PlaceholderInfo } from '@documenso/lib/server-only/pdf/auto-place-fields';
import { convertPlaceholdersToFieldInputs } from '@documenso/lib/server-only/pdf/auto-place-fields';
import { findRecipientByPlaceholder } from '@documenso/lib/server-only/pdf/helpers';
@@ -72,6 +74,7 @@ export type CreateEnvelopeOptions = {
documentDataId: string;
order?: number;
placeholders?: PlaceholderInfo[];
acroFormFields?: AcroFormFieldImportInfo[];
}[];
formValues?: TDocumentFormValues;
@@ -537,6 +540,136 @@ export const createEnvelope = async ({
}
}
// Create fields from imported AcroForm widgets (extracted at upload time).
// Runs after the placeholder branch so placeholder-created recipients are
// visible in `availableRecipientsForAcroForm`.
const itemsWithAcroFormFields = envelopeItems.filter(
(item) => item.acroFormFields && item.acroFormFields.length > 0,
);
if (itemsWithAcroFormFields.length > 0) {
let availableRecipientsForAcroForm = await tx.recipient.findMany({
where: { envelopeId: envelope.id },
select: { id: true, email: true, role: true, signingOrder: true },
});
const pickFirstSignableRecipient = () => {
const signable = availableRecipientsForAcroForm.filter(
(r) => r.role === RecipientRole.SIGNER || r.role === RecipientRole.APPROVER,
);
if (signable.length === 0) {
return null;
}
return [...signable].sort((a, b) => {
const aOrder = a.signingOrder ?? Number.MAX_SAFE_INTEGER;
const bOrder = b.signingOrder ?? Number.MAX_SAFE_INTEGER;
if (aOrder !== bOrder) {
return aOrder - bOrder;
}
return a.id - b.id;
})[0];
};
let firstSignableRecipient = pickFirstSignableRecipient();
if (!firstSignableRecipient) {
// No signable recipient yet — create a placeholder Recipient 1 SIGNER
// mirroring the placeholder branch's behavior.
const placeholderEmail = 'recipient.1@documenso.com';
const existingPlaceholder = availableRecipientsForAcroForm.find(
(r) => r.email.toLowerCase() === placeholderEmail,
);
if (!existingPlaceholder) {
await tx.recipient.create({
data: {
envelopeId: envelope.id,
email: placeholderEmail,
name: 'Recipient 1',
role: RecipientRole.SIGNER,
signingOrder: 1,
token: nanoid(),
sendStatus: SendStatus.NOT_SENT,
signingStatus: SigningStatus.NOT_SIGNED,
},
});
}
// eslint-disable-next-line require-atomic-updates
availableRecipientsForAcroForm = await tx.recipient.findMany({
where: { envelopeId: envelope.id },
select: { id: true, email: true, role: true, signingOrder: true },
});
firstSignableRecipient = pickFirstSignableRecipient();
}
if (!firstSignableRecipient) {
throw new AppError(AppErrorCode.NOT_FOUND, {
message: 'Could not resolve a signable recipient for AcroForm import.',
});
}
const acroFormRecipient = firstSignableRecipient;
for (const item of itemsWithAcroFormFields) {
const envelopeItem = envelope.envelopeItems.find((ei) => ei.documentDataId === item.documentDataId);
if (!envelopeItem) {
continue;
}
const fieldsToCreate = convertAcroFormFieldsToFieldInputs(
item.acroFormFields ?? [],
() => acroFormRecipient,
envelopeItem.id,
);
if (fieldsToCreate.length === 0) {
continue;
}
const createdFields = await tx.field.createManyAndReturn({
data: fieldsToCreate.map((field) => ({
envelopeId: envelope.id,
envelopeItemId: envelopeItem.id,
recipientId: field.recipientId,
type: field.type,
page: field.page,
positionX: field.positionX,
positionY: field.positionY,
width: field.width,
height: field.height,
customText: '',
inserted: false,
fieldMeta: field.fieldMeta || undefined,
})),
});
if (type === EnvelopeType.DOCUMENT) {
await tx.documentAuditLog.createMany({
data: createdFields.map((createdField) =>
createDocumentAuditLogData({
type: DOCUMENT_AUDIT_LOG_TYPE.FIELD_CREATED,
envelopeId: envelope.id,
metadata: requestMetadata,
data: {
fieldId: createdField.secondaryId,
fieldRecipientEmail: acroFormRecipient.email,
fieldRecipientId: createdField.recipientId,
fieldType: createdField.type,
},
}),
),
});
}
}
}
const createdEnvelope = await tx.envelope.findFirst({
where: {
id: envelope.id,