The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
feat: add document preferences reset dialog (#3039)
Catalin Pit4b72e7d5466c
diff --git a/apps/remix/app/components/dialogs/document-preferences-reset-dialog.tsx b/apps/remix/app/components/dialogs/document-preferences-reset-dialog.tsxnew file mode 100644index 000000000..9adebb36e--- /dev/null+++ b/apps/remix/app/components/dialogs/document-preferences-reset-dialog.tsx@@ -0,0 +1,141 @@+import { Alert, AlertDescription } from '@documenso/ui/primitives/alert';+import { Button } from '@documenso/ui/primitives/button';+import {+ Dialog,+ DialogClose,+ DialogContent,+ DialogDescription,+ DialogFooter,+ DialogHeader,+ DialogTitle,+ DialogTrigger,+} from '@documenso/ui/primitives/dialog';+import { Trans } from '@lingui/react/macro';+import { useState } from 'react';++export type DocumentPreferencesResetDialogProps = {+ isSubmitting: boolean;+ onReset: () => Promise<void>;+ showAiFeatures?: boolean;+ showDocumentVisibility?: boolean;+ showIncludeSenderDetails?: boolean;+};++export const DocumentPreferencesResetDialog = ({+ isSubmitting,+ onReset,+ showAiFeatures = false,+ showDocumentVisibility = false,+ showIncludeSenderDetails = false,+}: DocumentPreferencesResetDialogProps) => {+ const [open, setOpen] = useState(false);+ const [isResetting, setIsResetting] = useState(false);++ const isLoading = isSubmitting || isResetting;++ const handleResetToDefaults = async () => {+ setIsResetting(true);++ try {+ await onReset();+ setOpen(false);+ } catch {+ // The submit handler surfaces its own error toast. Keep the dialog open+ // so the user can retry.+ } finally {+ setIsResetting(false);+ }+ };++ return (+ <Dialog open={open} onOpenChange={(value) => !isLoading && setOpen(value)}>+ <DialogTrigger asChild>+ <Button variant="destructive" type="button" size="sm" disabled={isLoading}>+ <Trans>Reset to defaults</Trans>+ </Button>+ </DialogTrigger>++ <DialogContent>+ <DialogHeader>+ <DialogTitle>+ <Trans>Reset document preferences</Trans>+ </DialogTitle>++ <DialogDescription>+ <Trans>+ This will reset all document preferences to their default values and save the changes immediately.+ </Trans>+ </DialogDescription>+ </DialogHeader>++ <Alert variant="warning">+ <AlertDescription>+ <p>+ <Trans>Once confirmed, the following will be reset:</Trans>+ </p>++ <ul className="mt-0.5 list-inside list-disc">+ {showDocumentVisibility && (+ <li>+ <Trans>Default document visibility</Trans>+ </li>+ )}+ <li>+ <Trans>Default document language</Trans>+ </li>+ <li>+ <Trans>Default date format</Trans>+ </li>+ <li>+ <Trans>Default time zone</Trans>+ </li>+ <li>+ <Trans>Default signature settings</Trans>+ </li>+ {showIncludeSenderDetails && (+ <li>+ <Trans>Send on behalf of team</Trans>+ </li>+ )}+ <li>+ <Trans>Include the signing certificate in the document</Trans>+ </li>+ <li>+ <Trans>Include the audit logs in the document</Trans>+ </li>+ <li>+ <Trans>Default recipients</Trans>+ </li>+ <li>+ <Trans>Delegate document ownership</Trans>+ </li>+ <li>+ <Trans>Default envelope expiration</Trans>+ </li>+ <li>+ <Trans>Default signing reminders</Trans>+ </li>+ {showAiFeatures && (+ <li>+ <Trans>AI features</Trans>+ </li>+ )}+ </ul>+ </AlertDescription>+ </Alert>++ <DialogFooter>+ <DialogClose asChild>+ <Button type="button" variant="secondary" disabled={isLoading}>+ <Trans>Cancel</Trans>+ </Button>+ </DialogClose>++ <Button type="button" variant="destructive" loading={isLoading} onClick={() => void handleResetToDefaults()}>+ <Trans>Reset to defaults</Trans>+ </Button>+ </DialogFooter>+ </DialogContent>+ </Dialog>+ );+};diff --git a/apps/remix/app/components/forms/document-preferences-form.tsx b/apps/remix/app/components/forms/document-preferences-form.tsxindex f1a0b6d8a..cdf39eb51 100644--- a/apps/remix/app/components/forms/document-preferences-form.tsx+++ b/apps/remix/app/components/forms/document-preferences-form.tsx@@ -11,10 +11,10 @@ import { isValidLanguageCode, SUPPORTED_LANGUAGE_CODES, SUPPORTED_LANGUAGES } frimport { TIME_ZONES } from '@documenso/lib/constants/time-zones';import type { TDefaultRecipients } from '@documenso/lib/types/default-recipients';import { ZDefaultRecipientsSchema } from '@documenso/lib/types/default-recipients';-import { type TDocumentMetaDateFormat, ZDocumentMetaTimezoneSchema } from '@documenso/lib/types/document-meta';-import { isPersonalLayout } from '@documenso/lib/utils/organisations';+import { type TDocumentMetaDateFormat, ZDocumentMetaDateFormatSchema } from '@documenso/lib/types/document-meta';+import { generateDefaultOrganisationSettings, isPersonalLayout } from '@documenso/lib/utils/organisations';import { recipientAbbreviation } from '@documenso/lib/utils/recipient-formatter';-import { extractTeamSignatureSettings } from '@documenso/lib/utils/teams';+import { extractTeamSignatureSettings, generateDefaultTeamSettings } from '@documenso/lib/utils/teams';import { DocumentSignatureSettingsTooltip } from '@documenso/ui/components/document/document-signature-settings-tooltip';import { ExpirationPeriodPicker } from '@documenso/ui/components/document/expiration-period-picker';import { ReminderSettingsPicker } from '@documenso/ui/components/document/reminder-settings-picker';@@ -37,11 +37,11 @@ import { zodResolver } from '@hookform/resolvers/zod';import { msg, t } from '@lingui/core/macro';import { useLingui } from '@lingui/react';import { Trans } from '@lingui/react/macro';-import type { TeamGlobalSettings } from '@prisma/client';-import { DocumentVisibility, OrganisationType, type RecipientRole } from '@prisma/client';+import { DocumentVisibility, OrganisationType, type RecipientRole, type TeamGlobalSettings } from '@prisma/client';import { useForm } from 'react-hook-form';import { z } from 'zod';+import { DocumentPreferencesResetDialog } from '~/components/dialogs/document-preferences-reset-dialog';import { useOptionalCurrentTeam } from '~/providers/team';import { DefaultRecipientsMultiSelectCombobox } from '../general/default-recipients-multiselect-combobox';@@ -93,6 +93,26 @@ export type DocumentPreferencesFormProps = {onFormSubmit: (data: TDocumentPreferencesFormSchema) => Promise<void>;};+const getDocumentPreferencesFormValues = (settings: SettingsSubset): TDocumentPreferencesFormSchema => {+ const parsedDocumentDateFormat = ZDocumentMetaDateFormatSchema.safeParse(settings.documentDateFormat);++ return {+ documentVisibility: settings.documentVisibility,+ documentLanguage: isValidLanguageCode(settings.documentLanguage) ? settings.documentLanguage : null,+ documentTimezone: settings.documentTimezone,+ documentDateFormat: parsedDocumentDateFormat.success ? parsedDocumentDateFormat.data : null,+ includeSenderDetails: settings.includeSenderDetails,+ includeSigningCertificate: settings.includeSigningCertificate,+ includeAuditLog: settings.includeAuditLog,+ signatureTypes: extractTeamSignatureSettings({ ...settings }),+ defaultRecipients: settings.defaultRecipients ? ZDefaultRecipientsSchema.parse(settings.defaultRecipients) : null,+ delegateDocumentOwnership: settings.delegateDocumentOwnership,+ aiFeaturesEnabled: settings.aiFeaturesEnabled,+ envelopeExpirationPeriod: settings.envelopeExpirationPeriod ?? null,+ reminderSettings: settings.reminderSettings ?? null,+ };+};+export const DocumentPreferencesForm = ({settings,onFormSubmit,@@ -113,7 +133,7 @@ export const DocumentPreferencesForm = ({documentVisibility: z.nativeEnum(DocumentVisibility).nullable(),documentLanguage: z.enum(SUPPORTED_LANGUAGE_CODES).nullable(),documentTimezone: z.string().nullable(),- documentDateFormat: ZDocumentMetaTimezoneSchema.nullable(),+ documentDateFormat: ZDocumentMetaDateFormatSchema.nullable(),includeSenderDetails: z.boolean().nullable(),includeSigningCertificate: z.boolean().nullable(),includeAuditLog: z.boolean().nullable(),@@ -127,26 +147,33 @@ export const DocumentPreferencesForm = ({reminderSettings: ZEnvelopeReminderSettings.nullable(),});+ const defaultValues = getDocumentPreferencesFormValues(settings);+ const defaultSettings = canInherit ? generateDefaultTeamSettings() : generateDefaultOrganisationSettings();+ const baseResetValues = getDocumentPreferencesFormValues(defaultSettings);+ const resetValues = {+ ...baseResetValues,+ aiFeaturesEnabled: isAiFeaturesConfigured ? baseResetValues.aiFeaturesEnabled : defaultValues.aiFeaturesEnabled,+ };+const form = useForm<TDocumentPreferencesFormSchema>({- defaultValues: {- documentVisibility: settings.documentVisibility,- documentLanguage: isValidLanguageCode(settings.documentLanguage) ? settings.documentLanguage : null,- documentTimezone: settings.documentTimezone,- // eslint-disable-next-line @typescript-eslint/consistent-type-assertions- documentDateFormat: settings.documentDateFormat as TDocumentMetaDateFormat | null,- includeSenderDetails: settings.includeSenderDetails,- includeSigningCertificate: settings.includeSigningCertificate,- includeAuditLog: settings.includeAuditLog,- signatureTypes: extractTeamSignatureSettings({ ...settings }),- defaultRecipients: settings.defaultRecipients ? ZDefaultRecipientsSchema.parse(settings.defaultRecipients) : null,- delegateDocumentOwnership: settings.delegateDocumentOwnership,- aiFeaturesEnabled: settings.aiFeaturesEnabled,- envelopeExpirationPeriod: settings.envelopeExpirationPeriod ?? null,- reminderSettings: settings.reminderSettings ?? null,- },+ defaultValues,resolver: zodResolver(ZDocumentPreferencesFormSchema),});+ // Parse both sides through the schema so we compare canonical representations+ const parsedCurrentValues = ZDocumentPreferencesFormSchema.safeParse(defaultValues);+ const parsedResetValues = ZDocumentPreferencesFormSchema.safeParse(resetValues);++ const isResetToDefaultsVisible =+ !parsedCurrentValues.success ||+ !parsedResetValues.success ||+ JSON.stringify(parsedCurrentValues.data) !== JSON.stringify(parsedResetValues.data);++ const handleResetToDefaults = async () => {+ await onFormSubmit(resetValues);+ form.reset(resetValues);+ };+const handleFormSubmit = form.handleSubmit(async (data) => {try {await onFormSubmit(data);@@ -772,6 +799,17 @@ export const DocumentPreferencesForm = ({isDirty={form.formState.isDirty}isSubmitting={form.formState.isSubmitting}onReset={() => form.reset()}+ resetToDefaults={+ isResetToDefaultsVisible ? (+ <DocumentPreferencesResetDialog+ isSubmitting={form.formState.isSubmitting}+ onReset={handleResetToDefaults}+ showAiFeatures={isAiFeaturesConfigured}+ showDocumentVisibility={!isPersonalLayoutMode}+ showIncludeSenderDetails={!isPersonalLayoutMode && !isPersonalOrganisation}+ />+ ) : undefined+ }/></fieldset></form>diff --git a/apps/remix/app/components/forms/form-sticky-save-bar.tsx b/apps/remix/app/components/forms/form-sticky-save-bar.tsxindex 1d37f9482..addc155e7 100644--- a/apps/remix/app/components/forms/form-sticky-save-bar.tsx+++ b/apps/remix/app/components/forms/form-sticky-save-bar.tsx@@ -3,12 +3,17 @@ import { Button } from '@documenso/ui/primitives/button';import { Trans, useLingui } from '@lingui/react/macro';import { AnimatePresence, motion } from 'framer-motion';import { AlertTriangleIcon } from 'lucide-react';-import { useEffect, useRef, useState } from 'react';+import { type ReactNode, useEffect, useRef, useState } from 'react';export type FormStickySaveBarProps = {isDirty: boolean;isSubmitting: boolean;onReset: () => void;+ /**+ * Slot for a "reset to defaults" action, rendered before the Undo button. Hidden while+ * the bar is floating so it never appears in the unsaved-changes island.+ */+ resetToDefaults?: ReactNode;};/**@@ -24,7 +29,7 @@ export type FormStickySaveBarProps = {* shared-layout morph). A 1px sentinel below it detects the stuck state so we can toggle* the pill chrome.*/-export const FormStickySaveBar = ({ isDirty, isSubmitting, onReset }: FormStickySaveBarProps) => {+export const FormStickySaveBar = ({ isDirty, isSubmitting, onReset, resetToDefaults }: FormStickySaveBarProps) => {const { t } = useLingui();const sentinelRef = useRef<HTMLDivElement>(null);@@ -100,6 +105,8 @@ export const FormStickySaveBar = ({ isDirty, isSubmitting, onReset }: FormSticky</AnimatePresence><div className="ml-auto flex flex-shrink-0 items-center gap-x-2">+ {!isFloating && resetToDefaults}+{isDirty && (<Button type="button" variant="secondary" size="sm" onClick={onReset} disabled={isSubmitting}><Trans>Undo</Trans>diff --git a/apps/remix/app/routes/_authenticated+/o.$orgUrl.settings.document.tsx b/apps/remix/app/routes/_authenticated+/o.$orgUrl.settings.document.tsxindex 9d73e00bc..741519a40 100644--- a/apps/remix/app/routes/_authenticated+/o.$orgUrl.settings.document.tsx+++ b/apps/remix/app/routes/_authenticated+/o.$orgUrl.settings.document.tsx@@ -88,7 +88,7 @@ export default function OrganisationSettingsDocumentPage() {typedSignatureEnabled: signatureTypes.includes(DocumentSignatureType.TYPE),uploadSignatureEnabled: signatureTypes.includes(DocumentSignatureType.UPLOAD),drawSignatureEnabled: signatureTypes.includes(DocumentSignatureType.DRAW),- delegateDocumentOwnership: delegateDocumentOwnership,+ delegateDocumentOwnership,aiFeaturesEnabled,envelopeExpirationPeriod: envelopeExpirationPeriod ?? undefined,reminderSettings: reminderSettings ?? undefined,diff --git a/apps/remix/app/routes/_authenticated+/t.$teamUrl+/settings.document.tsx b/apps/remix/app/routes/_authenticated+/t.$teamUrl+/settings.document.tsxindex fd734847f..027a6f170 100644--- a/apps/remix/app/routes/_authenticated+/t.$teamUrl+/settings.document.tsx+++ b/apps/remix/app/routes/_authenticated+/t.$teamUrl+/settings.document.tsx@@ -82,7 +82,7 @@ export default function TeamsSettingsPage() {uploadSignatureEnabled: signatureTypes.includes(DocumentSignatureType.UPLOAD),drawSignatureEnabled: signatureTypes.includes(DocumentSignatureType.DRAW),}),- delegateDocumentOwnership: delegateDocumentOwnership,+ delegateDocumentOwnership,},});