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

feat: add reminder to advanced settings

Browse Source
This commit is contained in:
Ephraim Atta-Duncan
2024-11-20 22:10:09 +00:00
parent 8b771d36d2
commit 9fc5ec11f4
12 changed files with 102 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
apps/web/src/app/(dashboard)/documents/[id]/edit-document.tsx
View File

@ -203,7 +203,7 @@ export const EditDocumentForm = ({
const onAddSettingsFormSubmit = async (data: TAddSettingsFormSchema) => {
try {
const { timezone, dateFormat, redirectUrl, language } = data.meta;
const { timezone, dateFormat, redirectUrl, language, reminderDays } = data.meta;
await setSettingsForDocument({
documentId: document.id,
@ -220,6 +220,7 @@ export const EditDocumentForm = ({
dateFormat,
redirectUrl,
language: isValidLanguageCode(language) ? language : undefined,
reminderDays,
},
});

2
packages/lib/jobs/client.ts
View File

@ -1,4 +1,5 @@
import { JobClient } from './client/client';
import { TEST_CRON_JOB_DEFINITION } from './definitions/cron/test-cron';
import { SEND_CONFIRMATION_EMAIL_JOB_DEFINITION } from './definitions/emails/send-confirmation-email';
import { SEND_SIGNING_REJECTION_EMAILS_JOB_DEFINITION } from './definitions/emails/send-rejection-emails';
import { SEND_SIGNING_EMAIL_JOB_DEFINITION } from './definitions/emails/send-signing-email';
@ -19,6 +20,7 @@ export const jobsClient = new JobClient([
SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION,
SEAL_DOCUMENT_JOB_DEFINITION,
SEND_SIGNING_REJECTION_EMAILS_JOB_DEFINITION,
TEST_CRON_JOB_DEFINITION,
] as const);
export const jobs = jobsClient;

28
packages/lib/jobs/definitions/cron/test-cron.ts Normal file
View File

@ -0,0 +1,28 @@
import { prisma } from '@documenso/prisma';
import type { JobDefinition } from '../../client/_internal/job';
const TEST_CRON_JOB_DEFINITION_ID = 'test.cron';
export const TEST_CRON_JOB_DEFINITION = {
id: TEST_CRON_JOB_DEFINITION_ID,
name: 'Test Cron Job',
version: '1.0.0',
trigger: {
type: 'cron',
schedule: '* * * * *',
},
handler: async ({ io }) => {
// send a mail to all recipients of all documents
const documents = await prisma.document.findMany({});
console.log(`Found ${documents.length} unsigned documents`);
for (const document of documents) {
// eslint-disable-next-line @typescript-eslint/require-await
await io.runTask(`send-reminder-${document.id}-${document.id}`, async () => {
console.log(`Sent reminder for document ${document.id} to recipient ${document.id}`);
});
}
},
} as const satisfies JobDefinition<typeof TEST_CRON_JOB_DEFINITION_ID>;

6
packages/lib/server-only/document-meta/upsert-document-meta.ts
View File

@ -24,6 +24,7 @@ export type CreateDocumentMetaOptions = {
signingOrder?: DocumentSigningOrder;
distributionMethod?: DocumentDistributionMethod;
typedSignatureEnabled?: boolean;
reminderDays?: number;
language?: SupportedLanguageCodes;
userId: number;
requestMetadata: RequestMetadata;
@ -42,6 +43,7 @@ export const upsertDocumentMeta = async ({
emailSettings,
distributionMethod,
typedSignatureEnabled,
reminderDays,
language,
requestMetadata,
}: CreateDocumentMetaOptions) => {
@ -96,6 +98,7 @@ export const upsertDocumentMeta = async ({
emailSettings,
distributionMethod,
typedSignatureEnabled,
reminderDays,
language,
},
update: {
@ -109,6 +112,7 @@ export const upsertDocumentMeta = async ({
emailSettings,
distributionMethod,
typedSignatureEnabled,
reminderDays,
language,
},
});
@ -123,7 +127,7 @@ export const upsertDocumentMeta = async ({
user,
requestMetadata,
data: {
changes: diffDocumentMetaChanges(originalDocumentMeta ?? {}, upsertedDocumentMeta),
changes,
},
}),
});

2
packages/lib/server-only/document/complete-document-with-token.ts
View File

@ -8,8 +8,8 @@ import {
RecipientRole,
SendStatus,
SigningStatus,
WebhookTriggerEvents,
} from '@documenso/prisma/client';
import { WebhookTriggerEvents } from '@documenso/prisma/client';
import { jobs } from '../../jobs/client';
import type { TRecipientActionAuth } from '../../types/document-auth';

12
packages/lib/server-only/document/send-document.tsx
View File

@ -9,8 +9,8 @@ import {
RecipientRole,
SendStatus,
SigningStatus,
WebhookTriggerEvents,
} from '@documenso/prisma/client';
import { WebhookTriggerEvents } from '@documenso/prisma/client';
import { jobs } from '../../jobs/client';
import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
@ -180,6 +180,16 @@ export const sendDocument = async ({
requestMetadata,
},
});
// TODO: Duncan: Audit Log
await jobs.triggerJob({
name: 'send.signing.reminder.email',
payload: {
documentId,
recipientId: recipient.id,
initialDelay: 24 * 60 * 60 * 1000, // 24 hours in milliseconds
},
});
}),
);
}

2
packages/prisma/migrations/20241120202053_add_reminder_days_to_document_meta/migration.sql Normal file
View File

@ -0,0 +1,2 @@
-- AlterTable
ALTER TABLE "DocumentMeta" ADD COLUMN "reminderDays" INTEGER DEFAULT 0;

1
packages/prisma/schema.prisma
View File

@ -378,6 +378,7 @@ model DocumentMeta {
language String @default("en")
distributionMethod DocumentDistributionMethod @default(EMAIL)
emailSettings Json?
reminderDays Int? @default(0)
}
enum ReadStatus {

13
packages/trpc/server/document-router/router.ts
View File

@ -259,13 +259,20 @@ export const documentRouter = router({
const requestMetadata = extractNextApiRequestMetadata(ctx.req);
if (meta.timezone || meta.dateFormat || meta.redirectUrl) {
if (
meta.timezone ||
meta.dateFormat ||
meta.redirectUrl ||
meta.language ||
meta.reminderDays
) {
await upsertDocumentMeta({
documentId,
dateFormat: meta.dateFormat,
timezone: meta.timezone,
redirectUrl: meta.redirectUrl,
language: meta.language,
reminderDays: meta.reminderDays,
userId: ctx.user.id,
requestMetadata,
});
@ -420,7 +427,8 @@ export const documentRouter = router({
meta.dateFormat ||
meta.redirectUrl ||
meta.distributionMethod ||
meta.emailSettings
meta.emailSettings ||
meta.reminderDays
) {
await upsertDocumentMeta({
documentId,
@ -430,6 +438,7 @@ export const documentRouter = router({
timezone: meta.timezone,
redirectUrl: meta.redirectUrl,
distributionMethod: meta.distributionMethod,
reminderDays: meta.reminderDays,
userId: ctx.user.id,
emailSettings: meta.emailSettings,
requestMetadata: extractNextApiRequestMetadata(ctx.req),

2
packages/trpc/server/document-router/schema.ts
View File

@ -98,6 +98,7 @@ export const ZSetSettingsForDocumentMutationSchema = z.object({
'Please enter a valid URL, make sure you include http:// or https:// part of the url.',
}),
language: z.enum(SUPPORTED_LANGUAGE_CODES).optional(),
reminderDays: z.number().optional(),
}),
});
@ -167,6 +168,7 @@ export const ZSendDocumentMutationSchema = z.object({
'Please enter a valid URL, make sure you include http:// or https:// part of the url.',
}),
emailSettings: ZDocumentEmailSettingsSchema.optional(),
reminderDays: z.number().optional(),
}),
});

36
packages/ui/primitives/document-flow/add-settings.tsx
View File

@ -100,6 +100,7 @@ export const AddSettingsFormPartial = ({
?.value ?? DEFAULT_DOCUMENT_DATE_FORMAT,
redirectUrl: document.documentMeta?.redirectUrl ?? '',
language: document.documentMeta?.language ?? 'en',
reminderDays: document.documentMeta?.reminderDays ?? 0,
},
},
});
@ -390,6 +391,41 @@ export const AddSettingsFormPartial = ({
</FormItem>
)}
/>
<FormField
control={form.control}
name="meta.reminderDays"
render={({ field }) => (
<FormItem>
<FormLabel className="flex flex-row items-center">
<Trans>Reminder</Trans>{' '}
<Tooltip>
<TooltipTrigger>
<InfoIcon className="mx-2 h-4 w-4" />
</TooltipTrigger>
<TooltipContent className="text-muted-foreground max-w-xs">
<Trans>
Set the number of days between reminders for this document.
</Trans>
</TooltipContent>
</Tooltip>
</FormLabel>
<FormControl>
<Input
className="bg-background"
type="number"
min="0"
{...field}
onChange={(e) => field.onChange(parseInt(e.target.value, 10))}
/>
</FormControl>
<FormMessage />
</FormItem>
)}
/>
</div>
</AccordionContent>
</AccordionItem>

1
packages/ui/primitives/document-flow/add-settings.types.ts
View File

@ -45,6 +45,7 @@ export const ZAddSettingsFormSchema = z.object({
.union([z.string(), z.enum(SUPPORTED_LANGUAGE_CODES)])
.optional()
.default('en'),
reminderDays: z.number().optional(),
}),
});