Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-12 15:53:02 +10:00
Code Issues Packages Projects Releases Wiki Activity

feat: add envelopes (#2025)

Browse Source 
This PR is handles the changes required to support envelopes. The new
envelope editor/signing page will be hidden during release.

The core changes here is to migrate the documents and templates model to
a centralized envelopes model.

Even though Documents and Templates are removed, from the user
perspective they will still exist as we remap envelopes to documents and
templates.
This commit is contained in:
David Nguyen
2025-10-14 21:56:36 +11:00
committed by GitHub
parent 7b17156e56
commit 7f09ba72f4
447 changed files with 33467 additions and 9622 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
packages/prisma/migrations/20250918070643_remove_template_metadata/migration.sql Normal file
View File

@ -0,0 +1,57 @@
-- DropForeignKey
ALTER TABLE "TemplateMeta" DROP CONSTRAINT "TemplateMeta_templateId_fkey";
-- AlterTable
ALTER TABLE "DocumentMeta" ADD COLUMN "templateId" INTEGER,
ALTER COLUMN "documentId" DROP NOT NULL;
-- [CUSTOM_CHANGE] Migrate existing TemplateMeta to DocumentMeta
INSERT INTO "DocumentMeta" (
"id",
"subject",
"message",
"timezone",
"password",
"dateFormat",
"redirectUrl",
"signingOrder",
"allowDictateNextSigner",
"typedSignatureEnabled",
"uploadSignatureEnabled",
"drawSignatureEnabled",
"language",
"distributionMethod",
"emailSettings",
"emailReplyTo",
"emailId",
"templateId"
)
SELECT
gen_random_uuid()::text, -- Generate new CUID-like IDs to avoid collisions
"subject",
"message",
"timezone",
"password",
"dateFormat",
"redirectUrl",
"signingOrder",
"allowDictateNextSigner",
"typedSignatureEnabled",
"uploadSignatureEnabled",
"drawSignatureEnabled",
"language",
"distributionMethod",
"emailSettings",
"emailReplyTo",
"emailId",
"templateId"
FROM "TemplateMeta";
-- DropTable
DROP TABLE "TemplateMeta";
-- CreateIndex
CREATE UNIQUE INDEX "DocumentMeta_templateId_key" ON "DocumentMeta"("templateId");
-- AddForeignKey
ALTER TABLE "DocumentMeta" ADD CONSTRAINT "DocumentMeta_templateId_fkey" FOREIGN KEY ("templateId") REFERENCES "Template"("id") ON DELETE CASCADE ON UPDATE CASCADE;

470
packages/prisma/migrations/20250918070645_add_envelopes/migration.sql Normal file
View File

@ -0,0 +1,470 @@
/*
Warnings:
- You are about to drop the column `documentId` on the `DocumentAuditLog` table. All the data in the column will be lost.
- You are about to drop the column `documentId` on the `DocumentMeta` table. All the data in the column will be lost.
- You are about to drop the column `password` on the `DocumentMeta` table. All the data in the column will be lost.
- You are about to drop the column `templateId` on the `DocumentMeta` table. All the data in the column will be lost.
- You are about to drop the column `documentId` on the `DocumentShareLink` table. All the data in the column will be lost.
- You are about to drop the column `documentId` on the `Field` table. All the data in the column will be lost.
- You are about to drop the column `templateId` on the `Field` table. All the data in the column will be lost.
- You are about to drop the column `documentId` on the `Recipient` table. All the data in the column will be lost.
- You are about to drop the column `templateId` on the `Recipient` table. All the data in the column will be lost.
- You are about to drop the column `templateId` on the `TemplateDirectLink` table. All the data in the column will be lost.
- You are about to drop the `Document` table. If the table is not empty, all the data it contains will be lost.
- You are about to drop the `Template` table. If the table is not empty, all the data it contains will be lost.
- A unique constraint covering the columns `[envelopeId,email]` on the table `DocumentShareLink` will be added. If there are existing duplicate values, this will fail.
- A unique constraint covering the columns `[envelopeId,email]` on the table `Recipient` will be added. If there are existing duplicate values, this will fail.
- A unique constraint covering the columns `[envelopeId]` on the table `TemplateDirectLink` will be added. If there are existing duplicate values, this will fail.
- Added the required column `envelopeId` to the `DocumentAuditLog` table without a default value. This is not possible if the table is not empty.
- Added the required column `envelopeId` to the `DocumentShareLink` table without a default value. This is not possible if the table is not empty.
- Added the required column `envelopeId` to the `Field` table without a default value. This is not possible if the table is not empty.
- Added the required column `envelopeItemId` to the `Field` table without a default value. This is not possible if the table is not empty.
- Added the required column `envelopeId` to the `Recipient` table without a default value. This is not possible if the table is not empty.
- Added the required column `envelopeId` to the `TemplateDirectLink` table without a default value. This is not possible if the table is not empty.
*/
-- CreateEnum
CREATE TYPE "EnvelopeType" AS ENUM ('DOCUMENT', 'TEMPLATE');
-- DropForeignKey
ALTER TABLE "Document" DROP CONSTRAINT "Document_documentDataId_fkey";
-- DropForeignKey
ALTER TABLE "Document" DROP CONSTRAINT "Document_folderId_fkey";
-- DropForeignKey
ALTER TABLE "Document" DROP CONSTRAINT "Document_teamId_fkey";
-- DropForeignKey
ALTER TABLE "Document" DROP CONSTRAINT "Document_templateId_fkey";
-- DropForeignKey
ALTER TABLE "Document" DROP CONSTRAINT "Document_userId_fkey";
-- DropForeignKey
ALTER TABLE "DocumentAuditLog" DROP CONSTRAINT "DocumentAuditLog_documentId_fkey";
-- DropForeignKey
ALTER TABLE "DocumentMeta" DROP CONSTRAINT "DocumentMeta_documentId_fkey";
-- DropForeignKey
ALTER TABLE "DocumentMeta" DROP CONSTRAINT "DocumentMeta_templateId_fkey";
-- DropForeignKey
ALTER TABLE "DocumentShareLink" DROP CONSTRAINT "DocumentShareLink_documentId_fkey";
-- DropForeignKey
ALTER TABLE "Field" DROP CONSTRAINT "Field_documentId_fkey";
-- DropForeignKey
ALTER TABLE "Field" DROP CONSTRAINT "Field_templateId_fkey";
-- DropForeignKey
ALTER TABLE "Recipient" DROP CONSTRAINT "Recipient_documentId_fkey";
-- DropForeignKey
ALTER TABLE "Recipient" DROP CONSTRAINT "Recipient_templateId_fkey";
-- DropForeignKey
ALTER TABLE "Template" DROP CONSTRAINT "Template_folderId_fkey";
-- DropForeignKey
ALTER TABLE "Template" DROP CONSTRAINT "Template_teamId_fkey";
-- DropForeignKey
ALTER TABLE "Template" DROP CONSTRAINT "Template_templateDocumentDataId_fkey";
-- DropForeignKey
ALTER TABLE "Template" DROP CONSTRAINT "Template_userId_fkey";
-- DropForeignKey
ALTER TABLE "TemplateDirectLink" DROP CONSTRAINT "TemplateDirectLink_templateId_fkey";
-- DropIndex
DROP INDEX "DocumentMeta_documentId_key";
-- DropIndex
DROP INDEX "DocumentMeta_templateId_key";
-- DropIndex
DROP INDEX "DocumentShareLink_documentId_email_key";
-- DropIndex
DROP INDEX "Field_documentId_idx";
-- DropIndex
DROP INDEX "Field_templateId_idx";
-- DropIndex
DROP INDEX "Recipient_documentId_idx";
-- DropIndex
DROP INDEX "Recipient_templateId_idx";
-- DropIndex
DROP INDEX "TemplateDirectLink_templateId_key";
-- [CUSTOM_CHANGE] Create DocumentMeta records for Documents that don't have them
INSERT INTO "DocumentMeta" ("id", "documentId")
SELECT
gen_random_uuid(),
id
FROM "Document"
WHERE "id" NOT IN (SELECT "documentId" FROM "DocumentMeta" WHERE "documentId" IS NOT NULL);
-- [CUSTOM_CHANGE] Create DocumentMeta records for Templates that don't have them
INSERT INTO "DocumentMeta" ("id", "templateId")
SELECT
gen_random_uuid(),
id
FROM "Template"
WHERE "id" NOT IN (SELECT "templateId" FROM "DocumentMeta" WHERE "templateId" IS NOT NULL);
-- AlterTable
ALTER TABLE "DocumentAuditLog" ADD COLUMN "envelopeId" TEXT;
-- AlterTable
ALTER TABLE "DocumentShareLink" ADD COLUMN "envelopeId" TEXT;
-- AlterTable
ALTER TABLE "Field" ADD COLUMN "envelopeId" TEXT,
ADD COLUMN "envelopeItemId" TEXT;
-- AlterTable
ALTER TABLE "Recipient" ADD COLUMN "envelopeId" TEXT;
-- AlterTable
ALTER TABLE "TemplateDirectLink" ADD COLUMN "envelopeId" TEXT;
-- CreateTable
CREATE TABLE "Envelope" (
"id" TEXT NOT NULL,
"secondaryId" TEXT NOT NULL,
"externalId" TEXT,
"type" "EnvelopeType" NOT NULL,
"createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updatedAt" TIMESTAMP(3) NOT NULL,
"completedAt" TIMESTAMP(3),
"deletedAt" TIMESTAMP(3),
"title" TEXT NOT NULL,
"status" "DocumentStatus" NOT NULL DEFAULT 'DRAFT',
"source" "DocumentSource" NOT NULL,
"qrToken" TEXT,
"internalVersion" INTEGER NOT NULL,
"useLegacyFieldInsertion" BOOLEAN NOT NULL DEFAULT false,
"authOptions" JSONB,
"formValues" JSONB,
"visibility" "DocumentVisibility" NOT NULL DEFAULT 'EVERYONE',
"templateType" "TemplateType" NOT NULL DEFAULT 'PRIVATE',
"publicTitle" TEXT NOT NULL DEFAULT '',
"publicDescription" TEXT NOT NULL DEFAULT '',
"templateId" INTEGER,
"userId" INTEGER NOT NULL,
"teamId" INTEGER NOT NULL,
"folderId" TEXT,
"documentMetaId" TEXT NOT NULL,
CONSTRAINT "Envelope_pkey" PRIMARY KEY ("id")
);
-- CreateTable
CREATE TABLE "EnvelopeItem" (
"id" TEXT NOT NULL,
"title" TEXT NOT NULL,
"documentDataId" TEXT NOT NULL,
"envelopeId" TEXT NOT NULL,
"order" INTEGER NOT NULL,
CONSTRAINT "EnvelopeItem_pkey" PRIMARY KEY ("id")
);
-- CreateTable
CREATE TABLE "Counter" (
"id" TEXT NOT NULL,
"value" INTEGER NOT NULL,
CONSTRAINT "Counter_pkey" PRIMARY KEY ("id")
);
-- [CUSTOM_CHANGE] Initialize Counter table for document and template IDs
INSERT INTO "Counter" ("id", "value") VALUES ('document', (SELECT COALESCE(MAX("id"), 0) FROM "Document"));
INSERT INTO "Counter" ("id", "value") VALUES ('template', (SELECT COALESCE(MAX("id"), 0) FROM "Template"));
-- [CUSTOM_CHANGE] Migrate Documents to Envelopes
INSERT INTO "Envelope" (
"id",
"secondaryId",
"externalId",
"type",
"createdAt",
"updatedAt",
"completedAt",
"deletedAt",
"title",
"status",
"source",
"qrToken",
"internalVersion",
"useLegacyFieldInsertion",
"authOptions",
"formValues",
"visibility",
"templateType",
"publicTitle",
"publicDescription",
"templateId",
"userId",
"teamId",
"folderId",
"documentMetaId"
)
SELECT
generate_prefix_id('envelope'),
'document_' || d."id", -- Create legacy ID for documents
d."externalId",
'DOCUMENT'::"EnvelopeType",
d."createdAt",
d."updatedAt",
d."completedAt",
d."deletedAt",
d."title",
d."status",
d."source",
d."qrToken",
1,
d."useLegacyFieldInsertion",
d."authOptions",
d."formValues",
d."visibility",
'PRIVATE',
'',
'',
d."templateId",
d."userId",
d."teamId",
d."folderId",
dm."id"
FROM "Document" d
LEFT JOIN "DocumentMeta" dm ON dm."documentId" = d."id";
-- [CUSTOM_CHANGE] Migrate Templates to Envelopes
INSERT INTO "Envelope" (
"id",
"secondaryId",
"externalId",
"type",
"createdAt",
"updatedAt",
"completedAt",
"deletedAt",
"title",
"status",
"source",
"qrToken",
"internalVersion",
"useLegacyFieldInsertion",
"authOptions",
"formValues",
"visibility",
"templateType",
"publicTitle",
"publicDescription",
"templateId",
"userId",
"teamId",
"folderId",
"documentMetaId"
)
SELECT
generate_prefix_id('envelope'),
'template_' || t."id", -- Create legacy ID for templates
t."externalId",
'TEMPLATE'::"EnvelopeType",
t."createdAt",
t."updatedAt",
NULL,
NULL,
t."title",
'DRAFT',
'TEMPLATE'::"DocumentSource",
NULL,
1,
t."useLegacyFieldInsertion",
t."authOptions",
NULL,
t."visibility",
t."type",
t."publicTitle",
t."publicDescription",
NULL,
t."userId",
t."teamId",
t."folderId",
dm."id"
FROM "Template" t
LEFT JOIN "DocumentMeta" dm ON dm."templateId" = t."id";
-- [CUSTOM_CHANGE] Create EnvelopeItems for Documents
INSERT INTO "EnvelopeItem" ("id", "title", "documentDataId", "envelopeId", "order")
SELECT
generate_prefix_id('envelope_item'),
d."title",
d."documentDataId",
e."id",
1
FROM "Document" d
JOIN "Envelope" e ON e."secondaryId" = 'document_' || d."id";
-- [CUSTOM_CHANGE] Create EnvelopeItems for Templates
INSERT INTO "EnvelopeItem" ("id", "title", "documentDataId", "envelopeId", "order")
SELECT
generate_prefix_id('envelope_item'),
t."title",
t."templateDocumentDataId",
e."id",
1
FROM "Template" t
JOIN "Envelope" e ON e."secondaryId" = 'template_' || t."id";
-- [CUSTOM_CHANGE] Update DocumentAuditLog with envelope IDs
UPDATE "DocumentAuditLog"
SET "envelopeId" = e."id"
FROM "Document" d
JOIN "Envelope" e ON e."secondaryId" = 'document_' || d."id"
WHERE "DocumentAuditLog"."documentId" = d."id";
-- [CUSTOM_CHANGE] Update Recipients for Documents
UPDATE "Recipient"
SET "envelopeId" = e."id"
FROM "Document" d
JOIN "Envelope" e ON e."secondaryId" = 'document_' || d."id"
WHERE "Recipient"."documentId" = d."id";
-- [CUSTOM_CHANGE] Update Recipients for Templates
UPDATE "Recipient"
SET "envelopeId" = e."id"
FROM "Template" t
JOIN "Envelope" e ON e."secondaryId" = 'template_' || t."id"
WHERE "Recipient"."templateId" = t."id";
-- [CUSTOM_CHANGE] Update Fields for Documents
UPDATE "Field"
SET "envelopeId" = e."id", "envelopeItemId" = ei."id"
FROM "Document" d
JOIN "Envelope" e ON e."secondaryId" = 'document_' || d."id"
JOIN "EnvelopeItem" ei ON ei."envelopeId" = e."id"
WHERE "Field"."documentId" = d."id";
-- [CUSTOM_CHANGE] Update Fields for Templates
UPDATE "Field"
SET "envelopeId" = e."id", "envelopeItemId" = ei."id"
FROM "Template" t
JOIN "Envelope" e ON e."secondaryId" = 'template_' || t."id"
JOIN "EnvelopeItem" ei ON ei."envelopeId" = e."id"
WHERE "Field"."templateId" = t."id";
-- [CUSTOM_CHANGE] Update DocumentShareLink
UPDATE "DocumentShareLink"
SET "envelopeId" = e."id"
FROM "Document" d
JOIN "Envelope" e ON e."secondaryId" = 'document_' || d."id"
WHERE "DocumentShareLink"."documentId" = d."id";
-- [CUSTOM_CHANGE] Update TemplateDirectLink
UPDATE "TemplateDirectLink"
SET "envelopeId" = e."id"
FROM "Template" t
JOIN "Envelope" e ON e."secondaryId" = 'template_' || t."id"
WHERE "TemplateDirectLink"."templateId" = t."id";
-- DropTable
DROP TABLE "Document";
-- DropTable
DROP TABLE "Template";
-- AlterTable
ALTER TABLE "DocumentMeta" DROP COLUMN "documentId",
DROP COLUMN "password",
DROP COLUMN "templateId";
-- AlterTable
ALTER TABLE "DocumentAuditLog" DROP COLUMN "documentId",
ALTER COLUMN "envelopeId" SET NOT NULL;
-- AlterTable
ALTER TABLE "DocumentShareLink" DROP COLUMN "documentId",
ALTER COLUMN "envelopeId" SET NOT NULL;
-- AlterTable
ALTER TABLE "Field" DROP COLUMN "documentId",
DROP COLUMN "templateId",
ALTER COLUMN "envelopeId" SET NOT NULL,
ALTER COLUMN "envelopeItemId" SET NOT NULL;
-- AlterTable
ALTER TABLE "Recipient" DROP COLUMN "documentId",
DROP COLUMN "templateId",
ALTER COLUMN "envelopeId" SET NOT NULL;
-- AlterTable
ALTER TABLE "TemplateDirectLink" DROP COLUMN "templateId",
ALTER COLUMN "envelopeId" SET NOT NULL;
-- CreateIndex
CREATE UNIQUE INDEX "Envelope_secondaryId_key" ON "Envelope"("secondaryId");
-- CreateIndex
CREATE UNIQUE INDEX "Envelope_documentMetaId_key" ON "Envelope"("documentMetaId");
-- CreateIndex
CREATE UNIQUE INDEX "EnvelopeItem_documentDataId_key" ON "EnvelopeItem"("documentDataId");
-- CreateIndex
CREATE UNIQUE INDEX "DocumentShareLink_envelopeId_email_key" ON "DocumentShareLink"("envelopeId", "email");
-- CreateIndex
CREATE INDEX "Field_envelopeId_idx" ON "Field"("envelopeId");
-- CreateIndex
CREATE INDEX "Recipient_envelopeId_idx" ON "Recipient"("envelopeId");
-- CreateIndex
CREATE UNIQUE INDEX "TemplateDirectLink_envelopeId_key" ON "TemplateDirectLink"("envelopeId");
-- AddForeignKey
ALTER TABLE "Envelope" ADD CONSTRAINT "Envelope_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "Envelope" ADD CONSTRAINT "Envelope_teamId_fkey" FOREIGN KEY ("teamId") REFERENCES "Team"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "Envelope" ADD CONSTRAINT "Envelope_folderId_fkey" FOREIGN KEY ("folderId") REFERENCES "Folder"("id") ON DELETE SET NULL ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "Envelope" ADD CONSTRAINT "Envelope_documentMetaId_fkey" FOREIGN KEY ("documentMetaId") REFERENCES "DocumentMeta"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "EnvelopeItem" ADD CONSTRAINT "EnvelopeItem_documentDataId_fkey" FOREIGN KEY ("documentDataId") REFERENCES "DocumentData"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "EnvelopeItem" ADD CONSTRAINT "EnvelopeItem_envelopeId_fkey" FOREIGN KEY ("envelopeId") REFERENCES "Envelope"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "DocumentAuditLog" ADD CONSTRAINT "DocumentAuditLog_envelopeId_fkey" FOREIGN KEY ("envelopeId") REFERENCES "Envelope"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "Recipient" ADD CONSTRAINT "Recipient_envelopeId_fkey" FOREIGN KEY ("envelopeId") REFERENCES "Envelope"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "Field" ADD CONSTRAINT "Field_envelopeItemId_fkey" FOREIGN KEY ("envelopeItemId") REFERENCES "EnvelopeItem"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "Field" ADD CONSTRAINT "Field_envelopeId_fkey" FOREIGN KEY ("envelopeId") REFERENCES "Envelope"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "DocumentShareLink" ADD CONSTRAINT "DocumentShareLink_envelopeId_fkey" FOREIGN KEY ("envelopeId") REFERENCES "Envelope"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-- AddForeignKey
ALTER TABLE "TemplateDirectLink" ADD CONSTRAINT "TemplateDirectLink_envelopeId_fkey" FOREIGN KEY ("envelopeId") REFERENCES "Envelope"("id") ON DELETE CASCADE ON UPDATE CASCADE;

247
packages/prisma/schema.prisma
View File

@ -64,8 +64,7 @@ model User {
twoFactorBackupCodes String?
folders Folder[]
documents Document[]
templates Template[]
envelopes Envelope[]
verificationTokens VerificationToken[]
apiTokens ApiToken[]
@ -354,8 +353,7 @@ model Folder {
pinned Boolean @default(false)
parentId String?
parent Folder? @relation("FolderToFolder", fields: [parentId], references: [id], onDelete: Cascade)
documents Document[]
templates Template[]
envelopes Envelope[]
createdAt DateTime @default(now())
updatedAt DateTime @default(now()) @updatedAt
subfolders Folder[] @relation("FolderToFolder")
@ -368,53 +366,85 @@ model Folder {
@@index([type])
}
/// @zod.import(["import { ZDocumentAuthOptionsSchema } from '@documenso/lib/types/document-auth';", "import { ZDocumentFormValuesSchema } from '@documenso/lib/types/document-form-values';"])
model Document {
id Int @id @default(autoincrement())
qrToken String? /// @zod.string.describe("The token for viewing the document using the QR code on the certificate.")
externalId String? /// @zod.string.describe("A custom external ID you can use to identify the document.")
enum EnvelopeType {
DOCUMENT
TEMPLATE
}
/// @zod.import(["import { ZDocumentAuthOptionsSchema } from '@documenso/lib/types/document-auth';", "import { ZDocumentFormValuesSchema } from '@documenso/lib/types/document-form-values';"])
model Envelope {
id String @id
secondaryId String @unique
externalId String? /// @zod.string.describe("A custom external ID you can use to identify the document.")
type EnvelopeType
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
completedAt DateTime?
deletedAt DateTime?
title String
status DocumentStatus @default(DRAFT)
source DocumentSource
qrToken String? /// @zod.string.describe("The token for viewing the document using the QR code on the certificate.")
internalVersion Int
useLegacyFieldInsertion Boolean @default(false)
envelopeItems EnvelopeItem[]
recipients Recipient[]
fields Field[]
shareLinks DocumentShareLink[]
auditLogs DocumentAuditLog[]
// Envelope settings
authOptions Json? /// [DocumentAuthOptions] @zod.custom.use(ZDocumentAuthOptionsSchema)
formValues Json? /// [DocumentFormValues] @zod.custom.use(ZDocumentFormValuesSchema)
visibility DocumentVisibility @default(EVERYONE)
// Template specific fields.
templateType TemplateType @default(PRIVATE)
publicTitle String @default("")
publicDescription String @default("")
directLink TemplateDirectLink?
templateId Int?
// Relations
userId Int /// @zod.number.describe("The ID of the user that created this document.")
user User @relation(fields: [userId], references: [id], onDelete: Cascade)
teamId Int
team Team @relation(fields: [teamId], references: [id], onDelete: Cascade)
authOptions Json? /// [DocumentAuthOptions] @zod.custom.use(ZDocumentAuthOptionsSchema)
formValues Json? /// [DocumentFormValues] @zod.custom.use(ZDocumentFormValuesSchema)
visibility DocumentVisibility @default(EVERYONE)
title String
status DocumentStatus @default(DRAFT)
recipients Recipient[]
fields Field[]
shareLinks DocumentShareLink[]
folder Folder? @relation(fields: [folderId], references: [id], onDelete: SetNull)
folderId String?
documentMetaId String @unique
documentMeta DocumentMeta @relation(fields: [documentMetaId], references: [id])
}
model EnvelopeItem {
id String @id
title String
order Int
documentDataId String
documentMeta DocumentMeta?
createdAt DateTime @default(now())
updatedAt DateTime @default(now()) @updatedAt
completedAt DateTime?
deletedAt DateTime?
templateId Int?
source DocumentSource
documentData DocumentData @relation(fields: [documentDataId], references: [id], onDelete: Cascade)
useLegacyFieldInsertion Boolean @default(false)
envelopeId String
envelope Envelope @relation(fields: [envelopeId], references: [id], onDelete: Cascade)
documentData DocumentData @relation(fields: [documentDataId], references: [id], onDelete: Cascade)
template Template? @relation(fields: [templateId], references: [id], onDelete: SetNull)
auditLogs DocumentAuditLog[]
folder Folder? @relation(fields: [folderId], references: [id], onDelete: SetNull)
folderId String?
field Field[]
@@unique([documentDataId])
@@index([userId])
@@index([status])
@@index([folderId])
}
model DocumentAuditLog {
id String @id @default(cuid())
documentId Int
envelopeId String
createdAt DateTime @default(now())
type String
data Json
@ -426,7 +456,7 @@ model DocumentAuditLog {
userAgent String?
ipAddress String?
Document Document @relation(fields: [documentId], references: [id], onDelete: Cascade)
envelope Envelope @relation(fields: [envelopeId], references: [id], onDelete: Cascade)
}
enum DocumentDataType {
@ -441,12 +471,11 @@ enum DocumentSigningOrder {
}
model DocumentData {
id String @id @default(cuid())
type DocumentDataType
data String
initialData String
document Document?
template Template?
id String @id @default(cuid())
type DocumentDataType
data String
initialData String
envelopeItem EnvelopeItem?
}
enum DocumentDistributionMethod {
@ -460,10 +489,7 @@ model DocumentMeta {
subject String?
message String?
timezone String? @default("Etc/UTC") @db.Text
password String?
dateFormat String? @default("yyyy-MM-dd hh:mm a") @db.Text
documentId Int @unique
document Document @relation(fields: [documentId], references: [id], onDelete: Cascade)
redirectUrl String?
signingOrder DocumentSigningOrder @default(PARALLEL)
allowDictateNextSigner Boolean @default(false)
@ -478,6 +504,8 @@ model DocumentMeta {
emailSettings Json? /// [DocumentEmailSettings] @zod.custom.use(ZDocumentEmailSettingsSchema)
emailReplyTo String?
emailId String?
envelope Envelope?
}
enum ReadStatus {
@ -507,8 +535,7 @@ enum RecipientRole {
/// @zod.import(["import { ZRecipientAuthOptionsSchema } from '@documenso/lib/types/document-auth';"])
model Recipient {
id Int @id @default(autoincrement())
documentId Int?
templateId Int?
envelopeId String
email String @db.VarChar(255)
name String @default("") @db.VarChar(255)
token String
@ -522,13 +549,11 @@ model Recipient {
readStatus ReadStatus @default(NOT_OPENED)
signingStatus SigningStatus @default(NOT_SIGNED)
sendStatus SendStatus @default(NOT_SENT)
document Document? @relation(fields: [documentId], references: [id], onDelete: Cascade)
template Template? @relation(fields: [templateId], references: [id], onDelete: Cascade)
envelope Envelope @relation(fields: [envelopeId], references: [id], onDelete: Cascade)
fields Field[]
signatures Signature[]
@@index([documentId])
@@index([templateId])
@@index([envelopeId])
@@index([token])
}
@ -548,27 +573,26 @@ enum FieldType {
/// @zod.import(["import { ZFieldMetaNotOptionalSchema } from '@documenso/lib/types/field-meta';"])
model Field {
id Int @id @default(autoincrement())
secondaryId String @unique @default(cuid())
documentId Int?
templateId Int?
recipientId Int
type FieldType
page Int /// @zod.number.describe("The page number of the field on the document. Starts from 1.")
positionX Decimal @default(0)
positionY Decimal @default(0)
width Decimal @default(-1)
height Decimal @default(-1)
customText String
inserted Boolean
document Document? @relation(fields: [documentId], references: [id], onDelete: Cascade)
template Template? @relation(fields: [templateId], references: [id], onDelete: Cascade)
recipient Recipient @relation(fields: [recipientId], references: [id], onDelete: Cascade)
signature Signature?
fieldMeta Json? /// [FieldMeta] @zod.custom.use(ZFieldMetaNotOptionalSchema)
id Int @id @default(autoincrement())
secondaryId String @unique @default(cuid())
envelopeId String
envelopeItemId String
recipientId Int
type FieldType
page Int /// @zod.number.describe("The page number of the field on the document. Starts from 1.")
positionX Decimal @default(0)
positionY Decimal @default(0)
width Decimal @default(-1)
height Decimal @default(-1)
customText String
inserted Boolean
envelopeItem EnvelopeItem @relation(fields: [envelopeItemId], references: [id], onDelete: Cascade)
envelope Envelope @relation(fields: [envelopeId], references: [id], onDelete: Cascade)
recipient Recipient @relation(fields: [recipientId], references: [id], onDelete: Cascade)
signature Signature?
fieldMeta Json? /// [FieldMeta] @zod.custom.use(ZFieldMetaNotOptionalSchema)
@@index([documentId])
@@index([templateId])
@@index([envelopeId])
@@index([recipientId])
}
@ -590,13 +614,13 @@ model DocumentShareLink {
id Int @id @default(autoincrement())
email String
slug String @unique
documentId Int
envelopeId String
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
document Document @relation(fields: [documentId], references: [id], onDelete: Cascade)
envelope Envelope @relation(fields: [envelopeId], references: [id], onDelete: Cascade)
@@unique([documentId, email])
@@unique([envelopeId, email])
}
enum OrganisationType {
@ -810,8 +834,7 @@ model Team {
profile TeamProfile?
documents Document[]
templates Template[]
envelopes Envelope[]
folders Folder[]
apiTokens ApiToken[]
webhooks Webhook[]
@ -849,79 +872,16 @@ enum TemplateType {
PRIVATE
}
/// @zod.import(["import { ZDocumentEmailSettingsSchema } from '@documenso/lib/types/document-email';"])
model TemplateMeta {
id String @id @default(cuid())
subject String?
message String?
timezone String? @default("Etc/UTC") @db.Text
password String?
dateFormat String? @default("yyyy-MM-dd hh:mm a") @db.Text
signingOrder DocumentSigningOrder? @default(PARALLEL)
allowDictateNextSigner Boolean @default(false)
distributionMethod DocumentDistributionMethod @default(EMAIL)
typedSignatureEnabled Boolean @default(true)
uploadSignatureEnabled Boolean @default(true)
drawSignatureEnabled Boolean @default(true)
templateId Int @unique
template Template @relation(fields: [templateId], references: [id], onDelete: Cascade)
redirectUrl String?
language String @default("en")
emailSettings Json? /// [DocumentEmailSettings] @zod.custom.use(ZDocumentEmailSettingsSchema)
emailReplyTo String?
emailId String?
}
/// @zod.import(["import { ZDocumentAuthOptionsSchema } from '@documenso/lib/types/document-auth';"])
model Template {
id Int @id @default(autoincrement())
externalId String?
type TemplateType @default(PRIVATE)
title String
visibility DocumentVisibility @default(EVERYONE)
authOptions Json? /// [DocumentAuthOptions] @zod.custom.use(ZDocumentAuthOptionsSchema)
templateMeta TemplateMeta?
templateDocumentDataId String
createdAt DateTime @default(now())
updatedAt DateTime @default(now()) @updatedAt
publicTitle String @default("")
publicDescription String @default("")
useLegacyFieldInsertion Boolean @default(false)
userId Int
user User @relation(fields: [userId], references: [id], onDelete: Cascade)
teamId Int
team Team @relation(fields: [teamId], references: [id], onDelete: Cascade)
templateDocumentData DocumentData @relation(fields: [templateDocumentDataId], references: [id], onDelete: Cascade)
recipients Recipient[]
fields Field[]
directLink TemplateDirectLink?
documents Document[]
folder Folder? @relation(fields: [folderId], references: [id], onDelete: SetNull)
folderId String?
@@unique([templateDocumentDataId])
@@index([userId])
}
model TemplateDirectLink {
id String @id @unique @default(cuid())
templateId Int @unique
envelopeId String @unique
token String @unique
createdAt DateTime @default(now())
enabled Boolean
directTemplateRecipientId Int
template Template @relation(fields: [templateId], references: [id], onDelete: Cascade)
envelope Envelope @relation(fields: [envelopeId], references: [id], onDelete: Cascade)
}
model SiteSettings {
@ -1048,3 +1008,8 @@ model OrganisationAuthenticationPortal {
autoProvisionUsers Boolean @default(true)
allowedDomains String[] @default([])
}
model Counter {
id String @id
value Int
}

250
packages/prisma/seed/documents.ts
View File

@ -1,17 +1,19 @@
import type { Document, Team, User } from '@prisma/client';
import type { Team, User } from '@prisma/client';
import { nanoid } from 'nanoid';
import fs from 'node:fs';
import path from 'node:path';
import { match } from 'ts-pattern';
import { createDocument } from '@documenso/lib/server-only/document/create-document';
import { createTemplate } from '@documenso/lib/server-only/template/create-template';
import { createEnvelope } from '@documenso/lib/server-only/envelope/create-envelope';
import { incrementDocumentId } from '@documenso/lib/server-only/envelope/increment-id';
import { prefixedId } from '@documenso/lib/universal/id';
import { prisma } from '..';
import {
DocumentDataType,
DocumentSource,
DocumentStatus,
EnvelopeType,
FieldType,
Prisma,
ReadStatus,
@ -30,7 +32,7 @@ type DocumentToSeed = {
teamId: number;
recipients: (User | string)[];
type: DocumentStatus;
documentOptions?: Partial<Prisma.DocumentUncheckedCreateInput>;
documentOptions?: Partial<Prisma.EnvelopeUncheckedCreateInput>;
};
export const seedDocuments = async (documents: DocumentToSeed[]) => {
@ -75,27 +77,37 @@ export const seedBlankDocument = async (
},
});
return await prisma.document.create({
const documentMeta = await prisma.documentMeta.create({
data: {},
});
const documentId = await incrementDocumentId();
return await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: documentId.formattedDocumentId,
internalVersion: 1,
type: EnvelopeType.DOCUMENT,
documentMetaId: documentMeta.id,
source: DocumentSource.DOCUMENT,
teamId,
title: `[TEST] Document ${key} - Draft`,
status: DocumentStatus.DRAFT,
documentDataId: documentData.id,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title: `[TEST] Document ${key} - Draft`,
documentDataId: documentData.id,
order: 1,
},
},
userId: owner.id,
...createDocumentOptions,
},
});
};
export const unseedDocument = async (documentId: number) => {
await prisma.document.delete({
where: {
id: documentId,
},
});
};
export const seedTeamDocumentWithMeta = async (team: Team) => {
const documentData = await prisma.documentData.create({
data: {
@ -120,11 +132,20 @@ export const seedTeamDocumentWithMeta = async (team: Team) => {
const ownerUser = organisation.owner;
const document = await createDocument({
const document = await createEnvelope({
userId: ownerUser.id,
teamId: team.id,
title: `[TEST] Document ${nanoid(8)} - Draft`,
documentDataId: documentData.id,
internalVersion: 1,
data: {
type: EnvelopeType.DOCUMENT,
title: `[TEST] Document ${nanoid(8)} - Draft`,
envelopeItems: [
{
title: `[TEST] Document ${nanoid(8)} - Draft`,
documentDataId: documentData.id,
},
],
},
normalizePdf: true,
requestMetadata: {
auth: null,
@ -133,7 +154,7 @@ export const seedTeamDocumentWithMeta = async (team: Team) => {
},
});
await prisma.document.update({
await prisma.envelope.update({
where: {
id: document.id,
},
@ -151,11 +172,7 @@ export const seedTeamDocumentWithMeta = async (team: Team) => {
sendStatus: SendStatus.SENT,
signingStatus: SigningStatus.NOT_SIGNED,
signedAt: new Date(),
document: {
connect: {
id: document.id,
},
},
envelopeId: document.id,
fields: {
create: {
page: 1,
@ -166,13 +183,14 @@ export const seedTeamDocumentWithMeta = async (team: Team) => {
positionY: new Prisma.Decimal(1),
width: new Prisma.Decimal(5),
height: new Prisma.Decimal(5),
documentId: document.id,
envelopeId: document.id,
envelopeItemId: document.envelopeItems[0].id,
},
},
},
});
return await prisma.document.findFirstOrThrow({
return await prisma.envelope.findFirstOrThrow({
where: {
id: document.id,
},
@ -206,13 +224,24 @@ export const seedTeamTemplateWithMeta = async (team: Team) => {
const ownerUser = organisation.owner;
const template = await createTemplate({
const template = await createEnvelope({
internalVersion: 1,
data: {
type: EnvelopeType.TEMPLATE,
title: `[TEST] Template ${nanoid(8)} - Draft`,
envelopeItems: [
{
documentDataId: documentData.id,
},
],
},
userId: ownerUser.id,
teamId: team.id,
templateDocumentDataId: documentData.id,
requestMetadata: {
auth: null,
requestMetadata: {},
source: 'app',
},
});
await prisma.recipient.create({
@ -224,11 +253,7 @@ export const seedTeamTemplateWithMeta = async (team: Team) => {
sendStatus: SendStatus.SENT,
signingStatus: SigningStatus.NOT_SIGNED,
signedAt: new Date(),
template: {
connect: {
id: template.id,
},
},
envelopeId: template.id,
fields: {
create: {
page: 1,
@ -239,13 +264,14 @@ export const seedTeamTemplateWithMeta = async (team: Team) => {
positionY: new Prisma.Decimal(1),
width: new Prisma.Decimal(5),
height: new Prisma.Decimal(5),
templateId: template.id,
envelopeId: template.id,
envelopeItemId: template.envelopeItems[0].id,
},
},
},
});
return await prisma.document.findFirstOrThrow({
return await prisma.envelope.findFirstOrThrow({
where: {
id: template.id,
},
@ -271,16 +297,41 @@ export const seedDraftDocument = async (
},
});
const document = await prisma.document.create({
const documentMeta = await prisma.documentMeta.create({
data: {},
});
const documentId = await incrementDocumentId();
const document = await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: documentId.formattedDocumentId,
internalVersion: 1,
type: EnvelopeType.DOCUMENT,
documentMetaId: documentMeta.id,
source: DocumentSource.DOCUMENT,
teamId,
title: `[TEST] Document ${key} - Draft`,
status: DocumentStatus.DRAFT,
documentDataId: documentData.id,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title: `[TEST] Document ${key} - Draft`,
documentDataId: documentData.id,
order: 1,
},
},
userId: sender.id,
...createDocumentOptions,
},
include: {
envelopeItems: {
include: {
documentData: true,
},
},
},
});
for (const recipient of recipients) {
@ -296,22 +347,19 @@ export const seedDraftDocument = async (
sendStatus: SendStatus.NOT_SENT,
signingStatus: SigningStatus.NOT_SIGNED,
signedAt: new Date(),
document: {
connect: {
id: document.id,
},
},
envelopeId: document.id,
fields: {
create: {
page: 1,
type: FieldType.NAME,
inserted: true,
inserted: false,
customText: name,
positionX: new Prisma.Decimal(1),
positionY: new Prisma.Decimal(1),
width: new Prisma.Decimal(1),
height: new Prisma.Decimal(1),
documentId: document.id,
envelopeId: document.id,
envelopeItemId: document.envelopeItems[0].id,
},
},
},
@ -323,7 +371,7 @@ export const seedDraftDocument = async (
type CreateDocumentOptions = {
key?: string | number;
createDocumentOptions?: Partial<Prisma.DocumentUncheckedCreateInput>;
createDocumentOptions?: Partial<Prisma.EnvelopeUncheckedCreateInput>;
};
export const seedPendingDocument = async (
@ -342,16 +390,37 @@ export const seedPendingDocument = async (
},
});
const document = await prisma.document.create({
const documentMeta = await prisma.documentMeta.create({
data: {},
});
const documentId = await incrementDocumentId();
const document = await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: documentId.formattedDocumentId,
internalVersion: 1,
type: EnvelopeType.DOCUMENT,
documentMetaId: documentMeta.id,
source: DocumentSource.DOCUMENT,
teamId,
title: `[TEST] Document ${key} - Pending`,
status: DocumentStatus.PENDING,
documentDataId: documentData.id,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title: `[TEST] Document ${key} - Pending`,
documentDataId: documentData.id,
order: 1,
},
},
userId: sender.id,
...createDocumentOptions,
},
include: {
envelopeItems: true,
},
});
for (const recipient of recipients) {
@ -367,11 +436,7 @@ export const seedPendingDocument = async (
sendStatus: SendStatus.SENT,
signingStatus: SigningStatus.NOT_SIGNED,
signedAt: new Date(),
document: {
connect: {
id: document.id,
},
},
envelopeId: document.id,
fields: {
create: {
page: 1,
@ -382,19 +447,25 @@ export const seedPendingDocument = async (
positionY: new Prisma.Decimal(1),
width: new Prisma.Decimal(1),
height: new Prisma.Decimal(1),
documentId: document.id,
envelopeId: document.id,
envelopeItemId: document.envelopeItems[0].id,
},
},
},
});
}
return prisma.document.findFirstOrThrow({
return prisma.envelope.findFirstOrThrow({
where: {
id: document.id,
},
include: {
recipients: true,
envelopeItems: {
include: {
documentData: true,
},
},
},
});
};
@ -408,9 +479,9 @@ export const seedPendingDocumentNoFields = async ({
owner: User;
recipients: (User | string)[];
teamId: number;
updateDocumentOptions?: Partial<Prisma.DocumentUncheckedUpdateInput>;
updateDocumentOptions?: Partial<Prisma.EnvelopeUncheckedUpdateInput>;
}) => {
const document: Document = await seedBlankDocument(owner, teamId);
const document = await seedBlankDocument(owner, teamId);
for (const recipient of recipients) {
const email = typeof recipient === 'string' ? recipient : recipient.email;
@ -425,18 +496,14 @@ export const seedPendingDocumentNoFields = async ({
sendStatus: SendStatus.SENT,
signingStatus: SigningStatus.NOT_SIGNED,
signedAt: new Date(),
document: {
connect: {
id: document.id,
},
},
envelopeId: document.id,
},
});
}
const createdRecipients = await prisma.recipient.findMany({
where: {
documentId: document.id,
envelopeId: document.id,
},
include: {
fields: true,
@ -444,7 +511,7 @@ export const seedPendingDocumentNoFields = async ({
});
const latestDocument = updateDocumentOptions
? await prisma.document.update({
? await prisma.envelope.update({
where: {
id: document.id,
},
@ -468,12 +535,18 @@ export const seedPendingDocumentWithFullFields = async ({
}: {
owner: User;
recipients: (User | string)[];
recipientsCreateOptions?: Partial<Prisma.RecipientCreateInput>[];
updateDocumentOptions?: Partial<Prisma.DocumentUncheckedUpdateInput>;
recipientsCreateOptions?: Partial<Prisma.RecipientUncheckedCreateInput>[];
updateDocumentOptions?: Partial<Prisma.EnvelopeUncheckedUpdateInput>;
fields?: FieldType[];
teamId: number;
}) => {
const document: Document = await seedBlankDocument(owner, teamId);
const document = await seedBlankDocument(owner, teamId);
const firstItem = await prisma.envelopeItem.findFirstOrThrow({
where: {
envelopeId: document.id,
},
});
for (const [recipientIndex, recipient] of recipients.entries()) {
const email = typeof recipient === 'string' ? recipient : recipient.email;
@ -488,11 +561,7 @@ export const seedPendingDocumentWithFullFields = async ({
sendStatus: SendStatus.SENT,
signingStatus: SigningStatus.NOT_SIGNED,
signedAt: new Date(),
document: {
connect: {
id: document.id,
},
},
envelopeId: document.id,
fields: {
createMany: {
data: fields.map((fieldType, fieldIndex) => ({
@ -504,7 +573,8 @@ export const seedPendingDocumentWithFullFields = async ({
positionY: new Prisma.Decimal((fieldIndex + 1) * 5),
width: new Prisma.Decimal(5),
height: new Prisma.Decimal(5),
documentId: document.id,
envelopeId: document.id,
envelopeItemId: firstItem.id,
})),
},
},
@ -515,14 +585,14 @@ export const seedPendingDocumentWithFullFields = async ({
const createdRecipients = await prisma.recipient.findMany({
where: {
documentId: document.id,
envelopeId: document.id,
},
include: {
fields: true,
},
});
const latestDocument = await prisma.document.update({
const latestDocument = await prisma.envelope.update({
where: {
id: document.id,
},
@ -557,16 +627,37 @@ export const seedCompletedDocument = async (
},
});
const document = await prisma.document.create({
const documentMeta = await prisma.documentMeta.create({
data: {},
});
const documentId = await incrementDocumentId();
const document = await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: documentId.formattedDocumentId,
internalVersion: 1,
type: EnvelopeType.DOCUMENT,
documentMetaId: documentMeta.id,
source: DocumentSource.DOCUMENT,
teamId,
title: `[TEST] Document ${key} - Completed`,
status: DocumentStatus.COMPLETED,
documentDataId: documentData.id,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title: `[TEST] Document ${key} - Completed`,
documentDataId: documentData.id,
order: 1,
},
},
userId: sender.id,
...createDocumentOptions,
},
include: {
envelopeItems: true,
},
});
for (const recipient of recipients) {
@ -582,11 +673,7 @@ export const seedCompletedDocument = async (
sendStatus: SendStatus.SENT,
signingStatus: SigningStatus.SIGNED,
signedAt: new Date(),
document: {
connect: {
id: document.id,
},
},
envelopeId: document.id,
fields: {
create: {
page: 1,
@ -597,7 +684,8 @@ export const seedCompletedDocument = async (
positionY: new Prisma.Decimal(1),
width: new Prisma.Decimal(1),
height: new Prisma.Decimal(1),
documentId: document.id,
envelopeId: document.id,
envelopeItemId: document.envelopeItems[0].id,
},
},
},

49
packages/prisma/seed/initial-seed.ts
View File

@ -1,8 +1,11 @@
import fs from 'node:fs';
import path from 'node:path';
import { incrementDocumentId } from '@documenso/lib/server-only/envelope/increment-id';
import { prefixedId } from '@documenso/lib/universal/id';
import { prisma } from '..';
import { DocumentDataType, DocumentSource } from '../client';
import { DocumentDataType, DocumentSource, EnvelopeType } from '../client';
import { seedPendingDocument } from './documents';
import { seedDirectTemplate, seedTemplate } from './templates';
import { seedUser } from './users';
@ -52,11 +55,29 @@ export const seedDatabase = async () => {
for (let i = 1; i <= 4; i++) {
const documentData = await createDocumentData({ documentData: examplePdf });
await prisma.document.create({
const documentId = await incrementDocumentId();
const documentMeta = await prisma.documentMeta.create({
data: {},
});
await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: documentId.formattedDocumentId,
internalVersion: 1,
type: EnvelopeType.DOCUMENT,
documentMetaId: documentMeta.id,
source: DocumentSource.DOCUMENT,
title: `Example Document ${i}`,
documentDataId: documentData.id,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title: `Example Document ${i}`,
documentDataId: documentData.id,
order: 1,
},
},
userId: exampleUser.user.id,
teamId: exampleUser.team.id,
recipients: {
@ -73,11 +94,29 @@ export const seedDatabase = async () => {
for (let i = 1; i <= 4; i++) {
const documentData = await createDocumentData({ documentData: examplePdf });
await prisma.document.create({
const documentId = await incrementDocumentId();
const documentMeta = await prisma.documentMeta.create({
data: {},
});
await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: documentId.formattedDocumentId,
internalVersion: 1,
type: EnvelopeType.DOCUMENT,
source: DocumentSource.DOCUMENT,
title: `Document ${i}`,
documentDataId: documentData.id,
documentMetaId: documentMeta.id,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title: `Document ${i}`,
documentDataId: documentData.id,
order: 1,
},
},
userId: adminUser.user.id,
teamId: adminUser.team.id,
recipients: {

128
packages/prisma/seed/templates.ts
View File

@ -5,10 +5,20 @@ import {
DIRECT_TEMPLATE_RECIPIENT_EMAIL,
DIRECT_TEMPLATE_RECIPIENT_NAME,
} from '@documenso/lib/constants/direct-templates';
import { incrementTemplateId } from '@documenso/lib/server-only/envelope/increment-id';
import { prefixedId } from '@documenso/lib/universal/id';
import { prisma } from '..';
import type { Prisma, User } from '../client';
import { DocumentDataType, ReadStatus, RecipientRole, SendStatus, SigningStatus } from '../client';
import {
DocumentDataType,
DocumentSource,
EnvelopeType,
ReadStatus,
RecipientRole,
SendStatus,
SigningStatus,
} from '../client';
const examplePdf = fs
.readFileSync(path.join(__dirname, '../../../assets/example.pdf'))
@ -18,12 +28,12 @@ type SeedTemplateOptions = {
title?: string;
userId: number;
teamId: number;
createTemplateOptions?: Partial<Prisma.TemplateCreateInput>;
createTemplateOptions?: Partial<Prisma.EnvelopeUncheckedCreateInput>;
};
type CreateTemplateOptions = {
key?: string | number;
createTemplateOptions?: Partial<Prisma.TemplateUncheckedCreateInput>;
createTemplateOptions?: Partial<Prisma.EnvelopeUncheckedCreateInput>;
};
export const seedBlankTemplate = async (
@ -41,14 +51,40 @@ export const seedBlankTemplate = async (
},
});
return await prisma.template.create({
const templateId = await incrementTemplateId();
const documentMeta = await prisma.documentMeta.create({
data: {},
});
return await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: templateId.formattedTemplateId,
internalVersion: 1,
type: EnvelopeType.TEMPLATE,
title: `[TEST] Template ${key}`,
teamId,
templateDocumentDataId: documentData.id,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title: `[TEST] Template ${key}`,
documentDataId: documentData.id,
order: 1,
},
},
userId: owner.id,
source: DocumentSource.TEMPLATE,
documentMetaId: documentMeta.id,
...createTemplateOptions,
},
include: {
envelopeItems: {
include: {
documentData: true,
},
},
},
});
};
@ -63,19 +99,31 @@ export const seedTemplate = async (options: SeedTemplateOptions) => {
},
});
return await prisma.template.create({
const templateId = await incrementTemplateId();
const documentMeta = await prisma.documentMeta.create({
data: {},
});
return await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: templateId.formattedTemplateId,
internalVersion: 1,
type: EnvelopeType.TEMPLATE,
title,
templateDocumentData: {
connect: {
id: documentData.id,
},
},
user: {
connect: {
id: userId,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title,
documentDataId: documentData.id,
order: 1,
},
},
source: DocumentSource.TEMPLATE,
documentMetaId: documentMeta.id,
userId,
teamId,
recipients: {
create: {
email: 'recipient.1@documenso.com',
@ -87,9 +135,11 @@ export const seedTemplate = async (options: SeedTemplateOptions) => {
role: RecipientRole.SIGNER,
},
},
team: {
connect: {
id: teamId,
},
include: {
envelopeItems: {
include: {
documentData: true,
},
},
},
@ -107,19 +157,31 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
},
});
const template = await prisma.template.create({
const templateId = await incrementTemplateId();
const documentMeta = await prisma.documentMeta.create({
data: {},
});
const template = await prisma.envelope.create({
data: {
id: prefixedId('envelope'),
secondaryId: templateId.formattedTemplateId,
internalVersion: 1,
type: EnvelopeType.TEMPLATE,
title,
templateDocumentData: {
connect: {
id: documentData.id,
},
},
user: {
connect: {
id: userId,
envelopeItems: {
create: {
id: prefixedId('envelope_item'),
title,
documentDataId: documentData.id,
order: 1,
},
},
source: DocumentSource.TEMPLATE,
documentMetaId: documentMeta.id,
userId,
teamId,
recipients: {
create: {
email: DIRECT_TEMPLATE_RECIPIENT_EMAIL,
@ -127,11 +189,6 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
token: Math.random().toString().slice(2, 7),
},
},
team: {
connect: {
id: teamId,
},
},
...options.createTemplateOptions,
},
include: {
@ -150,14 +207,14 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
await prisma.templateDirectLink.create({
data: {
templateId: template.id,
envelopeId: template.id,
enabled: true,
token: Math.random().toString(),
directTemplateRecipientId: directTemplateRecpient.id,
},
});
return await prisma.template.findFirstOrThrow({
return await prisma.envelope.findFirstOrThrow({
where: {
id: template.id,
},
@ -166,6 +223,11 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
fields: true,
recipients: true,
team: true,
envelopeItems: {
select: {
documentData: true,
},
},
},
});
};

52
packages/prisma/types/document-legacy-schema.ts Normal file
View File

@ -0,0 +1,52 @@
/**
* Legacy Document schema to confirm backwards API compatibility since
* we migrated Documents to Envelopes.
*/
import { DocumentSource } from '@prisma/client';
import { z } from 'zod';
import { ZDocumentAuthOptionsSchema } from '@documenso/lib/types/document-auth';
import { ZDocumentFormValuesSchema } from '@documenso/lib/types/document-form-values';
import DocumentStatusSchema from '../generated/zod/inputTypeSchemas/DocumentStatusSchema';
import DocumentVisibilitySchema from '../generated/zod/inputTypeSchemas/DocumentVisibilitySchema';
/////////////////////////////////////////
// DOCUMENT SCHEMA
/////////////////////////////////////////
export const LegacyDocumentSchema = z.object({
visibility: DocumentVisibilitySchema,
status: DocumentStatusSchema,
source: z.nativeEnum(DocumentSource),
id: z.number(),
qrToken: z
.string()
.describe('The token for viewing the document using the QR code on the certificate.')
.nullable(),
externalId: z
.string()
.describe('A custom external ID you can use to identify the document.')
.nullable(),
userId: z.number().describe('The ID of the user that created this document.'),
teamId: z.number(),
/**
* [DocumentAuthOptions]
*/
authOptions: ZDocumentAuthOptionsSchema.nullable(),
/**
* [DocumentFormValues]
*/
formValues: ZDocumentFormValuesSchema.nullable(),
title: z.string(),
documentDataId: z.string(),
createdAt: z.coerce.date(),
updatedAt: z.coerce.date(),
completedAt: z.coerce.date().nullable(),
deletedAt: z.coerce.date().nullable(),
templateId: z.number().nullable(),
useLegacyFieldInsertion: z.boolean(),
folderId: z.string().nullable(),
});
export type Document = z.infer<typeof LegacyDocumentSchema>;

6
packages/prisma/types/document-with-recipient.ts
View File

@ -1,10 +1,10 @@
import type { Document, DocumentData, Recipient } from '@prisma/client';
import type { DocumentData, Envelope, Recipient } from '@prisma/client';
export type DocumentWithRecipients = Document & {
export type EnvelopeWithRecipients = Envelope & {
recipients: Recipient[];
};
export type DocumentWithRecipient = Document & {
export type EnvelopeWithRecipient = Envelope & {
recipients: Recipient[];
documentData: DocumentData;
};

40
packages/prisma/types/template-legacy-schema.ts Normal file
View File

@ -0,0 +1,40 @@
/**
* Legacy Template schema to confirm backwards API compatibility since
* we removed the "Template" prisma schema model.
*/
import { TemplateType } from '@prisma/client';
import { z } from 'zod';
import { ZDocumentAuthOptionsSchema } from '@documenso/lib/types/document-auth';
import { DocumentVisibilitySchema } from '../generated/zod/inputTypeSchemas/DocumentVisibilitySchema';
import TemplateDirectLinkSchema from '../generated/zod/modelSchema/TemplateDirectLinkSchema';
export const TemplateTypeSchema = z.nativeEnum(TemplateType);
export const TemplateSchema = z.object({
type: TemplateTypeSchema,
visibility: DocumentVisibilitySchema,
id: z.number(),
externalId: z.string().nullable(),
title: z.string(),
/**
* [DocumentAuthOptions]
*/
authOptions: ZDocumentAuthOptionsSchema.nullable(),
templateDocumentDataId: z.string(),
createdAt: z.coerce.date(),
updatedAt: z.coerce.date(),
publicTitle: z.string(),
publicDescription: z.string(),
useLegacyFieldInsertion: z.boolean(),
userId: z.number(),
teamId: z.number(),
folderId: z.string().nullable(),
});
export type Template = z.infer<typeof TemplateSchema>;
export const LegacyTemplateDirectLinkSchema = TemplateDirectLinkSchema.extend({
templateId: z.number(),
});