The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
fix: envelope autosave (#2103)
David Nguyenb0b07106b49e
diff --git a/apps/remix/app/components/forms/editor/editor-field-signature-form.tsx b/apps/remix/app/components/forms/editor/editor-field-signature-form.tsxindex 8d1469d0a..bf5d6ac26 100644--- a/apps/remix/app/components/forms/editor/editor-field-signature-form.tsx+++ b/apps/remix/app/components/forms/editor/editor-field-signature-form.tsx@@ -1,6 +1,7 @@import { useEffect } from 'react';import { zodResolver } from '@hookform/resolvers/zod';+import { Trans } from '@lingui/react/macro';import { useForm, useWatch } from 'react-hook-form';import type { z } from 'zod';@@ -60,7 +61,12 @@ export const EditorFieldSignatureForm = ({<Form {...form}><form><fieldset className="flex flex-col gap-2">- <EditorGenericFontSizeField formControl={form.control} />+ <div>+ <EditorGenericFontSizeField formControl={form.control} />+ <p className="text-muted-foreground mt-0.5 text-xs">+ <Trans>The typed signature font size</Trans>+ </p>+ </div></fieldset></form></Form>diff --git a/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page-renderer.tsx b/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page-renderer.tsxindex dab1d1215..c75fb52a5 100644--- a/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page-renderer.tsx+++ b/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page-renderer.tsx@@ -57,8 +57,6 @@ export default function EnvelopeEditorFieldsPageRenderer() {);const handleResizeOrMove = (event: KonvaEventObject<Event>) => {- console.log('Field resized or moved');-const { current: container } = canvasElement;if (!container) {@@ -273,9 +271,6 @@ export default function EnvelopeEditorFieldsPageRenderer() {return;}- console.log(`pointerPosition.x: ${pointerPosition.x}`);- console.log(`pointerPosition.y: ${pointerPosition.y}`);-x1 = pointerPosition.x / scale;y1 = pointerPosition.y / scale;x2 = pointerPosition.x / scale;diff --git a/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page.tsx b/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page.tsxindex 1f9bd878d..4bd0915da 100644--- a/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page.tsx+++ b/apps/remix/app/components/general/envelope-editor/envelope-editor-fields-page.tsx@@ -21,6 +21,7 @@ import type {TNameFieldMeta,TNumberFieldMeta,TRadioFieldMeta,+ TSignatureFieldMeta,TTextFieldMeta,} from '@documenso/lib/types/field-meta';import { canRecipientFieldsBeModified } from '@documenso/lib/utils/recipients';@@ -38,6 +39,7 @@ import { EditorFieldInitialsForm } from '~/components/forms/editor/editor-field-import { EditorFieldNameForm } from '~/components/forms/editor/editor-field-name-form';import { EditorFieldNumberForm } from '~/components/forms/editor/editor-field-number-form';import { EditorFieldRadioForm } from '~/components/forms/editor/editor-field-radio-form';+import { EditorFieldSignatureForm } from '~/components/forms/editor/editor-field-signature-form';import { EditorFieldTextForm } from '~/components/forms/editor/editor-field-text-form';import { EnvelopeEditorFieldDragDrop } from './envelope-editor-fields-drag-drop';@@ -189,7 +191,7 @@ export const EnvelopeEditorFieldsPage = () => {{/* Field details section. */}<AnimateGenericFadeInOut key={editorFields.selectedField?.formId}>- {selectedField && selectedField.type !== FieldType.SIGNATURE && (+ {selectedField && (<section><Separator className="my-4" />@@ -199,6 +201,12 @@ export const EnvelopeEditorFieldsPage = () => {</h3>{match(selectedField.type)+ .with(FieldType.SIGNATURE, () => (+ <EditorFieldSignatureForm+ value={selectedField?.fieldMeta as TSignatureFieldMeta | undefined}+ onValueChange={(value) => updateSelectedFieldMeta(value)}+ />+ )).with(FieldType.CHECKBOX, () => (<EditorFieldCheckboxFormvalue={selectedField?.fieldMeta as TCheckboxFieldMeta | undefined}diff --git a/packages/lib/client-only/hooks/use-editor-fields.ts b/packages/lib/client-only/hooks/use-editor-fields.tsindex ce0502850..68320856e 100644--- a/packages/lib/client-only/hooks/use-editor-fields.ts+++ b/packages/lib/client-only/hooks/use-editor-fields.ts@@ -50,6 +50,7 @@ type UseEditorFieldsResponse = {// Field operationsaddField: (field: Omit<TLocalField, 'formId'>) => TLocalField;+ setFieldId: (formId: string, id: number) => void;removeFieldsByFormId: (formIds: string[]) => void;updateFieldByFormId: (formId: string, updates: Partial<TLocalField>) => void;duplicateField: (field: TLocalField, recipientId?: number) => TLocalField;@@ -160,6 +161,17 @@ export const useEditorFields = ({[localFields, remove, triggerFieldsUpdate],);+ const setFieldId = (formId: string, id: number) => {+ const index = localFields.findIndex((field) => field.formId === formId);++ if (index !== -1) {+ update(index, {+ ...localFields[index],+ id,+ });+ }+ };+const updateFieldByFormId = useCallback((formId: string, updates: Partial<TLocalField>) => {const index = localFields.findIndex((field) => field.formId === formId);@@ -269,6 +281,7 @@ export const useEditorFields = ({// Field operationsaddField,+ setFieldId,removeFieldsByFormId,updateFieldByFormId,duplicateField,diff --git a/packages/lib/client-only/providers/envelope-editor-provider.tsx b/packages/lib/client-only/providers/envelope-editor-provider.tsxindex 0115a6ea7..a7473c9b0 100644--- a/packages/lib/client-only/providers/envelope-editor-provider.tsx+++ b/packages/lib/client-only/providers/envelope-editor-provider.tsx@@ -97,6 +97,11 @@ export const EnvelopeEditorProvider = ({const [envelope, setEnvelope] = useState(initialEnvelope);const [autosaveError, setAutosaveError] = useState<boolean>(false);+ const editorFields = useEditorFields({+ envelope,+ handleFieldsUpdate: (fields) => setFieldsDebounced(fields),+ });+const envelopeUpdateMutationQuery = trpc.envelope.update.useMutation({onSuccess: (response, input) => {setEnvelope({@@ -184,13 +189,24 @@ export const EnvelopeEditorProvider = ({triggerSave: setFieldsDebounced,flush: setFieldsAsync,isPending: isFieldsMutationPending,- } = useEnvelopeAutosave(async (fields: TLocalField[]) => {- await envelopeFieldSetMutationQuery.mutateAsync({+ } = useEnvelopeAutosave(async (localFields: TLocalField[]) => {+ const envelopeFields = await envelopeFieldSetMutationQuery.mutateAsync({envelopeId: envelope.id,envelopeType: envelope.type,- fields,+ fields: localFields,});- }, 1000);++ // Insert the IDs into the local fields.+ envelopeFields.fields.forEach((field) => {+ const localField = localFields.find((localField) => localField.formId === field.formId);++ if (localField && !localField.id) {+ localField.id = field.id;++ editorFields.setFieldId(localField.formId, field.id);+ }+ });+ }, 2000);const {triggerSave: setEnvelopeDebounced,@@ -221,11 +237,6 @@ export const EnvelopeEditorProvider = ({setEnvelopeDebounced(envelopeUpdates);};- const editorFields = useEditorFields({- envelope,- handleFieldsUpdate: (fields) => setFieldsDebounced(fields),- });-const getRecipientColorKey = useCallback((recipientId: number) => {const recipientIndex = envelope.recipients.findIndex(diff --git a/packages/lib/server-only/field/set-fields-for-document.ts b/packages/lib/server-only/field/set-fields-for-document.tsindex 502505f43..ef1bf3000 100644--- a/packages/lib/server-only/field/set-fields-for-document.ts+++ b/packages/lib/server-only/field/set-fields-for-document.ts@@ -306,7 +306,10 @@ export const setFieldsForDocument = async ({});}- return upsertedField;+ return {+ ...upsertedField,+ formId: field.formId,+ };}),);});@@ -340,17 +343,25 @@ export const setFieldsForDocument = async ({}// Filter out fields that have been removed or have been updated.- const filteredFields = existingFields.filter((field) => {- const isRemoved = removedFields.find((removedField) => removedField.id === field.id);- const isUpdated = persistedFields.find((persistedField) => persistedField.id === field.id);-- return !isRemoved && !isUpdated;- });+ const mappedFilteredFields = existingFields+ .filter((field) => {+ const isRemoved = removedFields.find((removedField) => removedField.id === field.id);+ const isUpdated = persistedFields.find((persistedField) => persistedField.id === field.id);++ return !isRemoved && !isUpdated;+ })+ .map((field) => ({+ ...mapFieldToLegacyField(field, envelope),+ formId: undefined,+ }));++ const mappedPersistentFields = persistedFields.map((field) => ({+ ...mapFieldToLegacyField(field, envelope),+ formId: field?.formId,+ }));return {- fields: [...filteredFields, ...persistedFields].map((field) =>- mapFieldToLegacyField(field, envelope),- ),+ fields: [...mappedFilteredFields, ...mappedPersistentFields],};};@@ -359,6 +370,7 @@ export const setFieldsForDocument = async ({*/type FieldData = {id?: number | null;+ formId?: string;envelopeItemId: string;type: FieldType;recipientId: number;diff --git a/packages/lib/server-only/field/set-fields-for-template.ts b/packages/lib/server-only/field/set-fields-for-template.tsindex c919c1016..2c36c164e 100644--- a/packages/lib/server-only/field/set-fields-for-template.ts+++ b/packages/lib/server-only/field/set-fields-for-template.ts@@ -27,6 +27,7 @@ export type SetFieldsForTemplateOptions = {id: EnvelopeIdOptions;fields: {id?: number | null;+ formId?: string;envelopeItemId: string;type: FieldType;recipientId: number;@@ -111,10 +112,10 @@ export const setFieldsForTemplate = async ({};});- const persistedFields = await prisma.$transaction(+ const persistedFields = await Promise.all(// Disabling as wrapping promises here causes type issues// eslint-disable-next-line @typescript-eslint/promise-function-async- linkedFields.map((field) => {+ linkedFields.map(async (field) => {const parsedFieldMeta = field.fieldMeta ? ZFieldMetaSchema.parse(field.fieldMeta) : undefined;if (field.type === FieldType.TEXT && field.fieldMeta) {@@ -176,7 +177,7 @@ export const setFieldsForTemplate = async ({}// Proceed with upsert operation- return prisma.field.upsert({+ const upsertedField = await prisma.field.upsert({where: {id: field._persisted?.id ?? -1,envelopeId: envelope.id,@@ -219,6 +220,11 @@ export const setFieldsForTemplate = async ({},},});++ return {+ ...upsertedField,+ formId: field.formId,+ };}),);@@ -240,9 +246,17 @@ export const setFieldsForTemplate = async ({return !isRemoved && !isUpdated;});+ const mappedFilteredFields = filteredFields.map((field) => ({+ ...mapFieldToLegacyField(field, envelope),+ formId: undefined,+ }));++ const mappedPersistentFields = persistedFields.map((field) => ({+ ...mapFieldToLegacyField(field, envelope),+ formId: field?.formId,+ }));+return {- fields: [...filteredFields, ...persistedFields].map((field) =>- mapFieldToLegacyField(field, envelope),- ),+ fields: [...mappedFilteredFields, ...mappedPersistentFields],};};diff --git a/packages/trpc/server/envelope-router/set-envelope-fields.ts b/packages/trpc/server/envelope-router/set-envelope-fields.tsindex a9e4c4873..445ec9785 100644--- a/packages/trpc/server/envelope-router/set-envelope-fields.ts+++ b/packages/trpc/server/envelope-router/set-envelope-fields.ts@@ -24,7 +24,7 @@ export const setEnvelopeFieldsRoute = authenticatedProcedure},});- await match(envelopeType)+ const result = await match(envelopeType).with(EnvelopeType.DOCUMENT, async () =>setFieldsForDocument({userId: ctx.user.id,@@ -63,4 +63,11 @@ export const setEnvelopeFieldsRoute = authenticatedProcedure}),).exhaustive();++ return {+ fields: result.fields.map((field) => ({+ id: field.id,+ formId: field.formId,+ })),+ };});diff --git a/packages/trpc/server/envelope-router/set-envelope-fields.types.ts b/packages/trpc/server/envelope-router/set-envelope-fields.types.tsindex 08437a09c..ea3fb6269 100644--- a/packages/trpc/server/envelope-router/set-envelope-fields.types.ts+++ b/packages/trpc/server/envelope-router/set-envelope-fields.types.ts@@ -12,6 +12,7 @@ export const ZSetEnvelopeFieldsRequestSchema = z.object({.number().optional().describe('The id of the field. If not provided, a new field will be created.'),+ formId: z.string().optional().describe('A temporary ID to keep track of new fields created'),envelopeItemId: z.string().describe('The id of the envelope item to put the field on'),recipientId: z.number(),type: z.nativeEnum(FieldType),@@ -45,7 +46,14 @@ export const ZSetEnvelopeFieldsRequestSchema = z.object({),});-export const ZSetEnvelopeFieldsResponseSchema = z.void();+export const ZSetEnvelopeFieldsResponseSchema = z.object({+ fields: z+ .object({+ id: z.number(),+ formId: z.string().optional(),+ })+ .array(),+});export type TSetEnvelopeFieldsRequest = z.infer<typeof ZSetEnvelopeFieldsRequestSchema>;export type TSetEnvelopeFieldsResponse = z.infer<typeof ZSetEnvelopeFieldsResponseSchema>;