mirror of
https://github.com/documenso/documenso
synced 2026-04-21 13:27:18 +00:00
This PR introduces automatic detection and placement of fields and
recipients based on PDF placeholders.
The placeholders have the following structure:
- `{{fieldType,recipientPosition,fieldMeta}}`
- `{{text,r1,required=true,textAlign=right,fontSize=50}}`
When the user uploads a PDF document containing such placeholders, they
get converted automatically to Documenso fields and assigned to
recipients.
223 lines
6.9 KiB
TypeScript
223 lines
6.9 KiB
TypeScript
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
|
import { getEnvelopeWhereInput } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
|
|
import {
|
|
convertPlaceholdersToFieldInputs,
|
|
extractPdfPlaceholders,
|
|
} from '@documenso/lib/server-only/pdf/auto-place-fields';
|
|
import { findRecipientByPlaceholder } from '@documenso/lib/server-only/pdf/helpers';
|
|
import { insertFormValuesInPdf } from '@documenso/lib/server-only/pdf/insert-form-values-in-pdf';
|
|
import { normalizePdf } from '@documenso/lib/server-only/pdf/normalize-pdf';
|
|
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
|
import { prefixedId } from '@documenso/lib/universal/id';
|
|
import { putPdfFileServerSide } from '@documenso/lib/universal/upload/put-file.server';
|
|
import { createDocumentAuditLogData } from '@documenso/lib/utils/document-audit-logs';
|
|
import { canEnvelopeItemsBeModified } from '@documenso/lib/utils/envelope';
|
|
import { prisma } from '@documenso/prisma';
|
|
|
|
import { authenticatedProcedure } from '../trpc';
|
|
import {
|
|
ZCreateEnvelopeItemsRequestSchema,
|
|
ZCreateEnvelopeItemsResponseSchema,
|
|
createEnvelopeItemsMeta,
|
|
} from './create-envelope-items.types';
|
|
|
|
export const createEnvelopeItemsRoute = authenticatedProcedure
|
|
.meta(createEnvelopeItemsMeta)
|
|
.input(ZCreateEnvelopeItemsRequestSchema)
|
|
.output(ZCreateEnvelopeItemsResponseSchema)
|
|
.mutation(async ({ input, ctx }) => {
|
|
const { user, teamId, metadata } = ctx;
|
|
const { payload, files } = input;
|
|
const { envelopeId } = payload;
|
|
|
|
ctx.logger.info({
|
|
input: {
|
|
envelopeId,
|
|
},
|
|
});
|
|
|
|
const { envelopeWhereInput } = await getEnvelopeWhereInput({
|
|
id: {
|
|
type: 'envelopeId',
|
|
id: envelopeId,
|
|
},
|
|
type: null,
|
|
userId: user.id,
|
|
teamId,
|
|
});
|
|
|
|
const envelope = await prisma.envelope.findUnique({
|
|
where: envelopeWhereInput,
|
|
include: {
|
|
recipients: true,
|
|
envelopeItems: {
|
|
orderBy: {
|
|
order: 'asc',
|
|
},
|
|
},
|
|
team: {
|
|
select: {
|
|
organisation: {
|
|
select: {
|
|
organisationClaim: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
if (!envelope) {
|
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
message: 'Envelope not found',
|
|
});
|
|
}
|
|
|
|
if (!canEnvelopeItemsBeModified(envelope, envelope.recipients)) {
|
|
throw new AppError(AppErrorCode.INVALID_REQUEST, {
|
|
message: 'Envelope item is not editable',
|
|
});
|
|
}
|
|
|
|
const organisationClaim = envelope.team.organisation.organisationClaim;
|
|
|
|
const remainingEnvelopeItems =
|
|
organisationClaim.envelopeItemCount - envelope.envelopeItems.length - files.length;
|
|
|
|
if (remainingEnvelopeItems < 0) {
|
|
throw new AppError('ENVELOPE_ITEM_LIMIT_EXCEEDED', {
|
|
message: `You cannot upload more than ${organisationClaim.envelopeItemCount} envelope items`,
|
|
statusCode: 400,
|
|
});
|
|
}
|
|
|
|
// For each file: normalize, extract & clean placeholders, then upload.
|
|
const envelopeItems = await Promise.all(
|
|
files.map(async (file) => {
|
|
let buffer = Buffer.from(await file.arrayBuffer());
|
|
|
|
if (envelope.formValues) {
|
|
buffer = await insertFormValuesInPdf({ pdf: buffer, formValues: envelope.formValues });
|
|
}
|
|
|
|
const normalized = await normalizePdf(buffer, {
|
|
flattenForm: envelope.type !== 'TEMPLATE',
|
|
});
|
|
|
|
const { cleanedPdf, placeholders } = await extractPdfPlaceholders(normalized);
|
|
|
|
const { id: documentDataId } = await putPdfFileServerSide({
|
|
name: file.name,
|
|
type: 'application/pdf',
|
|
arrayBuffer: async () => Promise.resolve(cleanedPdf),
|
|
});
|
|
|
|
return {
|
|
title: file.name,
|
|
documentDataId,
|
|
placeholders,
|
|
};
|
|
}),
|
|
);
|
|
|
|
const currentHighestOrderValue =
|
|
envelope.envelopeItems[envelope.envelopeItems.length - 1]?.order ?? 1;
|
|
|
|
const result = await prisma.$transaction(async (tx) => {
|
|
const createdItems = await tx.envelopeItem.createManyAndReturn({
|
|
data: envelopeItems.map((item) => ({
|
|
id: prefixedId('envelope_item'),
|
|
envelopeId,
|
|
title: item.title,
|
|
documentDataId: item.documentDataId,
|
|
order: currentHighestOrderValue + 1,
|
|
})),
|
|
include: {
|
|
documentData: true,
|
|
},
|
|
});
|
|
|
|
await tx.documentAuditLog.createMany({
|
|
data: createdItems.map((item) =>
|
|
createDocumentAuditLogData({
|
|
type: DOCUMENT_AUDIT_LOG_TYPE.ENVELOPE_ITEM_CREATED,
|
|
envelopeId: envelope.id,
|
|
data: {
|
|
envelopeItemId: item.id,
|
|
envelopeItemTitle: item.title,
|
|
},
|
|
user: {
|
|
name: user.name,
|
|
email: user.email,
|
|
},
|
|
requestMetadata: metadata.requestMetadata,
|
|
}),
|
|
),
|
|
});
|
|
|
|
// Create fields from placeholders if the envelope already has recipients.
|
|
if (envelope.recipients.length > 0) {
|
|
const orderedRecipients = [...envelope.recipients].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;
|
|
});
|
|
|
|
for (const uploadedItem of envelopeItems) {
|
|
if (!uploadedItem.placeholders || uploadedItem.placeholders.length === 0) {
|
|
continue;
|
|
}
|
|
|
|
const createdItem = createdItems.find(
|
|
(ci) => ci.documentDataId === uploadedItem.documentDataId,
|
|
);
|
|
|
|
if (!createdItem) {
|
|
continue;
|
|
}
|
|
|
|
const fieldsToCreate = convertPlaceholdersToFieldInputs(
|
|
uploadedItem.placeholders,
|
|
(recipientPlaceholder, placeholder) =>
|
|
findRecipientByPlaceholder(
|
|
recipientPlaceholder,
|
|
placeholder,
|
|
orderedRecipients,
|
|
orderedRecipients,
|
|
),
|
|
createdItem.id,
|
|
);
|
|
|
|
if (fieldsToCreate.length > 0) {
|
|
await tx.field.createMany({
|
|
data: fieldsToCreate.map((field) => ({
|
|
envelopeId: envelope.id,
|
|
envelopeItemId: createdItem.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,
|
|
})),
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
return createdItems;
|
|
});
|
|
|
|
return {
|
|
data: result,
|
|
};
|
|
});
|