Skip to content

The Open Source DocuSign Alternative.

fix: add special context to strings (#1954)

Konrade547b0b41022
diff --git a/packages/lib/constants/document.ts b/packages/lib/constants/document.ts
index d8e010f74..b0ce41584 100644
--- a/packages/lib/constants/document.ts
+++ b/packages/lib/constants/document.ts
@@ -49,15 +49,24 @@ type DocumentSignatureTypeData = {
export const DOCUMENT_SIGNATURE_TYPES = {
[DocumentSignatureType.DRAW]: {
- label: msg`Draw`,
+ label: msg({
+ message: `Draw`,
+ context: `Draw signatute type`,
+ }),
value: DocumentSignatureType.DRAW,
},
[DocumentSignatureType.TYPE]: {
- label: msg`Type`,
+ label: msg({
+ message: `Type`,
+ context: `Type signatute type`,
+ }),
value: DocumentSignatureType.TYPE,
},
[DocumentSignatureType.UPLOAD]: {
- label: msg`Upload`,
+ label: msg({
+ message: `Upload`,
+ context: `Upload signatute type`,
+ }),
value: DocumentSignatureType.UPLOAD,
},
} satisfies Record<DocumentSignatureType, DocumentSignatureTypeData>;
diff --git a/packages/lib/constants/recipient-roles.ts b/packages/lib/constants/recipient-roles.ts
index f95390968..378b00df5 100644
--- a/packages/lib/constants/recipient-roles.ts
+++ b/packages/lib/constants/recipient-roles.ts
@@ -4,39 +4,114 @@ import { RecipientRole } from '@prisma/client';
export const RECIPIENT_ROLES_DESCRIPTION = {
[RecipientRole.APPROVER]: {
- actionVerb: msg`Approve`,
- actioned: msg`Approved`,
- progressiveVerb: msg`Approving`,
- roleName: msg`Approver`,
- roleNamePlural: msg`Approvers`,
+ actionVerb: msg({
+ message: `Approve`,
+ context: `Recipient role action verb`,
+ }),
+ actioned: msg({
+ message: `Approved`,
+ context: `Recipient role actioned`,
+ }),
+ progressiveVerb: msg({
+ message: `Approving`,
+ context: `Recipient role progressive verb`,
+ }),
+ roleName: msg({
+ message: `Approver`,
+ context: `Recipient role name`,
+ }),
+ roleNamePlural: msg({
+ message: `Approvers`,
+ context: `Recipient role plural name`,
+ }),
},
[RecipientRole.CC]: {
- actionVerb: msg`CC`,
- actioned: msg`CC'd`,
- progressiveVerb: msg`CC`,
- roleName: msg`Cc`,
- roleNamePlural: msg`Ccers`,
+ actionVerb: msg({
+ message: `CC`,
+ context: `Recipient role action verb`,
+ }),
+ actioned: msg({
+ message: `CC'd`,
+ context: `Recipient role actioned`,
+ }),
+ progressiveVerb: msg({
+ message: `CC`,
+ context: `Recipient role progressive verb`,
+ }),
+ roleName: msg({
+ message: `Cc`,
+ context: `Recipient role name`,
+ }),
+ roleNamePlural: msg({
+ message: `Ccers`,
+ context: `Recipient role plural name`,
+ }),
},
[RecipientRole.SIGNER]: {
- actionVerb: msg`Sign`,
- actioned: msg`Signed`,
- progressiveVerb: msg`Signing`,
- roleName: msg`Signer`,
- roleNamePlural: msg`Signers`,
+ actionVerb: msg({
+ message: `Sign`,
+ context: `Recipient role action verb`,
+ }),
+ actioned: msg({
+ message: `Signed`,
+ context: `Recipient role actioned`,
+ }),
+ progressiveVerb: msg({
+ message: `Signing`,
+ context: `Recipient role progressive verb`,
+ }),
+ roleName: msg({
+ message: `Signer`,
+ context: `Recipient role name`,
+ }),
+ roleNamePlural: msg({
+ message: `Signers`,
+ context: `Recipient role plural name`,
+ }),
},
[RecipientRole.VIEWER]: {
- actionVerb: msg`View`,
- actioned: msg`Viewed`,
- progressiveVerb: msg`Viewing`,
- roleName: msg`Viewer`,
- roleNamePlural: msg`Viewers`,
+ actionVerb: msg({
+ message: `View`,
+ context: `Recipient role action verb`,
+ }),
+ actioned: msg({
+ message: `Viewed`,
+ context: `Recipient role actioned`,
+ }),
+ progressiveVerb: msg({
+ message: `Viewing`,
+ context: `Recipient role progressive verb`,
+ }),
+ roleName: msg({
+ message: `Viewer`,
+ context: `Recipient role name`,
+ }),
+ roleNamePlural: msg({
+ message: `Viewers`,
+ context: `Recipient role plural name`,
+ }),
},
[RecipientRole.ASSISTANT]: {
- actionVerb: msg`Assist`,
- actioned: msg`Assisted`,
- progressiveVerb: msg`Assisting`,
- roleName: msg`Assistant`,
- roleNamePlural: msg`Assistants`,
+ actionVerb: msg({
+ message: `Assist`,
+ context: `Recipient role action verb`,
+ }),
+ actioned: msg({
+ message: `Assisted`,
+ context: `Recipient role actioned`,
+ }),
+ progressiveVerb: msg({
+ message: `Assisting`,
+ context: `Recipient role progressive verb`,
+ }),
+ roleName: msg({
+ message: `Assistant`,
+ context: `Recipient role name`,
+ }),
+ roleNamePlural: msg({
+ message: `Assistants`,
+ context: `Recipient role plural name`,
+ }),
},
} satisfies Record<keyof typeof RecipientRole, unknown>;
diff --git a/packages/lib/utils/document-audit-logs.ts b/packages/lib/utils/document-audit-logs.ts
index 7617439e6..2f43434ca 100644
--- a/packages/lib/utils/document-audit-logs.ts
+++ b/packages/lib/utils/document-audit-logs.ts
@@ -305,87 +305,151 @@ export const formatDocumentAuditLogAction = (
const description = match(auditLog)
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.FIELD_CREATED }, () => ({
- anonymous: msg`A field was added`,
+ anonymous: msg({
+ message: `A field was added`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} added a field`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.FIELD_DELETED }, () => ({
- anonymous: msg`A field was removed`,
+ anonymous: msg({
+ message: `A field was removed`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} removed a field`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.FIELD_UPDATED }, () => ({
- anonymous: msg`A field was updated`,
+ anonymous: msg({
+ message: `A field was updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated a field`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_CREATED }, () => ({
- anonymous: msg`A recipient was added`,
+ anonymous: msg({
+ message: `A recipient was added`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} added a recipient`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_DELETED }, () => ({
- anonymous: msg`A recipient was removed`,
+ anonymous: msg({
+ message: `A recipient was removed`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} removed a recipient`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_UPDATED }, () => ({
- anonymous: msg`A recipient was updated`,
+ anonymous: msg({
+ message: `A recipient was updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated a recipient`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_CREATED }, () => ({
- anonymous: msg`Document created`,
+ anonymous: msg({
+ message: `Document created`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} created the document`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_DELETED }, () => ({
- anonymous: msg`Document deleted`,
+ anonymous: msg({
+ message: `Document deleted`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} deleted the document`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_FIELD_INSERTED }, () => ({
- anonymous: msg`Field signed`,
+ anonymous: msg({
+ message: `Field signed`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} signed a field`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_FIELD_UNINSERTED }, () => ({
- anonymous: msg`Field unsigned`,
+ anonymous: msg({
+ message: `Field unsigned`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} unsigned a field`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_FIELD_PREFILLED }, () => ({
- anonymous: msg`Field prefilled by assistant`,
+ anonymous: msg({
+ message: `Field prefilled by assistant`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} prefilled a field`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VISIBILITY_UPDATED }, () => ({
- anonymous: msg`Document visibility updated`,
+ anonymous: msg({
+ message: `Document visibility updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated the document visibility`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED }, () => ({
- anonymous: msg`Document access auth updated`,
+ anonymous: msg({
+ message: `Document access auth updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated the document access auth requirements`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED }, () => ({
- anonymous: msg`Document signing auth updated`,
+ anonymous: msg({
+ message: `Document signing auth updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated the document signing auth requirements`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_META_UPDATED }, () => ({
- anonymous: msg`Document updated`,
+ anonymous: msg({
+ message: `Document updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated the document`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED }, () => ({
- anonymous: msg`Document opened`,
+ anonymous: msg({
+ message: `Document opened`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} opened the document`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VIEWED }, () => ({
- anonymous: msg`Document viewed`,
+ anonymous: msg({
+ message: `Document viewed`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} viewed the document`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_TITLE_UPDATED }, () => ({
- anonymous: msg`Document title updated`,
+ anonymous: msg({
+ message: `Document title updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated the document title`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_EXTERNAL_ID_UPDATED }, () => ({
- anonymous: msg`Document external ID updated`,
+ anonymous: msg({
+ message: `Document external ID updated`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} updated the document external ID`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_SENT }, () => ({
- anonymous: msg`Document sent`,
+ anonymous: msg({
+ message: `Document sent`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} sent the document`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM }, () => ({
anonymous: msg`Document moved to team`,
+ anonymous: msg({
+ message: `Document moved to team`,
+ context: `Audit log format`,
+ }),
identified: msg`${prefix} moved the document to team`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED }, ({ data }) => {
@@ -420,8 +484,14 @@ export const formatDocumentAuditLogAction = (
: msg`${prefix} sent an email to ${data.recipientEmail}`,
}))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_COMPLETED }, () => ({
- anonymous: msg`Document completed`,
- identified: msg`Document completed`,
+ anonymous: msg({
+ message: `Document completed`,
+ context: `Audit log format`,
+ }),
+ identified: msg({
+ message: `Document completed`,
+ context: `Audit log format`,
+ }),
}))
.exhaustive();