The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
chore: add support option (#1853)
Catalin Pit231ef9c27e1b
diff --git a/.env.example b/.env.exampleindex 87ad09a63..7b8872b69 100644--- a/.env.example+++ b/.env.example@@ -136,3 +136,5 @@ E2E_TEST_AUTHENTICATE_USER_PASSWORD="test_Password123"# OPTIONAL: The file to save the logger output to. Will disable stdout if provided.NEXT_PRIVATE_LOGGER_FILE_PATH=+# [[PLAIN SUPPORT]]+NEXT_PRIVATE_PLAIN_API_KEY=diff --git a/apps/remix/app/components/forms/support-ticket-form.tsx b/apps/remix/app/components/forms/support-ticket-form.tsxnew file mode 100644index 000000000..e80f12d21--- /dev/null+++ b/apps/remix/app/components/forms/support-ticket-form.tsx@@ -0,0 +1,138 @@+import { zodResolver } from '@hookform/resolvers/zod';+import { Trans, useLingui } from '@lingui/react/macro';+import { useForm } from 'react-hook-form';+import { z } from 'zod';++import { trpc } from '@documenso/trpc/react';+import { Button } from '@documenso/ui/primitives/button';+import {+ Form,+ FormControl,+ FormField,+ FormItem,+ FormLabel,+ FormMessage,+} from '@documenso/ui/primitives/form/form';+import { Input } from '@documenso/ui/primitives/input';+import { Textarea } from '@documenso/ui/primitives/textarea';+import { useToast } from '@documenso/ui/primitives/use-toast';++const ZSupportTicketSchema = z.object({+ subject: z.string().min(3, 'Subject is required'),+ message: z.string().min(10, 'Message must be at least 10 characters'),+});++type TSupportTicket = z.infer<typeof ZSupportTicketSchema>;++export type SupportTicketFormProps = {+ organisationId: string;+ teamId?: string | null;+ onSuccess?: () => void;+ onClose?: () => void;+};++export const SupportTicketForm = ({+ organisationId,+ teamId,+ onSuccess,+ onClose,+}: SupportTicketFormProps) => {+ const { t } = useLingui();+ const { toast } = useToast();++ const { mutateAsync: submitSupportTicket, isPending } =+ trpc.profile.submitSupportTicket.useMutation();++ const form = useForm<TSupportTicket>({+ resolver: zodResolver(ZSupportTicketSchema),+ defaultValues: {+ subject: '',+ message: '',+ },+ });++ const isLoading = form.formState.isLoading || isPending;++ const onSubmit = async (data: TSupportTicket) => {+ const { subject, message } = data;++ try {+ await submitSupportTicket({+ subject,+ message,+ organisationId,+ teamId,+ });++ toast({+ title: t`Support ticket created`,+ description: t`Your support request has been submitted. We'll get back to you soon!`,+ });++ if (onSuccess) {+ onSuccess();+ }++ form.reset();+ } catch (err) {+ toast({+ title: t`Failed to create support ticket`,+ description: t`An error occurred. Please try again later.`,+ variant: 'destructive',+ });+ }+ };++ return (+ <>+ <Form {...form}>+ <form onSubmit={form.handleSubmit(onSubmit)}>+ <fieldset disabled={isLoading} className="flex flex-col gap-4">+ <FormField+ control={form.control}+ name="subject"+ render={({ field }) => (+ <FormItem>+ <FormLabel required>+ <Trans>Subject</Trans>+ </FormLabel>+ <FormControl>+ <Input {...field} />+ </FormControl>+ <FormMessage />+ </FormItem>+ )}+ />++ <FormField+ control={form.control}+ name="message"+ render={({ field }) => (+ <FormItem>+ <FormLabel required>+ <Trans>Message</Trans>+ </FormLabel>+ <FormControl>+ <Textarea rows={5} {...field} />+ </FormControl>+ <FormMessage />+ </FormItem>+ )}+ />++ <div className="mt-2 flex flex-row gap-2">+ <Button type="submit" size="sm" loading={isLoading}>+ <Trans>Submit</Trans>+ </Button>+ {onClose && (+ <Button variant="outline" size="sm" type="button" onClick={onClose}>+ <Trans>Close</Trans>+ </Button>+ )}+ </div>+ </fieldset>+ </form>+ </Form>+ </>+ );+};diff --git a/apps/remix/app/components/general/org-menu-switcher.tsx b/apps/remix/app/components/general/org-menu-switcher.tsxindex 5ba8dcea4..c6c7c0040 100644--- a/apps/remix/app/components/general/org-menu-switcher.tsx+++ b/apps/remix/app/components/general/org-menu-switcher.tsx@@ -321,6 +321,19 @@ export const OrgMenuSwitcher = () => {<Trans>Language</Trans></DropdownMenuItem>+ {currentOrganisation && (+ <DropdownMenuItem className="text-muted-foreground px-4 py-2" asChild>+ <Link+ to={{+ pathname: `/o/${currentOrganisation.url}/support`,+ search: currentTeam ? `?team=${currentTeam.id}` : '',+ }}+ >+ <Trans>Support</Trans>+ </Link>+ </DropdownMenuItem>+ )}+<DropdownMenuItemclassName="text-muted-foreground hover:!text-muted-foreground px-4 py-2"onSelect={async () => authClient.signOut()}diff --git a/apps/remix/app/routes/_authenticated+/o.$orgUrl.support.tsx b/apps/remix/app/routes/_authenticated+/o.$orgUrl.support.tsxnew file mode 100644index 000000000..dc27400d3--- /dev/null+++ b/apps/remix/app/routes/_authenticated+/o.$orgUrl.support.tsx@@ -0,0 +1,125 @@+import { useState } from 'react';++import { Trans } from '@lingui/react/macro';+import { BookIcon, HelpCircleIcon, Link2Icon } from 'lucide-react';+import { Link, useSearchParams } from 'react-router';++import { useCurrentOrganisation } from '@documenso/lib/client-only/providers/organisation';+import { useSession } from '@documenso/lib/client-only/providers/session';+import { IS_BILLING_ENABLED } from '@documenso/lib/constants/app';+import { Button } from '@documenso/ui/primitives/button';++import { SupportTicketForm } from '~/components/forms/support-ticket-form';+import { appMetaTags } from '~/utils/meta';++export function meta() {+ return appMetaTags('Support');+}++export default function SupportPage() {+ const [showForm, setShowForm] = useState(false);+ const { user } = useSession();+ const organisation = useCurrentOrganisation();++ const [searchParams] = useSearchParams();++ const teamId = searchParams.get('team');++ const subscriptionStatus = organisation.subscription?.status;++ const handleSuccess = () => {+ setShowForm(false);+ };++ const handleCloseForm = () => {+ setShowForm(false);+ };++ return (+ <div className="mx-auto w-full max-w-screen-xl px-4 md:px-8">+ <div className="mb-8">+ <h1 className="flex flex-row items-center gap-2 text-3xl font-bold">+ <HelpCircleIcon className="text-muted-foreground h-8 w-8" />+ <Trans>Support</Trans>+ </h1>++ <p className="text-muted-foreground mt-2">+ <Trans>Your current plan includes the following support channels:</Trans>+ </p>++ <div className="mt-6 flex flex-col gap-4">+ <div className="rounded-lg border p-4">+ <h2 className="flex items-center gap-2 text-lg font-bold">+ <BookIcon className="text-muted-foreground h-5 w-5" />+ <Link+ to="https://docs.documenso.com"+ target="_blank"+ rel="noopener noreferrer"+ className="hover:underline"+ >+ <Trans>Documentation</Trans>+ </Link>+ </h2>+ <p className="text-muted-foreground mt-1">+ <Trans>Read our documentation to get started with Documenso.</Trans>+ </p>+ </div>+ <div className="rounded-lg border p-4">+ <h2 className="flex items-center gap-2 text-lg font-bold">+ <Link2Icon className="text-muted-foreground h-5 w-5" />+ <Link+ to="https://documen.so/discord"+ target="_blank"+ rel="noopener noreferrer"+ className="hover:underline"+ >+ <Trans>Discord</Trans>+ </Link>+ </h2>+ <p className="text-muted-foreground mt-1">+ <Trans>+ Join our community on{' '}+ <Link+ to="https://documen.so/discord"+ target="_blank"+ rel="noopener noreferrer"+ className="hover:underline"+ >+ Discord+ </Link>{' '}+ for community support and discussion.+ </Trans>+ </p>+ </div>+ {organisation && IS_BILLING_ENABLED() && subscriptionStatus && (+ <>+ <div className="rounded-lg border p-4">+ <h2 className="flex items-center gap-2 text-lg font-bold">+ <Link2Icon className="text-muted-foreground h-5 w-5" />+ <Trans>Contact us</Trans>+ </h2>+ <p className="text-muted-foreground mt-1">+ <Trans>We'll get back to you as soon as possible via email.</Trans>+ </p>+ <div className="mt-4">+ {!showForm ? (+ <Button variant="outline" size="sm" onClick={() => setShowForm(true)}>+ <Trans>Create a support ticket</Trans>+ </Button>+ ) : (+ <SupportTicketForm+ organisationId={organisation.id}+ teamId={teamId}+ onSuccess={handleSuccess}+ onClose={handleCloseForm}+ />+ )}+ </div>+ </div>+ </>+ )}+ </div>+ </div>+ </div>+ );+}diff --git a/package-lock.json b/package-lock.jsonindex e8455705d..7b2d0ed69 100644--- a/package-lock.json+++ b/package-lock.json@@ -3522,6 +3522,15 @@"integrity": "sha512-MDWhGtE+eHw5JW7lq4qhc5yRLS11ERl1c7Z6Xd0a58DozHES6EnNNwUWbMiG4J9Cgj053Bhk8zvlhFYKVhULwg==","license": "MIT"},+ "node_modules/@graphql-typed-document-node/core": {+ "version": "3.2.0",+ "resolved": "https://registry.npmjs.org/@graphql-typed-document-node/core/-/core-3.2.0.tgz",+ "integrity": "sha512-mB9oAsNCm9aM3/SOv4YtBMqZbYj10R7dkq8byBqxGY/ncFwhf2oQzMV+LCRlWoDSEBJ3COiR1yeDvMtsoOsuFQ==",+ "license": "MIT",+ "peerDependencies": {+ "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0"+ }+ },"node_modules/@grpc/grpc-js": {"version": "1.13.3","resolved": "https://registry.npmjs.org/@grpc/grpc-js/-/grpc-js-1.13.3.tgz",@@ -11826,6 +11835,20 @@"url": "https://github.com/sponsors/tannerlinsley"}},+ "node_modules/@team-plain/typescript-sdk": {+ "version": "5.9.0",+ "resolved": "https://registry.npmjs.org/@team-plain/typescript-sdk/-/typescript-sdk-5.9.0.tgz",+ "integrity": "sha512-AHSXyt1kDt74m9YKZBCRCd6cQjB8QjUNr9cehtR2QHzZ/8yXJPzawPJDqOQ3ms5KvwuYrBx2qT3e6C/zrQ5UtA==",+ "license": "MIT",+ "dependencies": {+ "@graphql-typed-document-node/core": "^3.2.0",+ "ajv": "^8.12.0",+ "ajv-formats": "^2.1.1",+ "graphql": "^16.6.0",+ "lodash.get": "^4.4.2",+ "zod": "3.22.4"+ }+ },"node_modules/@theguild/remark-mermaid": {"version": "0.0.5","resolved": "https://registry.npmjs.org/@theguild/remark-mermaid/-/remark-mermaid-0.0.5.tgz",@@ -13235,7 +13258,6 @@"version": "8.17.1","resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz","integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==",- "dev": true,"license": "MIT","dependencies": {"fast-deep-equal": "^3.1.3",@@ -13248,6 +13270,23 @@"url": "https://github.com/sponsors/epoberezkin"}},+ "node_modules/ajv-formats": {+ "version": "2.1.1",+ "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz",+ "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==",+ "license": "MIT",+ "dependencies": {+ "ajv": "^8.0.0"+ },+ "peerDependencies": {+ "ajv": "^8.0.0"+ },+ "peerDependenciesMeta": {+ "ajv": {+ "optional": true+ }+ }+ },"node_modules/ansi-escapes": {"version": "4.3.2","resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz",@@ -18771,7 +18810,6 @@"version": "3.0.6","resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.6.tgz","integrity": "sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw==",- "dev": true,"funding": [{"type": "github",@@ -19847,6 +19885,15 @@"integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==","license": "MIT"},+ "node_modules/graphql": {+ "version": "16.11.0",+ "resolved": "https://registry.npmjs.org/graphql/-/graphql-16.11.0.tgz",+ "integrity": "sha512-mS1lbMsxgQj6hge1XZ6p7GPhbrtFwUFYi3wRzXAC/FmYnyXMTvvI3td3rjmQ2u8ewXueaSvRPWaEcgVVOT9Jnw==",+ "license": "MIT",+ "engines": {+ "node": "^12.22.0 || ^14.16.0 || ^16.0.0 || >=17.0.0"+ }+ },"node_modules/gray-matter": {"version": "4.0.3","resolved": "https://registry.npmjs.org/gray-matter/-/gray-matter-4.0.3.tgz",@@ -22329,7 +22376,6 @@"version": "1.0.0","resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz","integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==",- "dev": true,"license": "MIT"},"node_modules/json-stable-stringify-without-jsonify": {@@ -30570,7 +30616,6 @@"version": "2.0.2","resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz","integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==",- "dev": true,"license": "MIT","engines": {"node": ">=0.10.0"@@ -36583,6 +36628,7 @@"@pdf-lib/fontkit": "^1.1.1","@scure/base": "^1.1.3","@sindresorhus/slugify": "^2.2.1",+ "@team-plain/typescript-sdk": "^5.9.0","@vvo/tzdb": "^6.117.0","csv-parse": "^5.6.0","inngest": "^3.19.13",diff --git a/packages/lib/package.json b/packages/lib/package.jsonindex 374793db8..f422ec2f9 100644--- a/packages/lib/package.json+++ b/packages/lib/package.json@@ -33,6 +33,7 @@"@pdf-lib/fontkit": "^1.1.1","@scure/base": "^1.1.3","@sindresorhus/slugify": "^2.2.1",+ "@team-plain/typescript-sdk": "^5.9.0","@vvo/tzdb": "^6.117.0","csv-parse": "^5.6.0","inngest": "^3.19.13",diff --git a/packages/lib/plain/client.ts b/packages/lib/plain/client.tsnew file mode 100644index 000000000..4def9d8b4--- /dev/null+++ b/packages/lib/plain/client.ts@@ -0,0 +1,7 @@+import { PlainClient } from '@team-plain/typescript-sdk';++import { env } from '@documenso/lib/utils/env';++export const plainClient = new PlainClient({+ apiKey: env('NEXT_PRIVATE_PLAIN_API_KEY') ?? '',+});diff --git a/packages/lib/server-only/user/submit-support-ticket.ts b/packages/lib/server-only/user/submit-support-ticket.tsnew file mode 100644index 000000000..91c55800d--- /dev/null+++ b/packages/lib/server-only/user/submit-support-ticket.ts@@ -0,0 +1,72 @@+import { plainClient } from '@documenso/lib/plain/client';+import { prisma } from '@documenso/prisma';++import { AppError, AppErrorCode } from '../../errors/app-error';+import { buildOrganisationWhereQuery } from '../../utils/organisations';+import { getTeamById } from '../team/get-team';++type SubmitSupportTicketOptions = {+ subject: string;+ message: string;+ userId: number;+ organisationId: string;+ teamId?: number | null;+};++export const submitSupportTicket = async ({+ subject,+ message,+ userId,+ organisationId,+ teamId,+}: SubmitSupportTicketOptions) => {+ const user = await prisma.user.findFirst({+ where: {+ id: userId,+ },+ });++ if (!user) {+ throw new AppError(AppErrorCode.NOT_FOUND, {+ message: 'User not found',+ });+ }++ const organisation = await prisma.organisation.findFirst({+ where: buildOrganisationWhereQuery({+ organisationId,+ userId,+ }),+ });++ if (!organisation) {+ throw new AppError(AppErrorCode.NOT_FOUND, {+ message: 'Organisation not found',+ });+ }++ const team = teamId+ ? await getTeamById({+ userId,+ teamId,+ })+ : null;++ const customMessage = `+Organisation: ${organisation.name} (${organisation.id})+Team: ${team ? `${team.name} (${team.id})` : 'No team provided'}++${message}`;++ const res = await plainClient.createThread({+ title: subject,+ customerIdentifier: { emailAddress: user.email },+ components: [{ componentText: { text: customMessage } }],+ });++ if (res.error) {+ throw new Error(res.error.message);+ }++ return res;+};diff --git a/packages/trpc/server/profile-router/router.ts b/packages/trpc/server/profile-router/router.tsindex 927409817..60b7c1323 100644--- a/packages/trpc/server/profile-router/router.ts+++ b/packages/trpc/server/profile-router/router.ts@@ -1,8 +1,10 @@+import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';import type { SetAvatarImageOptions } from '@documenso/lib/server-only/profile/set-avatar-image';import { setAvatarImage } from '@documenso/lib/server-only/profile/set-avatar-image';import { deleteUser } from '@documenso/lib/server-only/user/delete-user';import { findUserSecurityAuditLogs } from '@documenso/lib/server-only/user/find-user-security-audit-logs';import { getUserById } from '@documenso/lib/server-only/user/get-user-by-id';+import { submitSupportTicket } from '@documenso/lib/server-only/user/submit-support-ticket';import { updateProfile } from '@documenso/lib/server-only/user/update-profile';import { adminProcedure, authenticatedProcedure, router } from '../trpc';@@ -10,6 +12,7 @@ import {ZFindUserSecurityAuditLogsSchema,ZRetrieveUserByIdQuerySchema,ZSetProfileImageMutationSchema,+ ZSubmitSupportTicketMutationSchema,ZUpdateProfileMutationSchema,} from './schema';@@ -91,4 +94,28 @@ export const profileRouter = router({requestMetadata: ctx.metadata,});}),++ submitSupportTicket: authenticatedProcedure+ .input(ZSubmitSupportTicketMutationSchema)+ .mutation(async ({ input, ctx }) => {+ const { subject, message, organisationId, teamId } = input;++ const userId = ctx.user.id;++ const parsedTeamId = teamId ? Number(teamId) : null;++ if (Number.isNaN(parsedTeamId)) {+ throw new AppError(AppErrorCode.INVALID_BODY, {+ message: 'Invalid team ID provided',+ });+ }++ return await submitSupportTicket({+ subject,+ message,+ userId,+ organisationId,+ teamId: parsedTeamId,+ });+ }),});diff --git a/packages/trpc/server/profile-router/schema.ts b/packages/trpc/server/profile-router/schema.tsindex 490ea8a8c..e1db5dd78 100644--- a/packages/trpc/server/profile-router/schema.ts+++ b/packages/trpc/server/profile-router/schema.ts@@ -27,3 +27,12 @@ export const ZSetProfileImageMutationSchema = z.object({});export type TSetProfileImageMutationSchema = z.infer<typeof ZSetProfileImageMutationSchema>;++export const ZSubmitSupportTicketMutationSchema = z.object({+ organisationId: z.string(),+ teamId: z.string().min(1).nullish(),+ subject: z.string().min(3, 'Subject is required'),+ message: z.string().min(10, 'Message must be at least 10 characters'),+});++export type TSupportTicketRequest = z.infer<typeof ZSubmitSupportTicketMutationSchema>;diff --git a/turbo.json b/turbo.jsonindex 77c668b35..d767b4612 100644--- a/turbo.json+++ b/turbo.json@@ -47,6 +47,7 @@"NEXT_PUBLIC_POSTHOG_KEY","NEXT_PUBLIC_FEATURE_BILLING_ENABLED","NEXT_PUBLIC_DISABLE_SIGNUP",+ "NEXT_PRIVATE_PLAIN_API_KEY","NEXT_PUBLIC_DOCUMENT_SIZE_UPLOAD_LIMIT","NEXT_PRIVATE_DATABASE_URL","NEXT_PRIVATE_DIRECT_DATABASE_URL",