mirror of
https://github.com/documenso/documenso.git
synced 2025-11-21 12:11:29 +10:00
Compare commits
4 Commits
feat/auto-
...
feat/get-d
| Author | SHA1 | Date | |
|---|---|---|---|
| 45b2f51462 | |||
| 29baa3e0d1 | |||
| 1fe7f78479 | |||
| b3b8a35446 |
13
package-lock.json
generated
13
package-lock.json
generated
@ -19,7 +19,6 @@
|
|||||||
"inngest-cli": "^0.29.1",
|
"inngest-cli": "^0.29.1",
|
||||||
"luxon": "^3.5.0",
|
"luxon": "^3.5.0",
|
||||||
"mupdf": "^1.0.0",
|
"mupdf": "^1.0.0",
|
||||||
"pdf2json": "^4.0.0",
|
|
||||||
"react": "^18",
|
"react": "^18",
|
||||||
"typescript": "5.6.2",
|
"typescript": "5.6.2",
|
||||||
"zod": "^3.25.76"
|
"zod": "^3.25.76"
|
||||||
@ -27502,18 +27501,6 @@
|
|||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
},
|
},
|
||||||
"node_modules/pdf2json": {
|
|
||||||
"version": "4.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/pdf2json/-/pdf2json-4.0.0.tgz",
|
|
||||||
"integrity": "sha512-WkezNsLK8sGpuFC7+PPP0DsXROwdoOxmXPBTtUWWkCwCi/Vi97MRC52Ly6FWIJjOKIywpm/L2oaUgSrmtU+7ZQ==",
|
|
||||||
"license": "Apache-2.0",
|
|
||||||
"bin": {
|
|
||||||
"pdf2json": "bin/pdf2json.js"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=20.18.0"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/pdfjs-dist": {
|
"node_modules/pdfjs-dist": {
|
||||||
"version": "3.11.174",
|
"version": "3.11.174",
|
||||||
"resolved": "https://registry.npmjs.org/pdfjs-dist/-/pdfjs-dist-3.11.174.tgz",
|
"resolved": "https://registry.npmjs.org/pdfjs-dist/-/pdfjs-dist-3.11.174.tgz",
|
||||||
|
|||||||
@ -86,7 +86,6 @@
|
|||||||
"inngest-cli": "^0.29.1",
|
"inngest-cli": "^0.29.1",
|
||||||
"luxon": "^3.5.0",
|
"luxon": "^3.5.0",
|
||||||
"mupdf": "^1.0.0",
|
"mupdf": "^1.0.0",
|
||||||
"pdf2json": "^4.0.0",
|
|
||||||
"react": "^18",
|
"react": "^18",
|
||||||
"typescript": "5.6.2",
|
"typescript": "5.6.2",
|
||||||
"zod": "^3.25.76"
|
"zod": "^3.25.76"
|
||||||
|
|||||||
@ -1,129 +0,0 @@
|
|||||||
import { type Page, expect, test } from '@playwright/test';
|
|
||||||
import path from 'path';
|
|
||||||
|
|
||||||
import { seedUser } from '@documenso/prisma/seed/users';
|
|
||||||
|
|
||||||
import { apiSignin } from '../fixtures/authentication';
|
|
||||||
|
|
||||||
const SINGLE_PLACEHOLDER_PDF_PATH = path.join(
|
|
||||||
__dirname,
|
|
||||||
'../../../assets/project-proposal-single-recipient.pdf',
|
|
||||||
);
|
|
||||||
|
|
||||||
const MULTIPLE_PLACEHOLDER_PDF_PATH = path.join(
|
|
||||||
__dirname,
|
|
||||||
'../../../assets/project-proposal-multiple-fields-and-recipients.pdf',
|
|
||||||
);
|
|
||||||
|
|
||||||
const setupUserAndSignIn = async (page: Page) => {
|
|
||||||
const { user, team } = await seedUser();
|
|
||||||
|
|
||||||
await apiSignin({
|
|
||||||
page,
|
|
||||||
email: user.email,
|
|
||||||
redirectPath: `/t/${team.url}/documents`,
|
|
||||||
});
|
|
||||||
|
|
||||||
return { user, team };
|
|
||||||
};
|
|
||||||
|
|
||||||
const uploadPdfAndContinue = async (page: Page, pdfPath: string, continueClicks: number = 1) => {
|
|
||||||
const fileInput = page.locator('input[type="file"]').nth(1);
|
|
||||||
await fileInput.waitFor({ state: 'attached' });
|
|
||||||
await fileInput.setInputFiles(pdfPath);
|
|
||||||
|
|
||||||
await page.waitForTimeout(3000);
|
|
||||||
|
|
||||||
for (let i = 0; i < continueClicks; i++) {
|
|
||||||
await page.getByRole('button', { name: 'Continue' }).click();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
test.describe('PDF Placeholders with single recipient', () => {
|
|
||||||
test('[AUTO_PLACING_FIELDS]: should automatically create recipients from PDF placeholders', async ({
|
|
||||||
page,
|
|
||||||
}) => {
|
|
||||||
await setupUserAndSignIn(page);
|
|
||||||
await uploadPdfAndContinue(page, SINGLE_PLACEHOLDER_PDF_PATH, 1);
|
|
||||||
|
|
||||||
await expect(page.getByRole('heading', { name: 'Add Signers' })).toBeVisible();
|
|
||||||
await expect(page.getByPlaceholder('Email')).toHaveValue('recipient.1@documenso.com');
|
|
||||||
await expect(page.getByPlaceholder('Name')).toHaveValue('Recipient 1');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('[AUTO_PLACING_FIELDS]: should automatically place fields from PDF placeholders', async ({
|
|
||||||
page,
|
|
||||||
}) => {
|
|
||||||
await setupUserAndSignIn(page);
|
|
||||||
await uploadPdfAndContinue(page, SINGLE_PLACEHOLDER_PDF_PATH, 2);
|
|
||||||
|
|
||||||
await expect(page.getByRole('heading', { name: 'Add Fields' })).toBeVisible();
|
|
||||||
|
|
||||||
await expect(page.locator('[data-field-type="SIGNATURE"]')).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="EMAIL"]')).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="NAME"]')).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="TEXT"]')).toBeVisible();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('[AUTO_PLACING_FIELDS]: should automatically configure fields from PDF placeholders', async ({
|
|
||||||
page,
|
|
||||||
}) => {
|
|
||||||
await setupUserAndSignIn(page);
|
|
||||||
await uploadPdfAndContinue(page, SINGLE_PLACEHOLDER_PDF_PATH, 2);
|
|
||||||
|
|
||||||
await page.getByText('Text').nth(1).click();
|
|
||||||
await page.getByRole('button', { name: 'Advanced settings' }).click();
|
|
||||||
|
|
||||||
await expect(page.getByRole('heading', { name: 'Advanced settings' })).toBeVisible();
|
|
||||||
await expect(
|
|
||||||
page
|
|
||||||
.locator('div')
|
|
||||||
.filter({ hasText: /^Required field$/ })
|
|
||||||
.getByRole('switch'),
|
|
||||||
).toBeChecked();
|
|
||||||
|
|
||||||
await expect(page.getByRole('combobox')).toHaveText('Right');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test.describe('PDF Placeholders with multiple recipients', () => {
|
|
||||||
test('[AUTO_PLACING_FIELDS]: should automatically create recipients from PDF placeholders', async ({
|
|
||||||
page,
|
|
||||||
}) => {
|
|
||||||
await setupUserAndSignIn(page);
|
|
||||||
await uploadPdfAndContinue(page, MULTIPLE_PLACEHOLDER_PDF_PATH, 1);
|
|
||||||
|
|
||||||
await expect(page.getByTestId('signer-email-input').first()).toHaveValue(
|
|
||||||
'recipient.1@documenso.com',
|
|
||||||
);
|
|
||||||
await expect(page.getByLabel('Name').first()).toHaveValue('Recipient 1');
|
|
||||||
|
|
||||||
await expect(page.getByTestId('signer-email-input').nth(1)).toHaveValue(
|
|
||||||
'recipient.2@documenso.com',
|
|
||||||
);
|
|
||||||
await expect(page.getByLabel('Name').nth(1)).toHaveValue('Recipient 2');
|
|
||||||
|
|
||||||
await expect(page.getByTestId('signer-email-input').nth(2)).toHaveValue(
|
|
||||||
'recipient.3@documenso.com',
|
|
||||||
);
|
|
||||||
await expect(page.getByLabel('Name').nth(2)).toHaveValue('Recipient 3');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('[AUTO_PLACING_FIELDS]: should automatically create fields from PDF placeholders', async ({
|
|
||||||
page,
|
|
||||||
}) => {
|
|
||||||
await setupUserAndSignIn(page);
|
|
||||||
await uploadPdfAndContinue(page, MULTIPLE_PLACEHOLDER_PDF_PATH, 2);
|
|
||||||
|
|
||||||
await expect(page.getByRole('heading', { name: 'Add Fields' })).toBeVisible();
|
|
||||||
|
|
||||||
await expect(page.locator('[data-field-type="SIGNATURE"]').first()).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="SIGNATURE"]').nth(1)).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="SIGNATURE"]').nth(2)).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="EMAIL"]').first()).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="EMAIL"]').nth(1)).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="NAME"]')).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="TEXT"]')).toBeVisible();
|
|
||||||
await expect(page.locator('[data-field-type="NUMBER"]')).toBeVisible();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
Binary file not shown.
Binary file not shown.
@ -10,11 +10,6 @@ import {
|
|||||||
} from '@prisma/client';
|
} from '@prisma/client';
|
||||||
|
|
||||||
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
||||||
import {
|
|
||||||
extractPlaceholdersFromPDF,
|
|
||||||
insertFieldsFromPlaceholdersInPDF,
|
|
||||||
removePlaceholdersFromPDF,
|
|
||||||
} from '@documenso/lib/server-only/pdf/auto-place-fields';
|
|
||||||
import { normalizePdf as makeNormalizedPdf } from '@documenso/lib/server-only/pdf/normalize-pdf';
|
import { normalizePdf as makeNormalizedPdf } from '@documenso/lib/server-only/pdf/normalize-pdf';
|
||||||
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
||||||
import type { ApiRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
|
import type { ApiRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
|
||||||
@ -39,7 +34,6 @@ import { getFileServerSide } from '../../universal/upload/get-file.server';
|
|||||||
import { putPdfFileServerSide } from '../../universal/upload/put-file.server';
|
import { putPdfFileServerSide } from '../../universal/upload/put-file.server';
|
||||||
import { extractDerivedDocumentMeta } from '../../utils/document';
|
import { extractDerivedDocumentMeta } from '../../utils/document';
|
||||||
import { createDocumentAuthOptions, createRecipientAuthOptions } from '../../utils/document-auth';
|
import { createDocumentAuthOptions, createRecipientAuthOptions } from '../../utils/document-auth';
|
||||||
import type { EnvelopeIdOptions } from '../../utils/envelope';
|
|
||||||
import { buildTeamWhereQuery } from '../../utils/teams';
|
import { buildTeamWhereQuery } from '../../utils/teams';
|
||||||
import { incrementDocumentId, incrementTemplateId } from '../envelope/increment-id';
|
import { incrementDocumentId, incrementTemplateId } from '../envelope/increment-id';
|
||||||
import { getTeamSettings } from '../team/get-team-settings';
|
import { getTeamSettings } from '../team/get-team-settings';
|
||||||
@ -262,7 +256,7 @@ export const createEnvelope = async ({
|
|||||||
? await incrementDocumentId().then((v) => v.formattedDocumentId)
|
? await incrementDocumentId().then((v) => v.formattedDocumentId)
|
||||||
: await incrementTemplateId().then((v) => v.formattedTemplateId);
|
: await incrementTemplateId().then((v) => v.formattedTemplateId);
|
||||||
|
|
||||||
const createdEnvelope = await prisma.$transaction(async (tx) => {
|
return await prisma.$transaction(async (tx) => {
|
||||||
const envelope = await tx.envelope.create({
|
const envelope = await tx.envelope.create({
|
||||||
data: {
|
data: {
|
||||||
id: prefixedId('envelope'),
|
id: prefixedId('envelope'),
|
||||||
@ -382,12 +376,8 @@ export const createEnvelope = async ({
|
|||||||
recipients: true,
|
recipients: true,
|
||||||
fields: true,
|
fields: true,
|
||||||
folder: true,
|
folder: true,
|
||||||
|
envelopeItems: true,
|
||||||
envelopeAttachments: true,
|
envelopeAttachments: true,
|
||||||
envelopeItems: {
|
|
||||||
include: {
|
|
||||||
documentData: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -423,74 +413,4 @@ export const createEnvelope = async ({
|
|||||||
|
|
||||||
return createdEnvelope;
|
return createdEnvelope;
|
||||||
});
|
});
|
||||||
|
|
||||||
for (const envelopeItem of createdEnvelope.envelopeItems) {
|
|
||||||
const buffer = await getFileServerSide(envelopeItem.documentData);
|
|
||||||
const pdfToProcess = Buffer.from(buffer);
|
|
||||||
|
|
||||||
const envelopeOptions: EnvelopeIdOptions = {
|
|
||||||
type: 'envelopeId',
|
|
||||||
id: createdEnvelope.id,
|
|
||||||
};
|
|
||||||
|
|
||||||
const placeholders = await extractPlaceholdersFromPDF(pdfToProcess);
|
|
||||||
|
|
||||||
if (placeholders.length > 0) {
|
|
||||||
const pdfWithoutPlaceholders = await removePlaceholdersFromPDF(pdfToProcess);
|
|
||||||
|
|
||||||
await insertFieldsFromPlaceholdersInPDF(
|
|
||||||
pdfWithoutPlaceholders,
|
|
||||||
userId,
|
|
||||||
teamId,
|
|
||||||
envelopeOptions,
|
|
||||||
requestMetadata,
|
|
||||||
envelopeItem.id,
|
|
||||||
createdEnvelope.recipients,
|
|
||||||
);
|
|
||||||
|
|
||||||
const titleToUse = envelopeItem.title || title;
|
|
||||||
const fileName = titleToUse.endsWith('.pdf') ? titleToUse : `${titleToUse}.pdf`;
|
|
||||||
|
|
||||||
const newDocumentData = await putPdfFileServerSide({
|
|
||||||
name: fileName,
|
|
||||||
type: 'application/pdf',
|
|
||||||
arrayBuffer: async () => Promise.resolve(pdfWithoutPlaceholders),
|
|
||||||
});
|
|
||||||
|
|
||||||
await prisma.envelopeItem.update({
|
|
||||||
where: {
|
|
||||||
id: envelopeItem.id,
|
|
||||||
},
|
|
||||||
data: {
|
|
||||||
documentDataId: newDocumentData.id,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const finalEnvelope = await prisma.envelope.findFirst({
|
|
||||||
where: {
|
|
||||||
id: createdEnvelope.id,
|
|
||||||
},
|
|
||||||
include: {
|
|
||||||
documentMeta: true,
|
|
||||||
recipients: true,
|
|
||||||
fields: true,
|
|
||||||
folder: true,
|
|
||||||
envelopeAttachments: true,
|
|
||||||
envelopeItems: {
|
|
||||||
include: {
|
|
||||||
documentData: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!finalEnvelope) {
|
|
||||||
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
||||||
message: 'Envelope not found',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return finalEnvelope;
|
|
||||||
};
|
};
|
||||||
|
|||||||
@ -1,347 +0,0 @@
|
|||||||
import { PDFDocument, rgb } from '@cantoo/pdf-lib';
|
|
||||||
import type { Recipient } from '@prisma/client';
|
|
||||||
import PDFParser from 'pdf2json';
|
|
||||||
|
|
||||||
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
|
||||||
import { getEnvelopeWhereInput } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
|
|
||||||
import { createEnvelopeFields } from '@documenso/lib/server-only/field/create-envelope-fields';
|
|
||||||
import { type TFieldAndMeta, ZFieldAndMetaSchema } from '@documenso/lib/types/field-meta';
|
|
||||||
import type { ApiRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
|
|
||||||
import type { EnvelopeIdOptions } from '@documenso/lib/utils/envelope';
|
|
||||||
import { prisma } from '@documenso/prisma';
|
|
||||||
|
|
||||||
import { getPageSize } from './get-page-size';
|
|
||||||
import {
|
|
||||||
determineRecipientsForPlaceholders,
|
|
||||||
extractRecipientPlaceholder,
|
|
||||||
findRecipientByPlaceholder,
|
|
||||||
parseFieldMetaFromPlaceholder,
|
|
||||||
parseFieldTypeFromPlaceholder,
|
|
||||||
} from './helpers';
|
|
||||||
|
|
||||||
const PLACEHOLDER_REGEX = /{{([^}]+)}}/g;
|
|
||||||
const DEFAULT_FIELD_HEIGHT_PERCENT = 2;
|
|
||||||
const WIDTH_ADJUSTMENT_FACTOR = 0.1;
|
|
||||||
const MIN_HEIGHT_THRESHOLD = 0.01;
|
|
||||||
|
|
||||||
type TextPosition = {
|
|
||||||
text: string;
|
|
||||||
x: number;
|
|
||||||
y: number;
|
|
||||||
w: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
type CharIndexMapping = {
|
|
||||||
textPositionIndex: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
type PlaceholderInfo = {
|
|
||||||
placeholder: string;
|
|
||||||
recipient: string;
|
|
||||||
fieldAndMeta: TFieldAndMeta;
|
|
||||||
page: number;
|
|
||||||
x: number;
|
|
||||||
y: number;
|
|
||||||
width: number;
|
|
||||||
height: number;
|
|
||||||
pageWidth: number;
|
|
||||||
pageHeight: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
type FieldToCreate = TFieldAndMeta & {
|
|
||||||
envelopeItemId?: string;
|
|
||||||
recipientId: number;
|
|
||||||
page: number;
|
|
||||||
positionX: number;
|
|
||||||
positionY: number;
|
|
||||||
width: number;
|
|
||||||
height: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const extractPlaceholdersFromPDF = async (pdf: Buffer): Promise<PlaceholderInfo[]> => {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
const parser = new PDFParser(null, true);
|
|
||||||
|
|
||||||
parser.on('pdfParser_dataError', (errData) => {
|
|
||||||
reject(errData);
|
|
||||||
});
|
|
||||||
|
|
||||||
parser.on('pdfParser_dataReady', (pdfData) => {
|
|
||||||
const placeholders: PlaceholderInfo[] = [];
|
|
||||||
|
|
||||||
pdfData.Pages.forEach((page, pageIndex) => {
|
|
||||||
/*
|
|
||||||
pdf2json returns the PDF page content as an array of characters.
|
|
||||||
We need to concatenate the characters to get the full text.
|
|
||||||
We also need to get the position of the text so we can place the placeholders in the correct position.
|
|
||||||
|
|
||||||
Page dimensions from PDF2JSON are in "page units" (relative coordinates)
|
|
||||||
*/
|
|
||||||
let pageText = '';
|
|
||||||
const textPositions: TextPosition[] = [];
|
|
||||||
const charIndexMappings: CharIndexMapping[] = [];
|
|
||||||
|
|
||||||
page.Texts.forEach((text) => {
|
|
||||||
/*
|
|
||||||
R is an array of objects containing each character, its position and styling information.
|
|
||||||
The decodedText stores the characters, without any other information.
|
|
||||||
|
|
||||||
textPositions stores each character and its position on the page.
|
|
||||||
*/
|
|
||||||
const decodedText = text.R.map((run) => decodeURIComponent(run.T)).join('');
|
|
||||||
|
|
||||||
/*
|
|
||||||
For each character in the decodedText, we store its position in the textPositions array.
|
|
||||||
This allows us to quickly find the position of a character in the textPositions array by its index.
|
|
||||||
*/
|
|
||||||
for (let i = 0; i < decodedText.length; i++) {
|
|
||||||
charIndexMappings.push({
|
|
||||||
textPositionIndex: textPositions.length,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
pageText += decodedText;
|
|
||||||
|
|
||||||
textPositions.push({
|
|
||||||
text: decodedText,
|
|
||||||
x: text.x,
|
|
||||||
y: text.y,
|
|
||||||
w: text.w || 0,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
const placeholderMatches = pageText.matchAll(PLACEHOLDER_REGEX);
|
|
||||||
|
|
||||||
/*
|
|
||||||
A placeholder match has the following format:
|
|
||||||
|
|
||||||
[
|
|
||||||
'{{fieldType,recipient,fieldMeta}}',
|
|
||||||
'fieldType,recipient,fieldMeta',
|
|
||||||
'index: <number>',
|
|
||||||
'input: <pdf-text>'
|
|
||||||
]
|
|
||||||
*/
|
|
||||||
for (const placeholderMatch of placeholderMatches) {
|
|
||||||
const placeholder = placeholderMatch[0];
|
|
||||||
const placeholderData = placeholderMatch[1].split(',').map((property) => property.trim());
|
|
||||||
|
|
||||||
const [fieldTypeString, recipient, ...fieldMetaData] = placeholderData;
|
|
||||||
|
|
||||||
const rawFieldMeta = Object.fromEntries(
|
|
||||||
fieldMetaData.map((property) => property.split('=')),
|
|
||||||
);
|
|
||||||
|
|
||||||
const fieldType = parseFieldTypeFromPlaceholder(fieldTypeString);
|
|
||||||
const parsedFieldMeta = parseFieldMetaFromPlaceholder(rawFieldMeta, fieldType);
|
|
||||||
|
|
||||||
const fieldAndMeta: TFieldAndMeta = ZFieldAndMetaSchema.parse({
|
|
||||||
type: fieldType,
|
|
||||||
fieldMeta: parsedFieldMeta,
|
|
||||||
});
|
|
||||||
|
|
||||||
/*
|
|
||||||
Find the position of where the placeholder starts and ends in the text.
|
|
||||||
|
|
||||||
Then find the position of the characters in the textPositions array.
|
|
||||||
This allows us to quickly find the position of a character in the textPositions array by its index.
|
|
||||||
*/
|
|
||||||
const placeholderEndCharIndex = placeholderMatch.index + placeholder.length;
|
|
||||||
|
|
||||||
/*
|
|
||||||
Get the index of the placeholder's first and last character in the textPositions array.
|
|
||||||
Used to retrieve the character information from the textPositions array.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
startTextPosIndex - 1
|
|
||||||
endTextPosIndex - 40
|
|
||||||
*/
|
|
||||||
const startTextPosIndex = charIndexMappings[placeholderMatch.index].textPositionIndex;
|
|
||||||
const endTextPosIndex = charIndexMappings[placeholderEndCharIndex - 1].textPositionIndex;
|
|
||||||
|
|
||||||
/*
|
|
||||||
Get the placeholder's first and last character information from the textPositions array.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
placeholderStart = { text: '{', x: 100, y: 100, w: 100 }
|
|
||||||
placeholderEnd = { text: '}', x: 200, y: 100, w: 100 }
|
|
||||||
*/
|
|
||||||
const placeholderStart = textPositions[startTextPosIndex];
|
|
||||||
const placeholderEnd = textPositions[endTextPosIndex];
|
|
||||||
|
|
||||||
const width =
|
|
||||||
placeholderEnd.x + placeholderEnd.w * WIDTH_ADJUSTMENT_FACTOR - placeholderStart.x;
|
|
||||||
|
|
||||||
placeholders.push({
|
|
||||||
placeholder,
|
|
||||||
recipient,
|
|
||||||
fieldAndMeta,
|
|
||||||
page: pageIndex + 1,
|
|
||||||
x: placeholderStart.x,
|
|
||||||
y: placeholderStart.y,
|
|
||||||
width,
|
|
||||||
height: 1,
|
|
||||||
pageWidth: page.Width,
|
|
||||||
pageHeight: page.Height,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
resolve(placeholders);
|
|
||||||
});
|
|
||||||
|
|
||||||
parser.parseBuffer(pdf);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
export const removePlaceholdersFromPDF = async (pdf: Buffer): Promise<Buffer> => {
|
|
||||||
const placeholders = await extractPlaceholdersFromPDF(pdf);
|
|
||||||
|
|
||||||
const pdfDoc = await PDFDocument.load(new Uint8Array(pdf));
|
|
||||||
const pages = pdfDoc.getPages();
|
|
||||||
|
|
||||||
for (const placeholder of placeholders) {
|
|
||||||
const pageIndex = placeholder.page - 1;
|
|
||||||
const page = pages[pageIndex];
|
|
||||||
|
|
||||||
const { width: pdfLibPageWidth, height: pdfLibPageHeight } = getPageSize(page);
|
|
||||||
|
|
||||||
/*
|
|
||||||
Convert PDF2JSON coordinates to pdf-lib coordinates:
|
|
||||||
|
|
||||||
PDF2JSON uses relative "page units":
|
|
||||||
- x, y, width, height are in page units
|
|
||||||
- Page dimensions (Width, Height) are also in page units
|
|
||||||
|
|
||||||
pdf-lib uses absolute points (1 point = 1/72 inch):
|
|
||||||
- Need to convert from page units to points
|
|
||||||
- Y-axis in pdf-lib is bottom-up (origin at bottom-left)
|
|
||||||
- Y-axis in PDF2JSON is top-down (origin at top-left)
|
|
||||||
*/
|
|
||||||
|
|
||||||
const xPoints = (placeholder.x / placeholder.pageWidth) * pdfLibPageWidth;
|
|
||||||
const yPoints = pdfLibPageHeight - (placeholder.y / placeholder.pageHeight) * pdfLibPageHeight;
|
|
||||||
const widthPoints = (placeholder.width / placeholder.pageWidth) * pdfLibPageWidth;
|
|
||||||
const heightPoints = (placeholder.height / placeholder.pageHeight) * pdfLibPageHeight;
|
|
||||||
|
|
||||||
page.drawRectangle({
|
|
||||||
x: xPoints,
|
|
||||||
y: yPoints - heightPoints, // Adjust for height since y is at baseline
|
|
||||||
width: widthPoints,
|
|
||||||
height: heightPoints,
|
|
||||||
color: rgb(1, 1, 1),
|
|
||||||
borderColor: rgb(1, 1, 1),
|
|
||||||
borderWidth: 2,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const modifiedPdfBytes = await pdfDoc.save();
|
|
||||||
|
|
||||||
return Buffer.from(modifiedPdfBytes);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const insertFieldsFromPlaceholdersInPDF = async (
|
|
||||||
pdf: Buffer,
|
|
||||||
userId: number,
|
|
||||||
teamId: number,
|
|
||||||
envelopeId: EnvelopeIdOptions,
|
|
||||||
requestMetadata: ApiRequestMetadata,
|
|
||||||
envelopeItemId?: string,
|
|
||||||
recipients?: Pick<Recipient, 'id' | 'email'>[],
|
|
||||||
): Promise<Buffer> => {
|
|
||||||
const placeholders = await extractPlaceholdersFromPDF(pdf);
|
|
||||||
|
|
||||||
if (placeholders.length === 0) {
|
|
||||||
return pdf;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
A structure that maps the recipient index to the recipient name.
|
|
||||||
Example: 1 => 'Recipient 1'
|
|
||||||
*/
|
|
||||||
const recipientPlaceholders = new Map<number, string>();
|
|
||||||
|
|
||||||
for (const placeholder of placeholders) {
|
|
||||||
const { name, recipientIndex } = extractRecipientPlaceholder(placeholder.recipient);
|
|
||||||
|
|
||||||
recipientPlaceholders.set(recipientIndex, name);
|
|
||||||
}
|
|
||||||
|
|
||||||
const { envelopeWhereInput } = await getEnvelopeWhereInput({
|
|
||||||
id: envelopeId,
|
|
||||||
userId,
|
|
||||||
teamId,
|
|
||||||
type: null,
|
|
||||||
});
|
|
||||||
|
|
||||||
const envelope = await prisma.envelope.findFirst({
|
|
||||||
where: envelopeWhereInput,
|
|
||||||
select: {
|
|
||||||
id: true,
|
|
||||||
type: true,
|
|
||||||
secondaryId: true,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!envelope) {
|
|
||||||
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
||||||
message: 'Envelope not found',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const createdRecipients = await determineRecipientsForPlaceholders(
|
|
||||||
recipients,
|
|
||||||
recipientPlaceholders,
|
|
||||||
envelope,
|
|
||||||
userId,
|
|
||||||
teamId,
|
|
||||||
requestMetadata,
|
|
||||||
);
|
|
||||||
|
|
||||||
const fieldsToCreate: FieldToCreate[] = [];
|
|
||||||
|
|
||||||
for (const placeholder of placeholders) {
|
|
||||||
/*
|
|
||||||
Convert PDF2JSON coordinates to percentage-based coordinates (0-100)
|
|
||||||
The UI expects positionX and positionY as percentages, not absolute points
|
|
||||||
PDF2JSON uses relative coordinates: x/pageWidth and y/pageHeight give us the percentage
|
|
||||||
*/
|
|
||||||
const xPercent = (placeholder.x / placeholder.pageWidth) * 100;
|
|
||||||
const yPercent = (placeholder.y / placeholder.pageHeight) * 100;
|
|
||||||
|
|
||||||
const widthPercent = (placeholder.width / placeholder.pageWidth) * 100;
|
|
||||||
const heightPercent = (placeholder.height / placeholder.pageHeight) * 100;
|
|
||||||
|
|
||||||
const recipient = findRecipientByPlaceholder(
|
|
||||||
placeholder.recipient,
|
|
||||||
placeholder.placeholder,
|
|
||||||
recipients,
|
|
||||||
createdRecipients,
|
|
||||||
);
|
|
||||||
|
|
||||||
// Default height percentage if too small (use 2% as a reasonable default)
|
|
||||||
const finalHeightPercent =
|
|
||||||
heightPercent > MIN_HEIGHT_THRESHOLD ? heightPercent : DEFAULT_FIELD_HEIGHT_PERCENT;
|
|
||||||
|
|
||||||
fieldsToCreate.push({
|
|
||||||
...placeholder.fieldAndMeta,
|
|
||||||
envelopeItemId,
|
|
||||||
recipientId: recipient.id,
|
|
||||||
page: placeholder.page,
|
|
||||||
positionX: xPercent,
|
|
||||||
positionY: yPercent,
|
|
||||||
width: widthPercent,
|
|
||||||
height: finalHeightPercent,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
await createEnvelopeFields({
|
|
||||||
userId,
|
|
||||||
teamId,
|
|
||||||
id: envelopeId,
|
|
||||||
fields: fieldsToCreate,
|
|
||||||
requestMetadata,
|
|
||||||
});
|
|
||||||
|
|
||||||
return pdf;
|
|
||||||
};
|
|
||||||
@ -1,266 +0,0 @@
|
|||||||
import { FieldType } from '@prisma/client';
|
|
||||||
import { type Envelope, EnvelopeType, RecipientRole } from '@prisma/client';
|
|
||||||
import type { Recipient } from '@prisma/client';
|
|
||||||
import { match } from 'ts-pattern';
|
|
||||||
|
|
||||||
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
|
||||||
import { createEnvelopeRecipients } from '@documenso/lib/server-only/recipient/create-envelope-recipients';
|
|
||||||
import type { ApiRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
|
|
||||||
import { mapSecondaryIdToTemplateId } from '@documenso/lib/utils/envelope';
|
|
||||||
import type { EnvelopeIdOptions } from '@documenso/lib/utils/envelope';
|
|
||||||
import { prisma } from '@documenso/prisma';
|
|
||||||
|
|
||||||
type RecipientPlaceholderInfo = {
|
|
||||||
email: string;
|
|
||||||
name: string;
|
|
||||||
recipientIndex: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
/*
|
|
||||||
Parse field type string to FieldType enum.
|
|
||||||
Normalizes the input (uppercase, trim) and validates it's a valid field type.
|
|
||||||
This ensures we handle case variations and whitespace, and provides clear error messages.
|
|
||||||
*/
|
|
||||||
export const parseFieldTypeFromPlaceholder = (fieldTypeString: string): FieldType => {
|
|
||||||
const normalizedType = fieldTypeString.toUpperCase().trim();
|
|
||||||
|
|
||||||
return match(normalizedType)
|
|
||||||
.with('SIGNATURE', () => FieldType.SIGNATURE)
|
|
||||||
.with('FREE_SIGNATURE', () => FieldType.FREE_SIGNATURE)
|
|
||||||
.with('INITIALS', () => FieldType.INITIALS)
|
|
||||||
.with('NAME', () => FieldType.NAME)
|
|
||||||
.with('EMAIL', () => FieldType.EMAIL)
|
|
||||||
.with('DATE', () => FieldType.DATE)
|
|
||||||
.with('TEXT', () => FieldType.TEXT)
|
|
||||||
.with('NUMBER', () => FieldType.NUMBER)
|
|
||||||
.with('RADIO', () => FieldType.RADIO)
|
|
||||||
.with('CHECKBOX', () => FieldType.CHECKBOX)
|
|
||||||
.with('DROPDOWN', () => FieldType.DROPDOWN)
|
|
||||||
.otherwise(() => {
|
|
||||||
throw new AppError(AppErrorCode.INVALID_BODY, {
|
|
||||||
message: `Invalid field type: ${fieldTypeString}`,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
/*
|
|
||||||
Transform raw field metadata from placeholder format to schema format.
|
|
||||||
Users should provide properly capitalized property names (e.g., readOnly, fontSize, textAlign).
|
|
||||||
Converts string values to proper types (booleans, numbers).
|
|
||||||
*/
|
|
||||||
export const parseFieldMetaFromPlaceholder = (
|
|
||||||
rawFieldMeta: Record<string, string>,
|
|
||||||
fieldType: FieldType,
|
|
||||||
): Record<string, unknown> | undefined => {
|
|
||||||
if (fieldType === FieldType.SIGNATURE || fieldType === FieldType.FREE_SIGNATURE) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (Object.keys(rawFieldMeta).length === 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const fieldTypeString = String(fieldType).toLowerCase();
|
|
||||||
|
|
||||||
const parsedFieldMeta: Record<string, boolean | number | string> = {
|
|
||||||
type: fieldTypeString,
|
|
||||||
};
|
|
||||||
|
|
||||||
/*
|
|
||||||
rawFieldMeta is an object with string keys and string values.
|
|
||||||
It contains string values because the PDF parser returns the values as strings.
|
|
||||||
|
|
||||||
E.g. { 'required': 'true', 'fontSize': '12', 'maxValue': '100', 'minValue': '0', 'characterLimit': '100' }
|
|
||||||
*/
|
|
||||||
const rawFieldMetaEntries = Object.entries(rawFieldMeta);
|
|
||||||
|
|
||||||
for (const [property, value] of rawFieldMetaEntries) {
|
|
||||||
if (property === 'readOnly' || property === 'required') {
|
|
||||||
parsedFieldMeta[property] = value === 'true';
|
|
||||||
} else if (
|
|
||||||
property === 'fontSize' ||
|
|
||||||
property === 'maxValue' ||
|
|
||||||
property === 'minValue' ||
|
|
||||||
property === 'characterLimit'
|
|
||||||
) {
|
|
||||||
const numValue = Number(value);
|
|
||||||
|
|
||||||
if (!Number.isNaN(numValue)) {
|
|
||||||
parsedFieldMeta[property] = numValue;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
parsedFieldMeta[property] = value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return parsedFieldMeta;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const extractRecipientPlaceholder = (placeholder: string): RecipientPlaceholderInfo => {
|
|
||||||
const indexMatch = placeholder.match(/^r(\d+)$/i);
|
|
||||||
|
|
||||||
if (!indexMatch) {
|
|
||||||
throw new AppError(AppErrorCode.INVALID_BODY, {
|
|
||||||
message: `Invalid recipient placeholder format: ${placeholder}. Expected format: r1, r2, r3, etc.`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const recipientIndex = Number(indexMatch[1]);
|
|
||||||
|
|
||||||
return {
|
|
||||||
email: `recipient.${recipientIndex}@documenso.com`,
|
|
||||||
name: `Recipient ${recipientIndex}`,
|
|
||||||
recipientIndex,
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
/*
|
|
||||||
Finds a recipient based on a placeholder reference.
|
|
||||||
If recipients array is provided, uses index-based matching (r1 -> recipients[0], etc.).
|
|
||||||
Otherwise, uses email-based matching from createdRecipients.
|
|
||||||
*/
|
|
||||||
export const findRecipientByPlaceholder = (
|
|
||||||
recipientPlaceholder: string,
|
|
||||||
placeholder: string,
|
|
||||||
recipients: Pick<Recipient, 'id' | 'email'>[] | undefined,
|
|
||||||
createdRecipients: Pick<Recipient, 'id' | 'email'>[],
|
|
||||||
): Pick<Recipient, 'id' | 'email'> => {
|
|
||||||
if (recipients && recipients.length > 0) {
|
|
||||||
/*
|
|
||||||
Map placeholder by index: r1 -> recipients[0], r2 -> recipients[1], etc.
|
|
||||||
recipientIndex is 1-based, so we subtract 1 to get the array index.
|
|
||||||
*/
|
|
||||||
const { recipientIndex } = extractRecipientPlaceholder(recipientPlaceholder);
|
|
||||||
const recipientArrayIndex = recipientIndex - 1;
|
|
||||||
|
|
||||||
if (recipientArrayIndex < 0 || recipientArrayIndex >= recipients.length) {
|
|
||||||
throw new AppError(AppErrorCode.INVALID_BODY, {
|
|
||||||
message: `Recipient placeholder ${recipientPlaceholder} (index ${recipientIndex}) is out of range. Provided ${recipients.length} recipient(s).`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return recipients[recipientArrayIndex];
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
Use email-based matching for placeholder recipients.
|
|
||||||
*/
|
|
||||||
const { email } = extractRecipientPlaceholder(recipientPlaceholder);
|
|
||||||
const recipient = createdRecipients.find((r) => r.email === email);
|
|
||||||
|
|
||||||
if (!recipient) {
|
|
||||||
throw new AppError(AppErrorCode.INVALID_BODY, {
|
|
||||||
message: `Could not find recipient ID for placeholder: ${placeholder}`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return recipient;
|
|
||||||
};
|
|
||||||
|
|
||||||
/*
|
|
||||||
Determines the recipients to use for field creation.
|
|
||||||
If recipients are provided, uses them directly.
|
|
||||||
Otherwise, creates recipients from placeholders.
|
|
||||||
*/
|
|
||||||
export const determineRecipientsForPlaceholders = async (
|
|
||||||
recipients: Pick<Recipient, 'id' | 'email'>[] | undefined,
|
|
||||||
recipientPlaceholders: Map<number, string>,
|
|
||||||
envelope: Pick<Envelope, 'id' | 'type' | 'secondaryId'>,
|
|
||||||
userId: number,
|
|
||||||
teamId: number,
|
|
||||||
requestMetadata: ApiRequestMetadata,
|
|
||||||
): Promise<Pick<Recipient, 'id' | 'email'>[]> => {
|
|
||||||
if (recipients && recipients.length > 0) {
|
|
||||||
return recipients;
|
|
||||||
}
|
|
||||||
|
|
||||||
return createRecipientsFromPlaceholders(
|
|
||||||
recipientPlaceholders,
|
|
||||||
envelope,
|
|
||||||
userId,
|
|
||||||
teamId,
|
|
||||||
requestMetadata,
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const createRecipientsFromPlaceholders = async (
|
|
||||||
recipientPlaceholders: Map<number, string>,
|
|
||||||
envelope: Pick<Envelope, 'id' | 'type' | 'secondaryId'>,
|
|
||||||
userId: number,
|
|
||||||
teamId: number,
|
|
||||||
requestMetadata: ApiRequestMetadata,
|
|
||||||
): Promise<Pick<Recipient, 'id' | 'email'>[]> => {
|
|
||||||
const recipientsToCreate = Array.from(
|
|
||||||
recipientPlaceholders.entries(),
|
|
||||||
([recipientIndex, name]) => {
|
|
||||||
return {
|
|
||||||
email: `recipient.${recipientIndex}@documenso.com`,
|
|
||||||
name,
|
|
||||||
role: RecipientRole.SIGNER,
|
|
||||||
signingOrder: recipientIndex,
|
|
||||||
};
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
const existingRecipients = await prisma.recipient.findMany({
|
|
||||||
where: {
|
|
||||||
envelopeId: envelope.id,
|
|
||||||
},
|
|
||||||
select: {
|
|
||||||
id: true,
|
|
||||||
email: true,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const existingEmails = new Set(existingRecipients.map((r) => r.email));
|
|
||||||
const recipientsToCreateFiltered = recipientsToCreate.filter(
|
|
||||||
(recipient) => !existingEmails.has(recipient.email),
|
|
||||||
);
|
|
||||||
|
|
||||||
if (recipientsToCreateFiltered.length === 0) {
|
|
||||||
return existingRecipients;
|
|
||||||
}
|
|
||||||
|
|
||||||
const newRecipients = await match(envelope.type)
|
|
||||||
.with(EnvelopeType.DOCUMENT, async () => {
|
|
||||||
const envelopeId: EnvelopeIdOptions = {
|
|
||||||
type: 'envelopeId',
|
|
||||||
id: envelope.id,
|
|
||||||
};
|
|
||||||
|
|
||||||
const { recipients } = await createEnvelopeRecipients({
|
|
||||||
userId,
|
|
||||||
teamId,
|
|
||||||
id: envelopeId,
|
|
||||||
recipients: recipientsToCreateFiltered,
|
|
||||||
requestMetadata,
|
|
||||||
});
|
|
||||||
|
|
||||||
return recipients;
|
|
||||||
})
|
|
||||||
.with(EnvelopeType.TEMPLATE, async () => {
|
|
||||||
const templateId = mapSecondaryIdToTemplateId(envelope.secondaryId ?? '');
|
|
||||||
|
|
||||||
const envelopeId: EnvelopeIdOptions = {
|
|
||||||
type: 'templateId',
|
|
||||||
id: templateId,
|
|
||||||
};
|
|
||||||
|
|
||||||
const { recipients } = await createEnvelopeRecipients({
|
|
||||||
userId,
|
|
||||||
teamId,
|
|
||||||
id: envelopeId,
|
|
||||||
recipients: recipientsToCreateFiltered,
|
|
||||||
requestMetadata,
|
|
||||||
});
|
|
||||||
|
|
||||||
return recipients;
|
|
||||||
})
|
|
||||||
.otherwise(() => {
|
|
||||||
throw new AppError(AppErrorCode.INVALID_BODY, {
|
|
||||||
message: `Invalid envelope type: ${envelope.type}`,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return [...existingRecipients, ...newRecipients];
|
|
||||||
};
|
|
||||||
@ -23,7 +23,5 @@ export const normalizePdf = async (pdf: Buffer) => {
|
|||||||
await flattenForm(pdfDoc);
|
await flattenForm(pdfDoc);
|
||||||
flattenAnnotations(pdfDoc);
|
flattenAnnotations(pdfDoc);
|
||||||
|
|
||||||
const normalizedPdfBytes = await pdfDoc.save();
|
return Buffer.from(await pdfDoc.save());
|
||||||
|
|
||||||
return Buffer.from(normalizedPdfBytes);
|
|
||||||
};
|
};
|
||||||
|
|||||||
74
packages/trpc/server/document-router/get-documents-by-ids.ts
Normal file
74
packages/trpc/server/document-router/get-documents-by-ids.ts
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
import { EnvelopeType } from '@prisma/client';
|
||||||
|
|
||||||
|
import { getEnvelopeWhereInput } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
|
||||||
|
import { mapEnvelopesToDocumentMany } from '@documenso/lib/utils/document';
|
||||||
|
import { mapDocumentIdToSecondaryId } from '@documenso/lib/utils/envelope';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
|
import { authenticatedProcedure } from '../trpc';
|
||||||
|
import {
|
||||||
|
ZGetDocumentsByIdsRequestSchema,
|
||||||
|
ZGetDocumentsByIdsResponseSchema,
|
||||||
|
getDocumentsByIdsMeta,
|
||||||
|
} from './get-documents-by-ids.types';
|
||||||
|
|
||||||
|
export const getDocumentsByIdsRoute = authenticatedProcedure
|
||||||
|
.meta(getDocumentsByIdsMeta)
|
||||||
|
.input(ZGetDocumentsByIdsRequestSchema)
|
||||||
|
.output(ZGetDocumentsByIdsResponseSchema)
|
||||||
|
.mutation(async ({ input, ctx }) => {
|
||||||
|
const { teamId, user } = ctx;
|
||||||
|
const { documentIds } = input;
|
||||||
|
|
||||||
|
ctx.logger.info({
|
||||||
|
input: {
|
||||||
|
documentIds,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const { envelopeWhereInput } = await getEnvelopeWhereInput({
|
||||||
|
id: {
|
||||||
|
type: 'documentId',
|
||||||
|
id: documentIds[0],
|
||||||
|
},
|
||||||
|
userId: user.id,
|
||||||
|
teamId,
|
||||||
|
type: EnvelopeType.DOCUMENT,
|
||||||
|
});
|
||||||
|
|
||||||
|
const envelopeOrInput = envelopeWhereInput.OR!;
|
||||||
|
|
||||||
|
const secondaryIds = documentIds.map((documentId) => mapDocumentIdToSecondaryId(documentId));
|
||||||
|
|
||||||
|
const envelopes = await prisma.envelope.findMany({
|
||||||
|
where: {
|
||||||
|
type: EnvelopeType.DOCUMENT,
|
||||||
|
secondaryId: {
|
||||||
|
in: secondaryIds,
|
||||||
|
},
|
||||||
|
OR: envelopeOrInput,
|
||||||
|
},
|
||||||
|
include: {
|
||||||
|
user: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
name: true,
|
||||||
|
email: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
recipients: {
|
||||||
|
orderBy: {
|
||||||
|
id: 'asc',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
team: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
url: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
return envelopes.map((envelope) => mapEnvelopesToDocumentMany(envelope));
|
||||||
|
});
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
import { z } from 'zod';
|
||||||
|
|
||||||
|
import { ZDocumentManySchema } from '@documenso/lib/types/document';
|
||||||
|
|
||||||
|
import type { TrpcRouteMeta } from '../trpc';
|
||||||
|
|
||||||
|
export const getDocumentsByIdsMeta: TrpcRouteMeta = {
|
||||||
|
openapi: {
|
||||||
|
method: 'POST',
|
||||||
|
path: '/document/get-many',
|
||||||
|
summary: 'Get multiple documents',
|
||||||
|
description: 'Retrieve multiple documents by their IDs',
|
||||||
|
tags: ['Document'],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const ZGetDocumentsByIdsRequestSchema = z.object({
|
||||||
|
documentIds: z.array(z.number()).min(1),
|
||||||
|
});
|
||||||
|
|
||||||
|
export const ZGetDocumentsByIdsResponseSchema = z.array(ZDocumentManySchema);
|
||||||
|
|
||||||
|
export type TGetDocumentsByIdsRequest = z.infer<typeof ZGetDocumentsByIdsRequestSchema>;
|
||||||
|
export type TGetDocumentsByIdsResponse = z.infer<typeof ZGetDocumentsByIdsResponseSchema>;
|
||||||
@ -19,6 +19,7 @@ import { findDocumentsInternalRoute } from './find-documents-internal';
|
|||||||
import { findInboxRoute } from './find-inbox';
|
import { findInboxRoute } from './find-inbox';
|
||||||
import { getDocumentRoute } from './get-document';
|
import { getDocumentRoute } from './get-document';
|
||||||
import { getDocumentByTokenRoute } from './get-document-by-token';
|
import { getDocumentByTokenRoute } from './get-document-by-token';
|
||||||
|
import { getDocumentsByIdsRoute } from './get-documents-by-ids';
|
||||||
import { getInboxCountRoute } from './get-inbox-count';
|
import { getInboxCountRoute } from './get-inbox-count';
|
||||||
import { redistributeDocumentRoute } from './redistribute-document';
|
import { redistributeDocumentRoute } from './redistribute-document';
|
||||||
import { searchDocumentRoute } from './search-document';
|
import { searchDocumentRoute } from './search-document';
|
||||||
@ -27,6 +28,7 @@ import { updateDocumentRoute } from './update-document';
|
|||||||
|
|
||||||
export const documentRouter = router({
|
export const documentRouter = router({
|
||||||
get: getDocumentRoute,
|
get: getDocumentRoute,
|
||||||
|
getMany: getDocumentsByIdsRoute,
|
||||||
find: findDocumentsRoute,
|
find: findDocumentsRoute,
|
||||||
create: createDocumentRoute,
|
create: createDocumentRoute,
|
||||||
update: updateDocumentRoute,
|
update: updateDocumentRoute,
|
||||||
|
|||||||
93
packages/trpc/server/envelope-router/get-envelopes-by-ids.ts
Normal file
93
packages/trpc/server/envelope-router/get-envelopes-by-ids.ts
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
import { getEnvelopeWhereInput } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
|
import { authenticatedProcedure } from '../trpc';
|
||||||
|
import {
|
||||||
|
ZGetEnvelopesByIdsRequestSchema,
|
||||||
|
ZGetEnvelopesByIdsResponseSchema,
|
||||||
|
getEnvelopesByIdsMeta,
|
||||||
|
} from './get-envelopes-by-ids.types';
|
||||||
|
|
||||||
|
export const getEnvelopesByIdsRoute = authenticatedProcedure
|
||||||
|
.meta(getEnvelopesByIdsMeta)
|
||||||
|
.input(ZGetEnvelopesByIdsRequestSchema)
|
||||||
|
.output(ZGetEnvelopesByIdsResponseSchema)
|
||||||
|
.mutation(async ({ input, ctx }) => {
|
||||||
|
const { teamId, user } = ctx;
|
||||||
|
const { envelopeIds } = input;
|
||||||
|
|
||||||
|
ctx.logger.info({
|
||||||
|
input: {
|
||||||
|
envelopeIds,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const { envelopeWhereInput } = await getEnvelopeWhereInput({
|
||||||
|
id: {
|
||||||
|
type: 'envelopeId',
|
||||||
|
id: envelopeIds[0],
|
||||||
|
},
|
||||||
|
userId: user.id,
|
||||||
|
teamId,
|
||||||
|
type: null,
|
||||||
|
});
|
||||||
|
|
||||||
|
const envelopeOrInput = envelopeWhereInput.OR!;
|
||||||
|
|
||||||
|
const envelopes = await prisma.envelope.findMany({
|
||||||
|
where: {
|
||||||
|
id: {
|
||||||
|
in: envelopeIds,
|
||||||
|
},
|
||||||
|
OR: envelopeOrInput,
|
||||||
|
},
|
||||||
|
include: {
|
||||||
|
envelopeItems: {
|
||||||
|
include: {
|
||||||
|
documentData: true,
|
||||||
|
},
|
||||||
|
orderBy: {
|
||||||
|
order: 'asc',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
folder: true,
|
||||||
|
documentMeta: true,
|
||||||
|
user: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
name: true,
|
||||||
|
email: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
recipients: {
|
||||||
|
orderBy: {
|
||||||
|
id: 'asc',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
fields: true,
|
||||||
|
team: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
url: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
directLink: {
|
||||||
|
select: {
|
||||||
|
directTemplateRecipientId: true,
|
||||||
|
enabled: true,
|
||||||
|
id: true,
|
||||||
|
token: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
return envelopes.map((envelope) => ({
|
||||||
|
...envelope,
|
||||||
|
user: {
|
||||||
|
id: envelope.user.id,
|
||||||
|
name: envelope.user.name || '',
|
||||||
|
email: envelope.user.email,
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
});
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
import { z } from 'zod';
|
||||||
|
|
||||||
|
import { ZEnvelopeSchema } from '@documenso/lib/types/envelope';
|
||||||
|
|
||||||
|
import type { TrpcRouteMeta } from '../trpc';
|
||||||
|
|
||||||
|
export const getEnvelopesByIdsMeta: TrpcRouteMeta = {
|
||||||
|
openapi: {
|
||||||
|
method: 'POST',
|
||||||
|
path: '/envelope/get-many',
|
||||||
|
summary: 'Get multiple envelopes',
|
||||||
|
description: 'Retrieve multiple envelopes by their IDs',
|
||||||
|
tags: ['Envelope'],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const ZGetEnvelopesByIdsRequestSchema = z.object({
|
||||||
|
envelopeIds: z.array(z.string()).min(1),
|
||||||
|
});
|
||||||
|
|
||||||
|
export const ZGetEnvelopesByIdsResponseSchema = z.array(ZEnvelopeSchema);
|
||||||
|
|
||||||
|
export type TGetEnvelopesByIdsRequest = z.infer<typeof ZGetEnvelopesByIdsRequestSchema>;
|
||||||
|
export type TGetEnvelopesByIdsResponse = z.infer<typeof ZGetEnvelopesByIdsResponseSchema>;
|
||||||
@ -21,6 +21,7 @@ import { updateEnvelopeRecipientsRoute } from './envelope-recipients/update-enve
|
|||||||
import { getEnvelopeRoute } from './get-envelope';
|
import { getEnvelopeRoute } from './get-envelope';
|
||||||
import { getEnvelopeItemsRoute } from './get-envelope-items';
|
import { getEnvelopeItemsRoute } from './get-envelope-items';
|
||||||
import { getEnvelopeItemsByTokenRoute } from './get-envelope-items-by-token';
|
import { getEnvelopeItemsByTokenRoute } from './get-envelope-items-by-token';
|
||||||
|
import { getEnvelopesByIdsRoute } from './get-envelopes-by-ids';
|
||||||
import { redistributeEnvelopeRoute } from './redistribute-envelope';
|
import { redistributeEnvelopeRoute } from './redistribute-envelope';
|
||||||
import { setEnvelopeFieldsRoute } from './set-envelope-fields';
|
import { setEnvelopeFieldsRoute } from './set-envelope-fields';
|
||||||
import { setEnvelopeRecipientsRoute } from './set-envelope-recipients';
|
import { setEnvelopeRecipientsRoute } from './set-envelope-recipients';
|
||||||
@ -66,6 +67,7 @@ export const envelopeRouter = router({
|
|||||||
sign: signEnvelopeFieldRoute,
|
sign: signEnvelopeFieldRoute,
|
||||||
},
|
},
|
||||||
get: getEnvelopeRoute,
|
get: getEnvelopeRoute,
|
||||||
|
getMany: getEnvelopesByIdsRoute,
|
||||||
create: createEnvelopeRoute,
|
create: createEnvelopeRoute,
|
||||||
use: useEnvelopeRoute,
|
use: useEnvelopeRoute,
|
||||||
update: updateEnvelopeRoute,
|
update: updateEnvelopeRoute,
|
||||||
|
|||||||
127
packages/trpc/server/template-router/get-templates-by-ids.ts
Normal file
127
packages/trpc/server/template-router/get-templates-by-ids.ts
Normal file
@ -0,0 +1,127 @@
|
|||||||
|
import { EnvelopeType } from '@prisma/client';
|
||||||
|
|
||||||
|
import { getEnvelopeWhereInput } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
|
||||||
|
import {
|
||||||
|
mapSecondaryIdToTemplateId,
|
||||||
|
mapTemplateIdToSecondaryId,
|
||||||
|
} from '@documenso/lib/utils/envelope';
|
||||||
|
import { mapFieldToLegacyField } from '@documenso/lib/utils/fields';
|
||||||
|
import { mapRecipientToLegacyRecipient } from '@documenso/lib/utils/recipients';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
|
import { authenticatedProcedure } from '../trpc';
|
||||||
|
import {
|
||||||
|
ZGetTemplatesByIdsRequestSchema,
|
||||||
|
ZGetTemplatesByIdsResponseSchema,
|
||||||
|
getTemplatesByIdsMeta,
|
||||||
|
} from './get-templates-by-ids.types';
|
||||||
|
|
||||||
|
export const getTemplatesByIdsRoute = authenticatedProcedure
|
||||||
|
.meta(getTemplatesByIdsMeta)
|
||||||
|
.input(ZGetTemplatesByIdsRequestSchema)
|
||||||
|
.output(ZGetTemplatesByIdsResponseSchema)
|
||||||
|
.mutation(async ({ input, ctx }) => {
|
||||||
|
const { teamId, user } = ctx;
|
||||||
|
const { templateIds } = input;
|
||||||
|
|
||||||
|
ctx.logger.info({
|
||||||
|
input: {
|
||||||
|
templateIds,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const { envelopeWhereInput } = await getEnvelopeWhereInput({
|
||||||
|
id: {
|
||||||
|
type: 'templateId',
|
||||||
|
id: templateIds[0],
|
||||||
|
},
|
||||||
|
userId: user.id,
|
||||||
|
teamId,
|
||||||
|
type: EnvelopeType.TEMPLATE,
|
||||||
|
});
|
||||||
|
|
||||||
|
const envelopeOrInput = envelopeWhereInput.OR!;
|
||||||
|
|
||||||
|
const secondaryIds = templateIds.map((templateId) => mapTemplateIdToSecondaryId(templateId));
|
||||||
|
|
||||||
|
const envelopes = await prisma.envelope.findMany({
|
||||||
|
where: {
|
||||||
|
type: EnvelopeType.TEMPLATE,
|
||||||
|
secondaryId: {
|
||||||
|
in: secondaryIds,
|
||||||
|
},
|
||||||
|
OR: envelopeOrInput,
|
||||||
|
},
|
||||||
|
include: {
|
||||||
|
recipients: {
|
||||||
|
orderBy: {
|
||||||
|
id: 'asc',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
fields: true,
|
||||||
|
team: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
url: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
documentMeta: {
|
||||||
|
select: {
|
||||||
|
signingOrder: true,
|
||||||
|
distributionMethod: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
directLink: {
|
||||||
|
select: {
|
||||||
|
token: true,
|
||||||
|
enabled: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
return envelopes.map((envelope) => {
|
||||||
|
const legacyTemplateId = mapSecondaryIdToTemplateId(envelope.secondaryId);
|
||||||
|
|
||||||
|
return {
|
||||||
|
id: legacyTemplateId,
|
||||||
|
envelopeId: envelope.id,
|
||||||
|
type: envelope.templateType,
|
||||||
|
visibility: envelope.visibility,
|
||||||
|
externalId: envelope.externalId,
|
||||||
|
title: envelope.title,
|
||||||
|
userId: envelope.userId,
|
||||||
|
teamId: envelope.teamId,
|
||||||
|
authOptions: envelope.authOptions,
|
||||||
|
createdAt: envelope.createdAt,
|
||||||
|
updatedAt: envelope.updatedAt,
|
||||||
|
publicTitle: envelope.publicTitle,
|
||||||
|
publicDescription: envelope.publicDescription,
|
||||||
|
folderId: envelope.folderId,
|
||||||
|
useLegacyFieldInsertion: envelope.useLegacyFieldInsertion,
|
||||||
|
team: envelope.team
|
||||||
|
? {
|
||||||
|
id: envelope.team.id,
|
||||||
|
url: envelope.team.url,
|
||||||
|
}
|
||||||
|
: null,
|
||||||
|
fields: envelope.fields.map((field) => mapFieldToLegacyField(field, envelope)),
|
||||||
|
recipients: envelope.recipients.map((recipient) =>
|
||||||
|
mapRecipientToLegacyRecipient(recipient, envelope),
|
||||||
|
),
|
||||||
|
templateMeta: envelope.documentMeta
|
||||||
|
? {
|
||||||
|
signingOrder: envelope.documentMeta.signingOrder,
|
||||||
|
distributionMethod: envelope.documentMeta.distributionMethod,
|
||||||
|
}
|
||||||
|
: null,
|
||||||
|
directLink: envelope.directLink
|
||||||
|
? {
|
||||||
|
token: envelope.directLink.token,
|
||||||
|
enabled: envelope.directLink.enabled,
|
||||||
|
}
|
||||||
|
: null,
|
||||||
|
templateDocumentDataId: '', // Backwards compatibility.
|
||||||
|
};
|
||||||
|
});
|
||||||
|
});
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
import { z } from 'zod';
|
||||||
|
|
||||||
|
import { ZTemplateManySchema } from '@documenso/lib/types/template';
|
||||||
|
|
||||||
|
import type { TrpcRouteMeta } from '../trpc';
|
||||||
|
|
||||||
|
export const getTemplatesByIdsMeta: TrpcRouteMeta = {
|
||||||
|
openapi: {
|
||||||
|
method: 'POST',
|
||||||
|
path: '/template/get-many',
|
||||||
|
summary: 'Get multiple templates',
|
||||||
|
description: 'Retrieve multiple templates by their IDs',
|
||||||
|
tags: ['Template'],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const ZGetTemplatesByIdsRequestSchema = z.object({
|
||||||
|
templateIds: z.array(z.number()).min(1),
|
||||||
|
});
|
||||||
|
|
||||||
|
export const ZGetTemplatesByIdsResponseSchema = z.array(ZTemplateManySchema);
|
||||||
|
|
||||||
|
export type TGetTemplatesByIdsRequest = z.infer<typeof ZGetTemplatesByIdsRequestSchema>;
|
||||||
|
export type TGetTemplatesByIdsResponse = z.infer<typeof ZGetTemplatesByIdsResponseSchema>;
|
||||||
@ -30,6 +30,7 @@ import { mapEnvelopeToTemplateLite } from '@documenso/lib/utils/templates';
|
|||||||
|
|
||||||
import { ZGenericSuccessResponse, ZSuccessResponseSchema } from '../schema';
|
import { ZGenericSuccessResponse, ZSuccessResponseSchema } from '../schema';
|
||||||
import { authenticatedProcedure, maybeAuthenticatedProcedure, router } from '../trpc';
|
import { authenticatedProcedure, maybeAuthenticatedProcedure, router } from '../trpc';
|
||||||
|
import { getTemplatesByIdsRoute } from './get-templates-by-ids';
|
||||||
import {
|
import {
|
||||||
ZBulkSendTemplateMutationSchema,
|
ZBulkSendTemplateMutationSchema,
|
||||||
ZCreateDocumentFromDirectTemplateRequestSchema,
|
ZCreateDocumentFromDirectTemplateRequestSchema,
|
||||||
@ -154,6 +155,11 @@ export const templateRouter = router({
|
|||||||
});
|
});
|
||||||
}),
|
}),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
getMany: getTemplatesByIdsRoute,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wait until RR7 so we can passthrough documents.
|
* Wait until RR7 so we can passthrough documents.
|
||||||
*
|
*
|
||||||
|
|||||||
Reference in New Issue
Block a user