Skip to content

The Open Source DocuSign Alternative.

feat: Ability to send team invitation in bulk (#930)

Anik Dhabal Babub87154001a81
diff --git a/apps/web/package.json b/apps/web/package.json
index 484659740..71b480000 100644
--- a/apps/web/package.json
+++ b/apps/web/package.json
@@ -36,6 +36,7 @@
"next-axiom": "^1.1.1",
"next-plausible": "^3.10.1",
"next-themes": "^0.2.1",
+ "papaparse": "^5.4.1",
"perfect-freehand": "^1.2.0",
"posthog-js": "^1.75.3",
"posthog-node": "^3.1.1",
@@ -59,6 +60,7 @@
"@types/formidable": "^2.0.6",
"@types/luxon": "^3.3.1",
"@types/node": "20.1.0",
+ "@types/papaparse": "^5.3.14",
"@types/react": "18.2.18",
"@types/react-dom": "18.2.7",
"@types/ua-parser-js": "^0.7.39",
diff --git a/apps/web/src/components/(teams)/dialogs/invite-team-member-dialog.tsx b/apps/web/src/components/(teams)/dialogs/invite-team-member-dialog.tsx
index 482142c99..4adceda3d 100644
--- a/apps/web/src/components/(teams)/dialogs/invite-team-member-dialog.tsx
+++ b/apps/web/src/components/(teams)/dialogs/invite-team-member-dialog.tsx
@@ -1,19 +1,22 @@
'use client';
-import { useEffect, useState } from 'react';
+import { useEffect, useRef, useState } from 'react';
import { zodResolver } from '@hookform/resolvers/zod';
import type * as DialogPrimitive from '@radix-ui/react-dialog';
-import { Mail, PlusCircle, Trash } from 'lucide-react';
+import { Download, Mail, MailIcon, PlusCircle, Trash, Upload, UsersIcon } from 'lucide-react';
+import Papa, { type ParseResult } from 'papaparse';
import { useFieldArray, useForm } from 'react-hook-form';
import { z } from 'zod';
+import { downloadFile } from '@documenso/lib/client-only/download-file';
import { TEAM_MEMBER_ROLE_HIERARCHY, TEAM_MEMBER_ROLE_MAP } from '@documenso/lib/constants/teams';
import { TeamMemberRole } from '@documenso/prisma/client';
import { trpc } from '@documenso/trpc/react';
import { ZCreateTeamMemberInvitesMutationSchema } from '@documenso/trpc/server/team-router/schema';
import { cn } from '@documenso/ui/lib/utils';
import { Button } from '@documenso/ui/primitives/button';
+import { Card, CardContent } from '@documenso/ui/primitives/card';
import {
Dialog,
DialogContent,
@@ -39,6 +42,7 @@ import {
SelectTrigger,
SelectValue,
} from '@documenso/ui/primitives/select';
+import { Tabs, TabsContent, TabsList, TabsTrigger } from '@documenso/ui/primitives/tabs';
import { useToast } from '@documenso/ui/primitives/use-toast';
export type InviteTeamMembersDialogProps = {
@@ -51,18 +55,45 @@ const ZInviteTeamMembersFormSchema = z
.object({
invitations: ZCreateTeamMemberInvitesMutationSchema.shape.invitations,
})
- .refine(
- (schema) => {
- const emails = schema.invitations.map((invitation) => invitation.email.toLowerCase());
+ // Display exactly which rows are duplicates.
+ .superRefine((items, ctx) => {
+ const uniqueEmails = new Map<string, number>();
- return new Set(emails).size === emails.length;
- },
- // Dirty hack to handle errors when .root is populated for an array type
- { message: 'Members must have unique emails', path: ['members__root'] },
- );
+ for (const [index, invitation] of items.invitations.entries()) {
+ const email = invitation.email.toLowerCase();
+
+ const firstFoundIndex = uniqueEmails.get(email);
+
+ if (firstFoundIndex === undefined) {
+ uniqueEmails.set(email, index);
+ continue;
+ }
+
+ ctx.addIssue({
+ code: z.ZodIssueCode.custom,
+ message: 'Emails must be unique',
+ path: ['invitations', index, 'email'],
+ });
+
+ ctx.addIssue({
+ code: z.ZodIssueCode.custom,
+ message: 'Emails must be unique',
+ path: ['invitations', firstFoundIndex, 'email'],
+ });
+ }
+ });
type TInviteTeamMembersFormSchema = z.infer<typeof ZInviteTeamMembersFormSchema>;
+type TabTypes = 'INDIVIDUAL' | 'BULK';
+
+const ZImportTeamMemberSchema = z.array(
+ z.object({
+ email: z.string().email(),
+ role: z.nativeEnum(TeamMemberRole),
+ }),
+);
+
export const InviteTeamMembersDialog = ({
currentUserTeamRole,
teamId,
@@ -70,6 +101,8 @@ export const InviteTeamMembersDialog = ({
...props
}: InviteTeamMembersDialogProps) => {
const [open, setOpen] = useState(false);
+ const fileInputRef = useRef<HTMLInputElement>(null);
+ const [invitationType, setInvitationType] = useState<TabTypes>('INDIVIDUAL');
const { toast } = useToast();
@@ -130,9 +163,75 @@ export const InviteTeamMembersDialog = ({
useEffect(() => {
if (!open) {
form.reset();
+ setInvitationType('INDIVIDUAL');
}
}, [open, form]);
+ const onFileInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+ if (!e.target.files?.length) {
+ return;
+ }
+
+ const csvFile = e.target.files[0];
+
+ Papa.parse(csvFile, {
+ skipEmptyLines: true,
+ comments: 'Work email,Job title',
+ complete: (results: ParseResult<string[]>) => {
+ const members = results.data.map((row) => {
+ const [email, role] = row;
+
+ return {
+ email: email.trim(),
+ role: role.trim().toUpperCase(),
+ };
+ });
+
+ // Remove the first row if it contains the headers.
+ if (members.length > 1 && members[0].role.toUpperCase() === 'ROLE') {
+ members.shift();
+ }
+
+ try {
+ const importedInvitations = ZImportTeamMemberSchema.parse(members);
+
+ form.setValue('invitations', importedInvitations);
+ form.clearErrors('invitations');
+
+ setInvitationType('INDIVIDUAL');
+ } catch (err) {
+ console.error(err.message);
+
+ toast({
+ variant: 'destructive',
+ title: 'Something went wrong',
+ description: 'Please check the CSV file and make sure it is according to our format',
+ });
+ }
+ },
+ });
+ };
+
+ const downloadTemplate = () => {
+ const data = [
+ { email: '[email protected]', role: 'Admin' },
+ { email: '[email protected]', role: 'Manager' },
+ { email: '[email protected]', role: 'Member' },
+ ];
+
+ const csvContent =
+ 'Email address,Role\n' + data.map((row) => `${row.email},${row.role}`).join('\n');
+
+ const blob = new Blob([csvContent], {
+ type: 'text/csv',
+ });
+
+ downloadFile({
+ filename: 'documenso-team-member-invites-template.csv',
+ data: blob,
+ });
+ };
+
return (
<Dialog
{...props}
@@ -152,92 +251,144 @@ export const InviteTeamMembersDialog = ({
</DialogDescription>
</DialogHeader>
- <Form {...form}>
- <form onSubmit={form.handleSubmit(onFormSubmit)}>
- <fieldset
- className="flex h-full flex-col space-y-4"
- disabled={form.formState.isSubmitting}
- >
- {teamMemberInvites.map((teamMemberInvite, index) => (
- <div className="flex w-full flex-row space-x-4" key={teamMemberInvite.id}>
- <FormField
- control={form.control}
- name={`invitations.${index}.email`}
- render={({ field }) => (
- <FormItem className="w-full">
- {index === 0 && <FormLabel required>Email address</FormLabel>}
- <FormControl>
- <Input className="bg-background" {...field} />
- </FormControl>
- <FormMessage />
- </FormItem>
- )}
- />
+ <Tabs
+ defaultValue="INDIVIDUAL"
+ value={invitationType}
+ // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+ onValueChange={(value) => setInvitationType(value as TabTypes)}
+ >
+ <TabsList className="w-full">
+ <TabsTrigger value="INDIVIDUAL" className="hover:text-foreground w-full">
+ <MailIcon size={20} className="mr-2" />
+ Invite Members
+ </TabsTrigger>
- <FormField
- control={form.control}
- name={`invitations.${index}.role`}
- render={({ field }) => (
- <FormItem className="w-full">
- {index === 0 && <FormLabel required>Role</FormLabel>}
- <FormControl>
- <Select {...field} onValueChange={field.onChange}>
- <SelectTrigger className="text-muted-foreground max-w-[200px]">
- <SelectValue />
- </SelectTrigger>
-
- <SelectContent position="popper">
- {TEAM_MEMBER_ROLE_HIERARCHY[currentUserTeamRole].map((role) => (
- <SelectItem key={role} value={role}>
- {TEAM_MEMBER_ROLE_MAP[role] ?? role}
- </SelectItem>
- ))}
- </SelectContent>
- </Select>
- </FormControl>
- <FormMessage />
- </FormItem>
- )}
- />
+ <TabsTrigger value="BULK" className="hover:text-foreground w-full">
+ <UsersIcon size={20} className="mr-2" /> Bulk Import
+ </TabsTrigger>
+ </TabsList>
+
+ <TabsContent value="INDIVIDUAL">
+ <Form {...form}>
+ <form onSubmit={form.handleSubmit(onFormSubmit)}>
+ <fieldset
+ className="flex h-full flex-col space-y-4"
+ disabled={form.formState.isSubmitting}
+ >
+ <div className="custom-scrollbar -m-1 max-h-[60vh] space-y-4 overflow-y-auto p-1">
+ {teamMemberInvites.map((teamMemberInvite, index) => (
+ <div className="flex w-full flex-row space-x-4" key={teamMemberInvite.id}>
+ <FormField
+ control={form.control}
+ name={`invitations.${index}.email`}
+ render={({ field }) => (
+ <FormItem className="w-full">
+ {index === 0 && <FormLabel required>Email address</FormLabel>}
+ <FormControl>
+ <Input className="bg-background" {...field} />
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ )}
+ />
- <button
+ <FormField
+ control={form.control}
+ name={`invitations.${index}.role`}
+ render={({ field }) => (
+ <FormItem className="w-full">
+ {index === 0 && <FormLabel required>Role</FormLabel>}
+ <FormControl>
+ <Select {...field} onValueChange={field.onChange}>
+ <SelectTrigger className="text-muted-foreground max-w-[200px]">
+ <SelectValue />
+ </SelectTrigger>
+
+ <SelectContent position="popper">
+ {TEAM_MEMBER_ROLE_HIERARCHY[currentUserTeamRole].map((role) => (
+ <SelectItem key={role} value={role}>
+ {TEAM_MEMBER_ROLE_MAP[role] ?? role}
+ </SelectItem>
+ ))}
+ </SelectContent>
+ </Select>
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ )}
+ />
+
+ <button
+ type="button"
+ className={cn(
+ 'justify-left inline-flex h-10 w-10 items-center text-slate-500 hover:opacity-80 disabled:cursor-not-allowed disabled:opacity-50',
+ index === 0 ? 'mt-8' : 'mt-0',
+ )}
+ disabled={teamMemberInvites.length === 1}
+ onClick={() => removeTeamMemberInvite(index)}
+ >
+ <Trash className="h-5 w-5" />
+ </button>
+ </div>
+ ))}
+ </div>
+
+ <Button
type="button"
- className={cn(
- 'justify-left inline-flex h-10 w-10 items-center text-slate-500 hover:opacity-80 disabled:cursor-not-allowed disabled:opacity-50',
- index === 0 ? 'mt-8' : 'mt-0',
- )}
- disabled={teamMemberInvites.length === 1}
- onClick={() => removeTeamMemberInvite(index)}
+ size="sm"
+ variant="outline"
+ className="w-fit"
+ onClick={() => onAddTeamMemberInvite()}
>
- <Trash className="h-5 w-5" />
- </button>
- </div>
- ))}
-
- <Button
- type="button"
- size="sm"
- variant="outline"
- className="w-fit"
- onClick={() => onAddTeamMemberInvite()}
- >
- <PlusCircle className="mr-2 h-4 w-4" />
- Add more
- </Button>
+ <PlusCircle className="mr-2 h-4 w-4" />
+ Add more
+ </Button>
- <DialogFooter>
- <Button type="button" variant="secondary" onClick={() => setOpen(false)}>
- Cancel
- </Button>
+ <DialogFooter>
+ <Button type="button" variant="secondary" onClick={() => setOpen(false)}>
+ Cancel
+ </Button>
+
+ <Button type="submit" loading={form.formState.isSubmitting}>
+ {!form.formState.isSubmitting && <Mail className="mr-2 h-4 w-4" />}
+ Invite
+ </Button>
+ </DialogFooter>
+ </fieldset>
+ </form>
+ </Form>
+ </TabsContent>
- <Button type="submit" loading={form.formState.isSubmitting}>
- {!form.formState.isSubmitting && <Mail className="mr-2 h-4 w-4" />}
- Invite
+ <TabsContent value="BULK">
+ <div className="mt-4 space-y-4">
+ <Card gradient className="h-32">
+ <CardContent
+ className="text-muted-foreground/80 hover:text-muted-foreground/90 flex h-full cursor-pointer flex-col items-center justify-center rounded-lg p-0 transition-colors"
+ onClick={() => fileInputRef.current?.click()}
+ >
+ <Upload className="h-5 w-5" />
+
+ <p className="mt-1 text-sm">Click here to upload</p>
+
+ <input
+ onChange={onFileInputChange}
+ type="file"
+ ref={fileInputRef}
+ accept=".csv"
+ hidden
+ />
+ </CardContent>
+ </Card>
+
+ <DialogFooter>
+ <Button type="button" variant="secondary" onClick={downloadTemplate}>
+ <Download className="mr-2 h-4 w-4" />
+ Template
</Button>
</DialogFooter>
- </fieldset>
- </form>
- </Form>
+ </div>
+ </TabsContent>
+ </Tabs>
</DialogContent>
</Dialog>
);
diff --git a/package-lock.json b/package-lock.json
index 5b1f8f0be..1d8663908 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -115,6 +115,7 @@
"next-axiom": "^1.1.1",
"next-plausible": "^3.10.1",
"next-themes": "^0.2.1",
+ "papaparse": "^5.4.1",
"perfect-freehand": "^1.2.0",
"posthog-js": "^1.75.3",
"posthog-node": "^3.1.1",
@@ -138,6 +139,7 @@
"@types/formidable": "^2.0.6",
"@types/luxon": "^3.3.1",
"@types/node": "20.1.0",
+ "@types/papaparse": "^5.3.14",
"@types/react": "18.2.18",
"@types/react-dom": "18.2.7",
"@types/ua-parser-js": "^0.7.39",
@@ -8081,6 +8083,15 @@
"resolved": "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz",
"integrity": "sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA=="
},
+ "node_modules/@types/papaparse": {
+ "version": "5.3.14",
+ "resolved": "https://registry.npmjs.org/@types/papaparse/-/papaparse-5.3.14.tgz",
+ "integrity": "sha512-LxJ4iEFcpqc6METwp9f6BV6VVc43m6MfH0VqFosHvrUgfXiFe6ww7R3itkOQ+TCK6Y+Iv/+RnnvtRZnkc5Kc9g==",
+ "dev": true,
+ "dependencies": {
+ "@types/node": "*"
+ }
+ },
"node_modules/@types/parse5": {
"version": "6.0.3",
"resolved": "https://registry.npmjs.org/@types/parse5/-/parse5-6.0.3.tgz",
@@ -17254,6 +17265,11 @@
"resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz",
"integrity": "sha512-4hLB8Py4zZce5s4yd9XzopqwVv/yGNhV1Bl8NTmCq1763HeK2+EwVTv+leGeL13Dnh2wfbqowVPXCIO0z4taYw=="
},
+ "node_modules/papaparse": {
+ "version": "5.4.1",
+ "resolved": "https://registry.npmjs.org/papaparse/-/papaparse-5.4.1.tgz",
+ "integrity": "sha512-HipMsgJkZu8br23pW15uvo6sib6wne/4woLZPlFf3rpDyMe9ywEXUsuD7+6K9PRkJlVT51j/sCOYDKGGS3ZJrw=="
+ },
"node_modules/parent-module": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz",