The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
feat: allow add myself feature for embeds (#2754)
David Nguyen6a6ef8d2ad86
diff --git a/apps/docs/content/docs/developers/embedding/authoring/v2.mdx b/apps/docs/content/docs/developers/embedding/authoring/v2.mdxindex a21a4069c..92b3b580d 100644--- a/apps/docs/content/docs/developers/embedding/authoring/v2.mdx+++ b/apps/docs/content/docs/developers/embedding/authoring/v2.mdx@@ -102,17 +102,18 @@ const EnvelopeEditor = ({ presignToken, envelopeId }) => {### All V2 Authoring Components-| Prop | Type | Required | Description |-| ------------------ | --------- | -------- | -------------------------------------------------------- |-| `presignToken` | `string` | Yes | Authentication token from your backend |-| `externalId` | `string` | No | Your reference ID to link with the envelope |-| `host` | `string` | No | Custom host URL. Defaults to `https://app.documenso.com` |-| `css` | `string` | No | Custom CSS string (Platform Plan) |-| `cssVars` | `object` | No | [CSS variable](/docs/developers/embedding/css-variables) overrides (Platform Plan) |-| `darkModeDisabled` | `boolean` | No | Disable dark mode (Platform Plan) |-| `language` | `string` | No | Set the UI language. See [Supported Languages](https://github.com/documenso/documenso/tree/main/packages/lib/constants/locales.ts) |-| `className` | `string` | No | CSS class for the iframe |-| `features` | `object` | No | Feature toggles for the authoring experience |+| Prop | Type | Required | Description |+| ---------------- | --------- | -------- | -------------------------------------------------------- |+| `presignToken` | `string` | Yes | Authentication token from your backend |+| `externalId` | `string` | No | Your reference ID to link with the envelope |+| `host` | `string` | No | Custom host URL. Defaults to `https://app.documenso.com` |+| `css` | `string` | No | Custom CSS string (Platform Plan) |+| `cssVars` | `object` | No | [CSS variable](/docs/developers/embedding/css-variables) overrides (Platform Plan) |+| `darkModeDisabled` | `boolean` | No | Disable dark mode (Platform Plan) |+| `language` | `string` | No | Set the UI language. See [Supported Languages](https://github.com/documenso/documenso/tree/main/packages/lib/constants/locales.ts) |+| `className` | `string` | No | CSS class for the iframe |+| `user` | `object` | No | Current user info. When provided, enables the "Add Myself" button in the recipients list. Object with optional `email` and `name` fields |+| `features` | `object` | No | Feature toggles for the authoring experience |### Create Component Onlydiff --git a/apps/remix/app/components/general/envelope-editor/envelope-editor-recipient-form.tsx b/apps/remix/app/components/general/envelope-editor/envelope-editor-recipient-form.tsxindex 49ef68e27..cee9a45b7 100644--- a/apps/remix/app/components/general/envelope-editor/envelope-editor-recipient-form.tsx+++ b/apps/remix/app/components/general/envelope-editor/envelope-editor-recipient-form.tsx@@ -208,8 +208,14 @@ export const EnvelopeEditorRecipientForm = () => {envelope.fields.filter((field) => field.recipientId === signer.id).length === 0,);+ const currentEditorEmail = isEmbedded ? editorConfig.embedded?.user?.email : user?.email;++ const currentEditorName = isEmbedded ? editorConfig.embedded?.user?.name : user?.name;++ const hasCurrentEditorInfo = Boolean(currentEditorEmail || currentEditorName);+const isUserAlreadyARecipient = watchedSigners.some(- (signer) => signer.email.toLowerCase() === user?.email?.toLowerCase(),+ (signer) => signer.email.toLowerCase() === currentEditorEmail?.toLowerCase(),);const hasDocumentBeenSent = recipients.some(@@ -344,11 +350,11 @@ export const EnvelopeEditorRecipientForm = () => {const onAddSelfSigner = () => {if (emptySignerIndex !== -1) {- setValue(`signers.${emptySignerIndex}.name`, user?.name ?? '', {+ setValue(`signers.${emptySignerIndex}.name`, currentEditorName ?? '', {shouldValidate: true,shouldDirty: true,});- setValue(`signers.${emptySignerIndex}.email`, user?.email ?? '', {+ setValue(`signers.${emptySignerIndex}.email`, currentEditorEmail ?? '', {shouldValidate: true,shouldDirty: true,});@@ -358,8 +364,8 @@ export const EnvelopeEditorRecipientForm = () => {appendSigner({formId: nanoid(12),- name: user?.name ?? '',- email: user?.email ?? '',+ name: currentEditorName ?? '',+ email: currentEditorEmail ?? '',role: RecipientRole.SIGNER,actionAuth: [],signingOrder:@@ -635,7 +641,7 @@ export const EnvelopeEditorRecipientForm = () => {</Tooltip>)}- {!isEmbedded && (+ {(!isEmbedded || hasCurrentEditorInfo) && (<Buttonvariant="outline"className="flex flex-row items-center"diff --git a/apps/remix/app/routes/embed+/v2+/authoring+/envelope.create._index.tsx b/apps/remix/app/routes/embed+/v2+/authoring+/envelope.create._index.tsxindex 57925c5e7..ce81c8f5a 100644--- a/apps/remix/app/routes/embed+/v2+/authoring+/envelope.create._index.tsx+++ b/apps/remix/app/routes/embed+/v2+/authoring+/envelope.create._index.tsx@@ -298,6 +298,7 @@ const EnvelopeCreatePage = ({ embedAuthoringOptions }: EnvelopeCreatePageProps)mode: 'create' as const,onCreate: async (envelope: Omit<TEditorEnvelope, 'id'>) => createEmbeddedEnvelope(envelope),customBrandingLogo: Boolean(teamSettings.brandingEnabled && teamSettings.brandingLogo),+ user: embedAuthoringOptions.user,}),[token],);diff --git a/apps/remix/app/routes/embed+/v2+/authoring+/envelope.edit.$id.tsx b/apps/remix/app/routes/embed+/v2+/authoring+/envelope.edit.$id.tsxindex f2f9f6816..4b79de42a 100644--- a/apps/remix/app/routes/embed+/v2+/authoring+/envelope.edit.$id.tsx+++ b/apps/remix/app/routes/embed+/v2+/authoring+/envelope.edit.$id.tsx@@ -314,6 +314,7 @@ const EnvelopeEditPage = ({ embedAuthoringOptions }: EnvelopeEditPageProps) => {mode: 'edit' as const,onUpdate: async (envelope: TEditorEnvelope) => updateEmbeddedEnvelope(envelope),brandingLogo,+ user: embedAuthoringOptions.user,}),[token],);diff --git a/packages/lib/types/envelope-editor.ts b/packages/lib/types/envelope-editor.tsindex a8b8787e5..a882b7d33 100644--- a/packages/lib/types/envelope-editor.ts+++ b/packages/lib/types/envelope-editor.ts@@ -220,11 +220,23 @@ export const ZEmbedCreateEnvelopeAuthoringSchema = ZBaseEmbedDataSchema.extend({externalId: z.string().optional(),type: z.nativeEnum(EnvelopeType),folderId: z.string().optional(),+ user: z+ .object({+ email: z.string().email().optional(),+ name: z.string().optional(),+ })+ .optional(),features: z.object({}).passthrough().optional().default(DEFAULT_EMBEDDED_EDITOR_CONFIG),});export const ZEmbedEditEnvelopeAuthoringSchema = ZBaseEmbedDataSchema.extend({externalId: z.string().optional(),+ user: z+ .object({+ email: z.string().email().optional(),+ name: z.string().optional(),+ })+ .optional(),features: z.object({}).passthrough().optional().default(DEFAULT_EMBEDDED_EDITOR_CONFIG),});@@ -323,5 +335,9 @@ export type EnvelopeEditorConfig = TEnvelopeEditorSettings & {onCreate?: (envelope: Omit<TEditorEnvelope, 'id'>) => void;onUpdate?: (envelope: TEditorEnvelope) => void;customBrandingLogo?: boolean;+ user?: {+ email?: string;+ name?: string;+ };};};