feat: assistant role (#1588)

Introduces the ability for users with the **Assistant** role to prefill
fields on behalf of other signers. Assistants can fill in various field
types such as text, checkboxes, dates, and more, streamlining the
document preparation process before it reaches the final signers.

apps/remix/app/components/general/document-signing/document-signing-page-view.tsx

@@ -1,5 +1,7 @@
+import { useState } from 'react';
+
 import { Trans } from '@lingui/react/macro';
-import type { Field, Recipient } from '@prisma/client';
+import type { Field } from '@prisma/client';
 import { FieldType, RecipientRole } from '@prisma/client';
 import { match } from 'ts-pattern';
 
@@ -16,6 +18,7 @@ import {
 } from '@documenso/lib/types/field-meta';
 import type { CompletedField } from '@documenso/lib/types/fields';
 import type { FieldWithSignatureAndFieldMeta } from '@documenso/prisma/types/field-with-signature-and-fieldmeta';
+import type { RecipientWithFields } from '@documenso/prisma/types/recipient-with-fields';
 import { Card, CardContent } from '@documenso/ui/primitives/card';
 import { ElementVisible } from '@documenso/ui/primitives/element-visible';
 import { LazyPDFViewer } from '@documenso/ui/primitives/lazy-pdf-viewer';
@@ -35,12 +38,15 @@ import { DocumentSigningSignatureField } from '~/components/general/document-sig
 import { DocumentSigningTextField } from '~/components/general/document-signing/document-signing-text-field';
 import { DocumentReadOnlyFields } from '~/components/general/document/document-read-only-fields';
 
+import { DocumentSigningRecipientProvider } from './document-signing-recipient-provider';
+
 export type SigningPageViewProps = {
   document: DocumentAndSender;
-  recipient: Recipient;
+  recipient: RecipientWithFields;
   fields: Field[];
   completedFields: CompletedField[];
   isRecipientsTurn: boolean;
+  allRecipients?: RecipientWithFields[];
 };
 
 export const DocumentSigningPageView = ({
@@ -49,9 +55,12 @@ export const DocumentSigningPageView = ({
   fields,
   completedFields,
   isRecipientsTurn,
+  allRecipients = [],
 }: SigningPageViewProps) => {
   const { documentData, documentMeta } = document;
 
+  const [selectedSignerId, setSelectedSignerId] = useState<number | null>(allRecipients?.[0]?.id);
+
   const shouldUseTeamDetails =
     document.teamId && document.team?.teamGlobalSettings?.includeSenderDetails === false;
 
@@ -63,183 +72,170 @@ export const DocumentSigningPageView = ({
     senderEmail = document.team?.teamEmail?.email ? `(${document.team.teamEmail.email})` : '';
   }
 
+  const selectedSigner = allRecipients?.find((r) => r.id === selectedSignerId);
+
   return (
-    <div className="mx-auto w-full max-w-screen-xl">
-      <h1
-        className="mt-4 block max-w-[20rem] truncate text-2xl font-semibold md:max-w-[30rem] md:text-3xl"
-        title={document.title}
-      >
-        {document.title}
-      </h1>
-
-      <div className="mt-2.5 flex flex-wrap items-center justify-between gap-x-6">
-        <div className="max-w-[50ch]">
-          <span className="text-muted-foreground truncate" title={senderName}>
-            {senderName} {senderEmail}
-          </span>{' '}
-          <span className="text-muted-foreground">
-            {match(recipient.role)
-              .with(RecipientRole.VIEWER, () =>
-                document.teamId && !shouldUseTeamDetails ? (
-                  <Trans>
-                    on behalf of "{document.team?.name}" has invited you to view this document
-                  </Trans>
-                ) : (
-                  <Trans>has invited you to view this document</Trans>
-                ),
-              )
-              .with(RecipientRole.SIGNER, () =>
-                document.teamId && !shouldUseTeamDetails ? (
-                  <Trans>
-                    on behalf of "{document.team?.name}" has invited you to sign this document
-                  </Trans>
-                ) : (
-                  <Trans>has invited you to sign this document</Trans>
-                ),
-              )
-              .with(RecipientRole.APPROVER, () =>
-                document.teamId && !shouldUseTeamDetails ? (
-                  <Trans>
-                    on behalf of "{document.team?.name}" has invited you to approve this document
-                  </Trans>
-                ) : (
-                  <Trans>has invited you to approve this document</Trans>
-                ),
-              )
-              .otherwise(() => null)}
-          </span>
-        </div>
-
-        <DocumentSigningRejectDialog document={document} token={recipient.token} />
-      </div>
-
-      <div className="mt-8 grid grid-cols-12 gap-y-8 lg:gap-x-8 lg:gap-y-0">
-        <Card
-          className="col-span-12 rounded-xl before:rounded-xl lg:col-span-7 xl:col-span-8"
-          gradient
+    <DocumentSigningRecipientProvider recipient={recipient} targetSigner={selectedSigner ?? null}>
+      <div className="mx-auto w-full max-w-screen-xl">
+        <h1
+          className="mt-4 block max-w-[20rem] truncate text-2xl font-semibold md:max-w-[30rem] md:text-3xl"
+          title={document.title}
         >
-          <CardContent className="p-2">
-            <LazyPDFViewer
-              key={documentData.id}
-              documentData={documentData}
-              document={document}
-              password={documentMeta?.password}
-            />
-          </CardContent>
-        </Card>
+          {document.title}
+        </h1>
 
-        <div className="col-span-12 lg:col-span-5 xl:col-span-4">
-          <DocumentSigningForm
-            document={document}
-            recipient={recipient}
-            fields={fields}
-            redirectUrl={documentMeta?.redirectUrl}
-            isRecipientsTurn={isRecipientsTurn}
-          />
+        <div className="mt-2.5 flex flex-wrap items-center justify-between gap-x-6">
+          <div className="max-w-[50ch]">
+            <span className="text-muted-foreground truncate" title={senderName}>
+              {senderName} {senderEmail}
+            </span>{' '}
+            <span className="text-muted-foreground">
+              {match(recipient.role)
+                .with(RecipientRole.VIEWER, () =>
+                  document.teamId && !shouldUseTeamDetails ? (
+                    <Trans>
+                      on behalf of "{document.team?.name}" has invited you to view this document
+                    </Trans>
+                  ) : (
+                    <Trans>has invited you to view this document</Trans>
+                  ),
+                )
+                .with(RecipientRole.SIGNER, () =>
+                  document.teamId && !shouldUseTeamDetails ? (
+                    <Trans>
+                      on behalf of "{document.team?.name}" has invited you to sign this document
+                    </Trans>
+                  ) : (
+                    <Trans>has invited you to sign this document</Trans>
+                  ),
+                )
+                .with(RecipientRole.APPROVER, () =>
+                  document.teamId && !shouldUseTeamDetails ? (
+                    <Trans>
+                      on behalf of "{document.team?.name}" has invited you to approve this document
+                    </Trans>
+                  ) : (
+                    <Trans>has invited you to approve this document</Trans>
+                  ),
+                )
+                .with(RecipientRole.ASSISTANT, () =>
+                  document.teamId && !shouldUseTeamDetails ? (
+                    <Trans>
+                      on behalf of "{document.team?.name}" has invited you to assist this document
+                    </Trans>
+                  ) : (
+                    <Trans>has invited you to assist this document</Trans>
+                  ),
+                )
+                .otherwise(() => null)}
+            </span>
+          </div>
+
+          <DocumentSigningRejectDialog document={document} token={recipient.token} />
         </div>
-      </div>
 
-      <DocumentReadOnlyFields fields={completedFields} />
-
-      <DocumentSigningAutoSign recipient={recipient} fields={fields} />
-
-      <ElementVisible target={PDF_VIEWER_PAGE_SELECTOR}>
-        {fields.map((field) =>
-          match(field.type)
-            .with(FieldType.SIGNATURE, () => (
-              <DocumentSigningSignatureField
-                key={field.id}
-                field={field}
-                recipient={recipient}
-                typedSignatureEnabled={documentMeta?.typedSignatureEnabled}
+        <div className="mt-8 grid grid-cols-12 gap-y-8 lg:gap-x-8 lg:gap-y-0">
+          <Card
+            className="col-span-12 rounded-xl before:rounded-xl lg:col-span-7 xl:col-span-8"
+            gradient
+          >
+            <CardContent className="p-2">
+              <LazyPDFViewer
+                key={documentData.id}
+                documentData={documentData}
+                document={document}
+                password={documentMeta?.password}
               />
-            ))
-            .with(FieldType.INITIALS, () => (
-              <DocumentSigningInitialsField key={field.id} field={field} recipient={recipient} />
-            ))
-            .with(FieldType.NAME, () => (
-              <DocumentSigningNameField key={field.id} field={field} recipient={recipient} />
-            ))
-            .with(FieldType.DATE, () => (
-              <DocumentSigningDateField
-                key={field.id}
-                field={field}
-                recipient={recipient}
-                dateFormat={documentMeta?.dateFormat ?? DEFAULT_DOCUMENT_DATE_FORMAT}
-                timezone={documentMeta?.timezone ?? DEFAULT_DOCUMENT_TIME_ZONE}
-              />
-            ))
-            .with(FieldType.EMAIL, () => (
-              <DocumentSigningEmailField key={field.id} field={field} recipient={recipient} />
-            ))
-            .with(FieldType.TEXT, () => {
-              const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
-                ...field,
-                fieldMeta: field.fieldMeta ? ZTextFieldMeta.parse(field.fieldMeta) : null,
-              };
-              return (
-                <DocumentSigningTextField
-                  key={field.id}
-                  field={fieldWithMeta}
-                  recipient={recipient}
-                />
-              );
-            })
-            .with(FieldType.NUMBER, () => {
-              const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
-                ...field,
-                fieldMeta: field.fieldMeta ? ZNumberFieldMeta.parse(field.fieldMeta) : null,
-              };
-              return (
-                <DocumentSigningNumberField
-                  key={field.id}
-                  field={fieldWithMeta}
-                  recipient={recipient}
-                />
-              );
-            })
-            .with(FieldType.RADIO, () => {
-              const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
-                ...field,
-                fieldMeta: field.fieldMeta ? ZRadioFieldMeta.parse(field.fieldMeta) : null,
-              };
-              return (
-                <DocumentSigningRadioField
-                  key={field.id}
-                  field={fieldWithMeta}
-                  recipient={recipient}
-                />
-              );
-            })
-            .with(FieldType.CHECKBOX, () => {
-              const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
-                ...field,
-                fieldMeta: field.fieldMeta ? ZCheckboxFieldMeta.parse(field.fieldMeta) : null,
-              };
-              return (
-                <DocumentSigningCheckboxField
-                  key={field.id}
-                  field={fieldWithMeta}
-                  recipient={recipient}
-                />
-              );
-            })
-            .with(FieldType.DROPDOWN, () => {
-              const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
-                ...field,
-                fieldMeta: field.fieldMeta ? ZDropdownFieldMeta.parse(field.fieldMeta) : null,
-              };
-              return (
-                <DocumentSigningDropdownField
-                  key={field.id}
-                  field={fieldWithMeta}
-                  recipient={recipient}
-                />
-              );
-            })
-            .otherwise(() => null),
+            </CardContent>
+          </Card>
+
+          <div className="col-span-12 lg:col-span-5 xl:col-span-4">
+            <DocumentSigningForm
+              document={document}
+              recipient={recipient}
+              fields={fields}
+              redirectUrl={documentMeta?.redirectUrl}
+              isRecipientsTurn={isRecipientsTurn}
+              allRecipients={allRecipients}
+              setSelectedSignerId={setSelectedSignerId}
+            />
+          </div>
+        </div>
+
+        <DocumentReadOnlyFields fields={completedFields} />
+
+        {recipient.role !== RecipientRole.ASSISTANT && (
+          <DocumentSigningAutoSign recipient={recipient} fields={fields} />
         )}
-      </ElementVisible>
-    </div>
+
+        <ElementVisible target={PDF_VIEWER_PAGE_SELECTOR}>
+          {fields
+            .filter(
+              (field) =>
+                recipient.role !== RecipientRole.ASSISTANT ||
+                field.recipientId === selectedSigner?.id,
+            )
+            .map((field) =>
+              match(field.type)
+                .with(FieldType.SIGNATURE, () => (
+                  <DocumentSigningSignatureField key={field.id} field={field} />
+                ))
+                .with(FieldType.INITIALS, () => (
+                  <DocumentSigningInitialsField key={field.id} field={field} />
+                ))
+                .with(FieldType.NAME, () => (
+                  <DocumentSigningNameField key={field.id} field={field} />
+                ))
+                .with(FieldType.DATE, () => (
+                  <DocumentSigningDateField
+                    key={field.id}
+                    field={field}
+                    dateFormat={documentMeta?.dateFormat ?? DEFAULT_DOCUMENT_DATE_FORMAT}
+                    timezone={documentMeta?.timezone ?? DEFAULT_DOCUMENT_TIME_ZONE}
+                  />
+                ))
+                .with(FieldType.EMAIL, () => (
+                  <DocumentSigningEmailField key={field.id} field={field} />
+                ))
+                .with(FieldType.TEXT, () => {
+                  const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
+                    ...field,
+                    fieldMeta: field.fieldMeta ? ZTextFieldMeta.parse(field.fieldMeta) : null,
+                  };
+                  return <DocumentSigningTextField key={field.id} field={fieldWithMeta} />;
+                })
+                .with(FieldType.NUMBER, () => {
+                  const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
+                    ...field,
+                    fieldMeta: field.fieldMeta ? ZNumberFieldMeta.parse(field.fieldMeta) : null,
+                  };
+                  return <DocumentSigningNumberField key={field.id} field={fieldWithMeta} />;
+                })
+                .with(FieldType.RADIO, () => {
+                  const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
+                    ...field,
+                    fieldMeta: field.fieldMeta ? ZRadioFieldMeta.parse(field.fieldMeta) : null,
+                  };
+                  return <DocumentSigningRadioField key={field.id} field={fieldWithMeta} />;
+                })
+                .with(FieldType.CHECKBOX, () => {
+                  const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
+                    ...field,
+                    fieldMeta: field.fieldMeta ? ZCheckboxFieldMeta.parse(field.fieldMeta) : null,
+                  };
+                  return <DocumentSigningCheckboxField key={field.id} field={fieldWithMeta} />;
+                })
+                .with(FieldType.DROPDOWN, () => {
+                  const fieldWithMeta: FieldWithSignatureAndFieldMeta = {
+                    ...field,
+                    fieldMeta: field.fieldMeta ? ZDropdownFieldMeta.parse(field.fieldMeta) : null,
+                  };
+                  return <DocumentSigningDropdownField key={field.id} field={fieldWithMeta} />;
+                })
+                .otherwise(() => null),
+            )}
+        </ElementVisible>
+      </div>
+    </DocumentSigningRecipientProvider>
   );
 };