Skip to content

The Open Source DocuSign Alternative.

fix: reset field metadata when changing field type (#3431)

Catalin Pit05ffb3e323de
diff --git a/apps/docs/content/docs/developers/api/fields.mdx b/apps/docs/content/docs/developers/api/fields.mdx
index 0cec72339..918f62cad 100644
--- a/apps/docs/content/docs/developers/api/fields.mdx
+++ b/apps/docs/content/docs/developers/api/fields.mdx
@@ -339,7 +339,7 @@ POST /envelope/field/update-many
| `envelopeId` | string | Yes | The envelope ID |
| `data` | array | Yes | Array of field update objects |
-Each entry in `data` requires the field `id` and `type`. Position properties (`page`, `positionX`, `positionY`, `width`, `height`), `envelopeItemId`, and `fieldMeta` are optional — only supplied values are updated. Placeholder positioning is not supported when updating; use coordinates.
+Each entry in `data` requires the field `id` and `type`. Position properties (`page`, `positionX`, `positionY`, `width`, `height`), `envelopeItemId`, and `fieldMeta` are optional — only provided values are updated. When `fieldMeta` is provided, it replaces the stored `fieldMeta` as a whole, so include every property you want to keep. Changing `type` without providing `fieldMeta` applies the default `fieldMeta` for the new type. Placeholder positioning is not supported when updating; use coordinates.
### Code Examples
diff --git a/packages/lib/server-only/field/update-envelope-fields.ts b/packages/lib/server-only/field/update-envelope-fields.ts
index 42d016ca6..fec044a41 100644
--- a/packages/lib/server-only/field/update-envelope-fields.ts
+++ b/packages/lib/server-only/field/update-envelope-fields.ts
@@ -1,5 +1,6 @@
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
import type { TFieldMetaSchema } from '@documenso/lib/types/field-meta';
+import { FIELD_META_DEFAULT_VALUES } from '@documenso/lib/types/field-meta';
import type { ApiRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
import { createDocumentAuditLogData, diffFieldChanges } from '@documenso/lib/utils/document-audit-logs';
import { prisma } from '@documenso/prisma';
@@ -95,7 +96,12 @@ export const updateEnvelopeFields = async ({
}
const fieldType = field.type || originalField.type;
- const fieldMetaType = field.fieldMeta?.type || originalField.fieldMeta?.type;
+ const isFieldTypeChanged = fieldType !== originalField.type;
+
+ // An omitted fieldMeta keeps the stored one, unless the field type changes.
+ const fallbackFieldMeta = isFieldTypeChanged ? FIELD_META_DEFAULT_VALUES[fieldType] : undefined;
+ const fieldMeta = field.fieldMeta ?? fallbackFieldMeta;
+ const fieldMetaType = fieldMeta?.type || originalField.fieldMeta?.type;
// Not going to mess with V1 envelopes.
if (envelope.internalVersion === 2 && fieldMetaType && fieldMetaType.toLowerCase() !== fieldType.toLowerCase()) {
@@ -112,7 +118,10 @@ export const updateEnvelopeFields = async ({
return {
originalField,
- updateData: field,
+ updateData: {
+ ...field,
+ fieldMeta,
+ },
recipientEmail: recipient.email,
};
});
diff --git a/packages/trpc/server/envelope-router/envelope-fields/update-envelope-fields.types.ts b/packages/trpc/server/envelope-router/envelope-fields/update-envelope-fields.types.ts
index 4e718de48..89198a6c4 100644
--- a/packages/trpc/server/envelope-router/envelope-fields/update-envelope-fields.types.ts
+++ b/packages/trpc/server/envelope-router/envelope-fields/update-envelope-fields.types.ts
@@ -1,5 +1,5 @@
import { ZFieldSchema } from '@documenso/lib/types/field';
-import { ZEnvelopeFieldAndMetaSchema } from '@documenso/lib/types/field-meta';
+import { ZFieldAndMetaSchema } from '@documenso/lib/types/field-meta';
import { z } from 'zod';
import type { TrpcRouteMeta } from '../../trpc';
@@ -15,7 +15,7 @@ export const updateEnvelopeFieldsMeta: TrpcRouteMeta = {
},
};
-const ZUpdateFieldBaseSchema = ZEnvelopeFieldAndMetaSchema.and(
+const ZUpdateFieldBaseSchema = ZFieldAndMetaSchema.and(
z.object({
id: z.number().describe('The ID of the field to update.'),
envelopeItemId: z