feat: add new field overflow methods (#2715)

This commit is contained in:
David Nguyen
2026-05-08 15:14:27 +10:00
committed by GitHub
parent 4877d1964a
commit 207135d6f3
28 changed files with 2437 additions and 65 deletions
+137
View File
@@ -3,6 +3,7 @@ import path from 'node:path';
import { ALIGNMENT_TEST_FIELDS } from '@documenso/app-tests/constants/field-alignment-pdf';
import { FIELD_META_TEST_FIELDS } from '@documenso/app-tests/constants/field-meta-pdf';
import { OVERFLOW_TEST_FIELDS } from '@documenso/app-tests/constants/field-overflow-pdf';
import { isBase64Image } from '@documenso/lib/constants/signatures';
import {
incrementDocumentId,
@@ -183,6 +184,22 @@ export const seedDatabase = async () => {
userId: adminUser.user.id,
teamId: adminUser.team.id,
}),
seedOverflowTestDocument({
userId: exampleUser.user.id,
teamId: exampleUser.team.id,
recipientName: exampleUser.user.name || '',
recipientEmail: exampleUser.user.email,
insertFields: false,
status: DocumentStatus.DRAFT,
}),
seedOverflowTestDocument({
userId: adminUser.user.id,
teamId: adminUser.team.id,
recipientName: adminUser.user.name || '',
recipientEmail: adminUser.user.email,
insertFields: false,
status: DocumentStatus.DRAFT,
}),
seedAlignmentTestDocument({
userId: exampleUser.user.id,
teamId: exampleUser.team.id,
@@ -443,3 +460,123 @@ export const seedAlignmentTestDocument = async ({
},
});
};
export const seedOverflowTestDocument = async ({
userId,
teamId,
recipientName,
recipientEmail,
insertFields,
status,
}: {
userId: number;
teamId: number;
recipientName: string;
recipientEmail: string;
insertFields: boolean;
status: DocumentStatus;
}) => {
const overflowPdf = fs
.readFileSync(path.join(__dirname, '../../../assets/field-overflow.pdf'))
.toString('base64');
const overflowDocumentData = await createDocumentData({ documentData: overflowPdf });
const secondaryId = await incrementDocumentId().then((v) => v.formattedDocumentId);
const documentMeta = await prisma.documentMeta.create({
data: {},
});
const createdEnvelope = await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId,
internalVersion: 2,
type: EnvelopeType.DOCUMENT,
documentMetaId: documentMeta.id,
source: DocumentSource.DOCUMENT,
title: 'Overflow Test',
status,
envelopeItems: {
createMany: {
data: [
{
id: prefixedId('envelope_item'),
title: 'field-overflow',
documentDataId: overflowDocumentData.id,
order: 1,
},
],
},
},
userId,
teamId,
recipients: {
create: {
name: recipientName,
email: recipientEmail,
token: nanoid(),
sendStatus: status === 'DRAFT' ? SendStatus.NOT_SENT : SendStatus.SENT,
signingStatus: status === 'COMPLETED' ? SigningStatus.SIGNED : SigningStatus.NOT_SIGNED,
readStatus: status !== 'DRAFT' ? ReadStatus.OPENED : ReadStatus.NOT_OPENED,
},
},
},
include: {
recipients: true,
envelopeItems: true,
},
});
const { id, recipients, envelopeItems } = createdEnvelope;
const recipientId = recipients[0].id;
const envelopeItemId = envelopeItems.find((item) => item.order === 1)?.id;
if (!envelopeItemId) {
throw new Error('Envelope item not found');
}
await Promise.all(
OVERFLOW_TEST_FIELDS.map(async (field) => {
// Use seedFieldMeta (full meta with all defaults) instead of fieldMeta
// (minimal meta for API testing) since the seed bypasses API validation.
const { fieldMeta: _fieldMeta, seedFieldMeta, ...fieldData } = field;
await prisma.field.create({
data: {
...fieldData,
fieldMeta: seedFieldMeta,
recipientId,
envelopeItemId,
envelopeId: id,
customText: insertFields ? field.customText : '',
inserted:
insertFields &&
((!seedFieldMeta?.readOnly && Boolean(field.customText)) || field.type === 'SIGNATURE'),
signature:
field.signature && insertFields
? {
create: {
recipientId,
signatureImageAsBase64: isBase64Image(field.signature) ? field.signature : null,
typedSignature: isBase64Image(field.signature) ? null : field.signature,
},
}
: undefined,
},
});
}),
);
return await prisma.envelope.findFirstOrThrow({
where: {
id: createdEnvelope.id,
},
include: {
recipients: true,
envelopeItems: true,
},
});
};