refactor: extract api implementation to package

Extracts the API implementation to a package so we can
potentially reuse it across different applications in the
event that we move off using a Next.js API route.

Additionally tidies up the tokens page and form to be more simplified.
This commit is contained in:
Mythie
2023-12-31 13:58:15 +11:00
parent d283cc2d26
commit a1215df91a
17 changed files with 802 additions and 398 deletions

View File

@ -1,7 +1,7 @@
{ {
"typescript.tsdk": "node_modules/typescript/lib", "typescript.tsdk": "node_modules/typescript/lib",
"editor.codeActionsOnSave": { "editor.codeActionsOnSave": {
"source.fixAll.eslint": true "source.fixAll.eslint": "explicit"
}, },
"eslint.validate": ["typescript", "typescriptreact", "javascript", "javascriptreact"], "eslint.validate": ["typescript", "typescriptreact", "javascript", "javascriptreact"],
"javascript.preferences.importModuleSpecifier": "non-relative", "javascript.preferences.importModuleSpecifier": "non-relative",

View File

@ -14,6 +14,7 @@
"copy:pdfjs": "node ../../scripts/copy-pdfjs.cjs" "copy:pdfjs": "node ../../scripts/copy-pdfjs.cjs"
}, },
"dependencies": { "dependencies": {
"@documenso/api": "*",
"@documenso/assets": "*", "@documenso/assets": "*",
"@documenso/ee": "*", "@documenso/ee": "*",
"@documenso/lib": "*", "@documenso/lib": "*",

View File

@ -1,9 +1,21 @@
import { DateTime } from 'luxon';
import { getRequiredServerComponentSession } from '@documenso/lib/next-auth/get-server-component-session';
import { getUserTokens } from '@documenso/lib/server-only/public-api/get-all-user-tokens';
import { Button } from '@documenso/ui/primitives/button';
import DeleteTokenDialog from '~/components/(dashboard)/settings/token/delete-token-dialog';
import { LocaleDate } from '~/components/formatter/locale-date';
import { ApiTokenForm } from '~/components/forms/token'; import { ApiTokenForm } from '~/components/forms/token';
export default function ApiToken() { export default async function ApiTokensPage() {
const { user } = await getRequiredServerComponentSession();
const tokens = await getUserTokens({ userId: user.id });
return ( return (
<div> <div>
<h3 className="text-lg font-medium">API Tokens</h3> <h3 className="text-2xl font-semibold">API Tokens</h3>
<p className="text-muted-foreground mt-2 text-sm"> <p className="text-muted-foreground mt-2 text-sm">
On this page, you can create new API tokens and manage the existing ones. On this page, you can create new API tokens and manage the existing ones.
@ -12,6 +24,45 @@ export default function ApiToken() {
<hr className="my-4" /> <hr className="my-4" />
<ApiTokenForm className="max-w-xl" /> <ApiTokenForm className="max-w-xl" />
<hr className="mb-4 mt-8" />
<h4 className="text-xl font-medium">Your existing tokens</h4>
{tokens.length === 0 && (
<div className="mb-4">
<p className="text-muted-foreground mt-2 text-sm italic">
Your tokens will be shown here once you create them.
</p>
</div>
)}
{tokens.length > 0 && (
<div className="mt-4 flex max-w-xl flex-col gap-y-4">
{tokens.map((token) => (
<div key={token.id} className="border-border rounded-lg border p-4">
<div className="flex items-center justify-between gap-x-4">
<div>
<h5 className="text-base">{token.name}</h5>
<p className="text-muted-foreground mt-2 text-xs">
Created on <LocaleDate date={token.createdAt} format={DateTime.DATETIME_FULL} />
</p>
<p className="text-muted-foreground mt-1 text-xs">
Expires on <LocaleDate date={token.expires} format={DateTime.DATETIME_FULL} />
</p>
</div>
<div>
<DeleteTokenDialog token={token}>
<Button variant="destructive">Delete</Button>
</DeleteTokenDialog>
</div>
</div>
</div>
))}
</div>
)}
</div> </div>
); );
} }

View File

@ -1,3 +1,5 @@
'use client';
import { useEffect, useState } from 'react'; import { useEffect, useState } from 'react';
import { useRouter } from 'next/navigation'; import { useRouter } from 'next/navigation';
@ -6,6 +8,7 @@ import { zodResolver } from '@hookform/resolvers/zod';
import { useForm } from 'react-hook-form'; import { useForm } from 'react-hook-form';
import { z } from 'zod'; import { z } from 'zod';
import type { ApiToken } from '@documenso/prisma/client';
import { trpc } from '@documenso/trpc/react'; import { trpc } from '@documenso/trpc/react';
import { Button } from '@documenso/ui/primitives/button'; import { Button } from '@documenso/ui/primitives/button';
import { import {
@ -29,24 +32,18 @@ import { Input } from '@documenso/ui/primitives/input';
import { useToast } from '@documenso/ui/primitives/use-toast'; import { useToast } from '@documenso/ui/primitives/use-toast';
export type DeleteTokenDialogProps = { export type DeleteTokenDialogProps = {
trigger?: React.ReactNode; token: Pick<ApiToken, 'id' | 'name'>;
tokenId: number; onDelete?: () => void;
tokenName: string; children?: React.ReactNode;
onDelete: () => void;
}; };
export default function DeleteTokenDialog({ export default function DeleteTokenDialog({ token, onDelete, children }: DeleteTokenDialogProps) {
trigger,
tokenId,
tokenName,
onDelete,
}: DeleteTokenDialogProps) {
const router = useRouter(); const router = useRouter();
const { toast } = useToast(); const { toast } = useToast();
const [isOpen, setIsOpen] = useState(false);
const [isDeleteEnabled, setIsDeleteEnabled] = useState(false);
const deleteMessage = `delete ${tokenName}`; const [isOpen, setIsOpen] = useState(false);
const deleteMessage = `delete ${token.name}`;
const ZDeleteTokenDialogSchema = z.object({ const ZDeleteTokenDialogSchema = z.object({
tokenName: z.literal(deleteMessage, { tokenName: z.literal(deleteMessage, {
@ -58,7 +55,7 @@ export default function DeleteTokenDialog({
const { mutateAsync: deleteTokenMutation } = trpc.apiToken.deleteTokenById.useMutation({ const { mutateAsync: deleteTokenMutation } = trpc.apiToken.deleteTokenById.useMutation({
onSuccess() { onSuccess() {
onDelete(); onDelete?.();
}, },
}); });
@ -69,14 +66,10 @@ export default function DeleteTokenDialog({
}, },
}); });
const onInputChange = (event: React.ChangeEvent<HTMLInputElement>) => {
setIsDeleteEnabled(event.target.value === deleteMessage);
};
const onSubmit = async () => { const onSubmit = async () => {
try { try {
await deleteTokenMutation({ await deleteTokenMutation({
id: tokenId, id: token.id,
}); });
toast({ toast({
@ -86,7 +79,8 @@ export default function DeleteTokenDialog({
}); });
setIsOpen(false); setIsOpen(false);
router.push('/settings/token');
router.refresh();
} catch (error) { } catch (error) {
toast({ toast({
title: 'An unknown error occurred', title: 'An unknown error occurred',
@ -100,7 +94,6 @@ export default function DeleteTokenDialog({
useEffect(() => { useEffect(() => {
if (!isOpen) { if (!isOpen) {
setIsDeleteEnabled(false);
form.reset(); form.reset();
} }
}, [isOpen, form]); }, [isOpen, form]);
@ -111,12 +104,13 @@ export default function DeleteTokenDialog({
onOpenChange={(value) => !form.formState.isSubmitting && setIsOpen(value)} onOpenChange={(value) => !form.formState.isSubmitting && setIsOpen(value)}
> >
<DialogTrigger asChild={true}> <DialogTrigger asChild={true}>
{trigger ?? ( {children ?? (
<Button className="mr-4" variant="destructive"> <Button className="mr-4" variant="destructive">
Delete Delete
</Button> </Button>
)} )}
</DialogTrigger> </DialogTrigger>
<DialogContent> <DialogContent>
<DialogHeader> <DialogHeader>
<DialogTitle>Are you sure you want to delete this token?</DialogTitle> <DialogTitle>Are you sure you want to delete this token?</DialogTitle>
@ -144,21 +138,15 @@ export default function DeleteTokenDialog({
{deleteMessage} {deleteMessage}
</span> </span>
</FormLabel> </FormLabel>
<FormControl> <FormControl>
<Input <Input className="bg-background" type="text" {...field} />
className="bg-background"
type="text"
{...field}
onChange={(value) => {
onInputChange(value);
field.onChange(value);
}}
/>
</FormControl> </FormControl>
<FormMessage /> <FormMessage />
</FormItem> </FormItem>
)} )}
/> />
<DialogFooter> <DialogFooter>
<div className="flex w-full flex-1 flex-nowrap gap-4"> <div className="flex w-full flex-1 flex-nowrap gap-4">
<Button <Button
@ -173,7 +161,7 @@ export default function DeleteTokenDialog({
<Button <Button
type="submit" type="submit"
variant="destructive" variant="destructive"
disabled={!isDeleteEnabled} disabled={!form.formState.isValid}
loading={form.formState.isSubmitting} loading={form.formState.isSubmitting}
> >
I'm sure! Delete it I'm sure! Delete it

View File

@ -5,20 +5,21 @@ import { useState } from 'react';
import { useRouter } from 'next/navigation'; import { useRouter } from 'next/navigation';
import { zodResolver } from '@hookform/resolvers/zod'; import { zodResolver } from '@hookform/resolvers/zod';
import { Loader } from 'lucide-react';
import { DateTime } from 'luxon';
import { useForm } from 'react-hook-form'; import { useForm } from 'react-hook-form';
import type { z } from 'zod'; import type { z } from 'zod';
import { useCopyToClipboard } from '@documenso/lib/client-only/hooks/use-copy-to-clipboard'; import { useCopyToClipboard } from '@documenso/lib/client-only/hooks/use-copy-to-clipboard';
import { TRPCClientError } from '@documenso/trpc/client'; import { TRPCClientError } from '@documenso/trpc/client';
import { trpc } from '@documenso/trpc/react'; import { trpc } from '@documenso/trpc/react';
import type { TCreateTokenMutationSchema } from '@documenso/trpc/server/api-token-router/schema';
import { ZCreateTokenMutationSchema } from '@documenso/trpc/server/api-token-router/schema'; import { ZCreateTokenMutationSchema } from '@documenso/trpc/server/api-token-router/schema';
import { cn } from '@documenso/ui/lib/utils'; import { cn } from '@documenso/ui/lib/utils';
import { Button } from '@documenso/ui/primitives/button'; import { Button } from '@documenso/ui/primitives/button';
import { Card, CardContent } from '@documenso/ui/primitives/card';
import { import {
Form, Form,
FormControl, FormControl,
FormDescription,
FormField, FormField,
FormItem, FormItem,
FormLabel, FormLabel,
@ -27,46 +28,35 @@ import {
import { Input } from '@documenso/ui/primitives/input'; import { Input } from '@documenso/ui/primitives/input';
import { useToast } from '@documenso/ui/primitives/use-toast'; import { useToast } from '@documenso/ui/primitives/use-toast';
import DeleteTokenDialog from '~/components/(dashboard)/settings/token/delete-token-dialog'; const ZCreateTokenFormSchema = ZCreateTokenMutationSchema;
type TCreateTokenFormSchema = z.infer<typeof ZCreateTokenFormSchema>;
export type ApiTokenFormProps = { export type ApiTokenFormProps = {
className?: string; className?: string;
}; };
type TCreateTokenMutationSchema = z.infer<typeof ZCreateTokenMutationSchema>;
export const ApiTokenForm = ({ className }: ApiTokenFormProps) => { export const ApiTokenForm = ({ className }: ApiTokenFormProps) => {
const router = useRouter(); const router = useRouter();
const [, copy] = useCopyToClipboard(); const [, copy] = useCopyToClipboard();
const { toast } = useToast(); const { toast } = useToast();
const [newlyCreatedToken, setNewlyCreatedToken] = useState({ id: 0, token: '' });
const [showNewToken, setShowNewToken] = useState(false);
const { data: tokens, isLoading: isTokensLoading } = trpc.apiToken.getTokens.useQuery(); const [newlyCreatedToken, setNewlyCreatedToken] = useState('');
const { mutateAsync: createTokenMutation } = trpc.apiToken.createToken.useMutation({ const { mutateAsync: createTokenMutation } = trpc.apiToken.createToken.useMutation({
onSuccess(data) { onSuccess(data) {
setNewlyCreatedToken({ id: data.id, token: data.token }); setNewlyCreatedToken(data.token);
}, },
}); });
const form = useForm<TCreateTokenMutationSchema>({ const form = useForm<TCreateTokenFormSchema>({
resolver: zodResolver(ZCreateTokenMutationSchema), resolver: zodResolver(ZCreateTokenFormSchema),
values: { defaultValues: {
tokenName: '', tokenName: '',
}, },
}); });
/*
This method is called in "delete-token-dialog.tsx" after a successful mutation
to avoid deleting the snippet with the newly created token from the screen
when users delete any of their tokens except the newly created one.
*/
const onDelete = (tokenId: number) => {
if (tokenId === newlyCreatedToken.id) {
setShowNewToken(false);
}
};
const copyToken = async (token: string) => { const copyToken = async (token: string) => {
try { try {
const copied = await copy(token); const copied = await copy(token);
@ -100,8 +90,8 @@ export const ApiTokenForm = ({ className }: ApiTokenFormProps) => {
duration: 5000, duration: 5000,
}); });
setShowNewToken(true);
form.reset(); form.reset();
router.refresh(); router.refresh();
} catch (error) { } catch (error) {
if (error instanceof TRPCClientError && error.data?.code === 'BAD_REQUEST') { if (error instanceof TRPCClientError && error.data?.code === 'BAD_REQUEST') {
@ -124,94 +114,42 @@ export const ApiTokenForm = ({ className }: ApiTokenFormProps) => {
return ( return (
<div className={cn(className)}> <div className={cn(className)}>
<h2 className="mt-6 text-xl">Your existing tokens</h2>
{tokens?.length === 0 ? (
<div className="mb-4">
<p className="text-muted-foreground mt-2 text-sm italic">
Your tokens will be shown here once you create them.
</p>
</div>
) : (
<div></div>
)}
{!tokens && isTokensLoading ? (
<div className="absolute inset-0 flex items-center justify-center bg-white/50">
<Loader className="h-8 w-8 animate-spin text-gray-500" />
</div>
) : (
<ul className="mb-4 flex flex-col gap-2">
{tokens?.map((token) => (
<li
className="border-muted mb-4 mt-4 break-words rounded-sm border-2 p-4"
key={token.id}
>
<div>
<p className="mb-4">
{token.name} <span className="text-sm italic">({token.algorithm})</span>
</p>
<p className="text-sm">
Created:{' '}
{token.createdAt
? DateTime.fromJSDate(token.createdAt).toLocaleString(DateTime.DATETIME_FULL)
: 'N/A'}
</p>
<p className="mb-4 text-sm">
Expires:{' '}
{token.expires
? DateTime.fromJSDate(token.expires).toLocaleString(DateTime.DATETIME_FULL)
: 'N/A'}
</p>
<DeleteTokenDialog
tokenId={token.id}
tokenName={token.name}
onDelete={() => onDelete(token.id)}
/>
</div>
</li>
))}
</ul>
)}
{newlyCreatedToken.token && showNewToken && (
<div className="border-primary mb-8 break-words rounded-sm border p-4">
<p className="text-muted-foreground mt-2 text-sm italic">
Your token was created successfully! Make sure to copy it because you won't be able to
see it again!
</p>
<p className="mb-4 mt-4 font-mono text-sm font-light">{newlyCreatedToken.token}</p>
<Button
variant="outline"
className="mt-4"
onClick={() => void copyToken(newlyCreatedToken.token)}
>
Copy token
</Button>
</div>
)}
<h2 className="text-xl">Create a new token</h2>
<p className="text-muted-foreground mt-2 text-sm italic">
Enter a representative name for your new token.
</p>
<Form {...form}> <Form {...form}>
<form onSubmit={form.handleSubmit(onSubmit)}> <form onSubmit={form.handleSubmit(onSubmit)}>
<fieldset className="mt-6 flex w-full flex-col gap-y-4"> <fieldset className="mt-6 flex w-full flex-col gap-4 md:flex-row ">
<FormField <FormField
control={form.control} control={form.control}
name="tokenName" name="tokenName"
render={({ field }) => ( render={({ field }) => (
<FormItem> <FormItem className="flex-1">
<FormLabel className="text-muted-foreground">Token Name</FormLabel> <FormLabel className="text-muted-foreground">Token Name</FormLabel>
<FormControl>
<Input type="text" {...field} value={field.value ?? ''} /> <div className="flex items-center gap-x-4">
</FormControl> <FormControl className="flex-1">
<Input type="text" {...field} />
</FormControl>
<Button
type="submit"
className="hidden md:inline-flex"
disabled={!form.formState.isDirty}
loading={form.formState.isSubmitting}
>
Create token
</Button>
</div>
<FormDescription>
Please enter a meaningful name for your token. This will help you identify it
later.
</FormDescription>
<FormMessage /> <FormMessage />
</FormItem> </FormItem>
)} )}
/> />
<div className="mt-4"> <div className="md:hidden">
<Button <Button
type="submit" type="submit"
disabled={!form.formState.isDirty} disabled={!form.formState.isDirty}
@ -223,6 +161,25 @@ export const ApiTokenForm = ({ className }: ApiTokenFormProps) => {
</fieldset> </fieldset>
</form> </form>
</Form> </Form>
{newlyCreatedToken && (
<Card className="mt-8" gradient>
<CardContent className="p-4">
<p className="text-muted-foreground mt-2 text-sm">
Your token was created successfully! Make sure to copy it because you won't be able to
see it again!
</p>
<p className="bg-muted-foreground/10 my-4 rounded-md px-2.5 py-1 font-mono text-sm">
{newlyCreatedToken}
</p>
<Button variant="outline" onClick={() => void copyToken(newlyCreatedToken)}>
Copy token
</Button>
</CardContent>
</Card>
)}
</div> </div>
); );
}; };

View File

@ -1,227 +1,5 @@
import { upsertDocumentMeta } from '@documenso/lib/server-only/document-meta/upsert-document-meta'; import { createNextRouter } from '@documenso/api/next';
import { deleteDocument } from '@documenso/lib/server-only/document/delete-document'; import { ApiContractV1 } from '@documenso/api/v1/contract';
import { findDocuments } from '@documenso/lib/server-only/document/find-documents'; import { ApiContractV1Implementation } from '@documenso/api/v1/implementation';
import { getDocumentById } from '@documenso/lib/server-only/document/get-document-by-id';
import { sendDocument } from '@documenso/lib/server-only/document/send-document';
import { setFieldsForDocument } from '@documenso/lib/server-only/field/set-fields-for-document';
import { getUserByApiToken } from '@documenso/lib/server-only/public-api/get-user-by-token';
import { setRecipientsForDocument } from '@documenso/lib/server-only/recipient/set-recipients-for-document';
import { getPresignPostUrl } from '@documenso/lib/universal/upload/server-actions';
import { contract } from '@documenso/trpc/api-contract/contract';
import { createNextRoute, createNextRouter } from '@documenso/trpc/server/public-api/ts-rest';
const router = createNextRoute(contract, { export default createNextRouter(ApiContractV1, ApiContractV1Implementation);
getDocuments: async (args) => {
const page = Number(args.query.page) || 1;
const perPage = Number(args.query.perPage) || 10;
const { authorization } = args.headers;
let user;
try {
user = await getUserByApiToken({ token: authorization });
} catch (e) {
return {
status: 401,
body: {
message: e.message,
},
};
}
const { data: documents, totalPages } = await findDocuments({ page, perPage, userId: user.id });
return {
status: 200,
body: {
documents,
totalPages,
},
};
},
getDocument: async (args) => {
const { id: documentId } = args.params;
const { authorization } = args.headers;
let user;
try {
user = await getUserByApiToken({ token: authorization });
} catch (e) {
return {
status: 401,
body: {
message: e.message,
},
};
}
try {
const document = await getDocumentById({ id: Number(documentId), userId: user.id });
return {
status: 200,
body: document,
};
} catch (e) {
return {
status: 404,
body: {
message: e.message ?? 'Document not found',
},
};
}
},
deleteDocument: async (args) => {
const { id: documentId } = args.params;
const { authorization } = args.headers;
let user;
try {
user = await getUserByApiToken({ token: authorization });
} catch (e) {
return {
status: 401,
body: {
message: e.message,
},
};
}
try {
const document = await getDocumentById({ id: Number(documentId), userId: user.id });
const deletedDocument = await deleteDocument({
id: Number(documentId),
userId: user.id,
status: document.status,
});
return {
status: 200,
body: deletedDocument,
};
} catch (e) {
return {
status: 404,
body: {
message: e.message ?? 'Document not found',
},
};
}
},
createDocument: async (args) => {
const { body } = args;
try {
const { url, key } = await getPresignPostUrl(body.fileName, body.contentType);
return {
status: 200,
body: {
url,
key,
},
};
} catch (e) {
return {
status: 404,
body: {
message: e.message ?? 'An error has occured while uploading the file',
},
};
}
},
sendDocumentForSigning: async (args) => {
const { authorization } = args.headers;
const { id } = args.params;
const { body } = args;
let user;
try {
user = await getUserByApiToken({ token: authorization });
} catch (e) {
return {
status: 401,
body: {
message: e.message,
},
};
}
const document = await getDocumentById({ id: Number(id), userId: user.id });
if (!document) {
return {
status: 404,
body: {
message: 'Document not found',
},
};
}
if (document.status === 'PENDING') {
return {
status: 400,
body: {
message: 'Document is already waiting for signing',
},
};
}
try {
await setRecipientsForDocument({
userId: user.id,
documentId: Number(id),
recipients: [
{
email: body.signerEmail,
name: body.signerName ?? '',
},
],
});
await setFieldsForDocument({
documentId: Number(id),
userId: user.id,
fields: body.fields.map((field) => ({
signerEmail: body.signerEmail,
type: field.fieldType,
pageNumber: field.pageNumber,
pageX: field.pageX,
pageY: field.pageY,
pageWidth: field.pageWidth,
pageHeight: field.pageHeight,
})),
});
if (body.emailBody || body.emailSubject) {
await upsertDocumentMeta({
documentId: Number(id),
subject: body.emailSubject ?? '',
message: body.emailBody ?? '',
});
}
await sendDocument({
documentId: Number(id),
userId: user.id,
});
return {
status: 200,
body: {
message: 'Document sent for signing successfully',
},
};
} catch (e) {
return {
status: 500,
body: {
message: e.message ?? 'An error has occured while sending the document for signing',
},
};
}
},
});
export default createNextRouter(contract, router);

268
package-lock.json generated
View File

@ -88,6 +88,7 @@
"version": "1.2.3", "version": "1.2.3",
"license": "AGPL-3.0", "license": "AGPL-3.0",
"dependencies": { "dependencies": {
"@documenso/api": "*",
"@documenso/assets": "*", "@documenso/assets": "*",
"@documenso/ee": "*", "@documenso/ee": "*",
"@documenso/lib": "*", "@documenso/lib": "*",
@ -167,18 +168,6 @@
"url": "https://github.com/sponsors/sindresorhus" "url": "https://github.com/sponsors/sindresorhus"
} }
}, },
"node_modules/@anatine/zod-openapi": {
"version": "1.14.2",
"resolved": "https://registry.npmjs.org/@anatine/zod-openapi/-/zod-openapi-1.14.2.tgz",
"integrity": "sha512-q0qHfnuNYVKu0Swrnnvfj9971AEyW7c8v9jCOZGCl5ZbyGMNG4RPyJkRcMi/JC8CRfdOe0IDfNm1nNsi2avprg==",
"dependencies": {
"ts-deepmerge": "^6.0.3"
},
"peerDependencies": {
"openapi3-ts": "^2.0.0 || ^3.0.0",
"zod": "^3.20.0"
}
},
"node_modules/@aws-crypto/crc32": { "node_modules/@aws-crypto/crc32": {
"version": "3.0.0", "version": "3.0.0",
"resolved": "https://registry.npmjs.org/@aws-crypto/crc32/-/crc32-3.0.0.tgz", "resolved": "https://registry.npmjs.org/@aws-crypto/crc32/-/crc32-3.0.0.tgz",
@ -1776,6 +1765,10 @@
"@jridgewell/sourcemap-codec": "^1.4.10" "@jridgewell/sourcemap-codec": "^1.4.10"
} }
}, },
"node_modules/@documenso/api": {
"resolved": "packages/api",
"link": true
},
"node_modules/@documenso/app-tests": { "node_modules/@documenso/app-tests": {
"resolved": "packages/app-tests", "resolved": "packages/app-tests",
"link": true "link": true
@ -14379,22 +14372,6 @@
"node": ">= 14.17.0" "node": ">= 14.17.0"
} }
}, },
"node_modules/openapi3-ts": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/openapi3-ts/-/openapi3-ts-2.0.2.tgz",
"integrity": "sha512-TxhYBMoqx9frXyOgnRHufjQfPXomTIHYKhSKJ6jHfj13kS8OEIhvmE8CTuQyKtjjWttAjX5DPxM1vmalEpo8Qw==",
"dependencies": {
"yaml": "^1.10.2"
}
},
"node_modules/openapi3-ts/node_modules/yaml": {
"version": "1.10.2",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
"integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==",
"engines": {
"node": ">= 6"
}
},
"node_modules/openid-client": { "node_modules/openid-client": {
"version": "5.6.1", "version": "5.6.1",
"resolved": "https://registry.npmjs.org/openid-client/-/openid-client-5.6.1.tgz", "resolved": "https://registry.npmjs.org/openid-client/-/openid-client-5.6.1.tgz",
@ -17858,14 +17835,6 @@
"typescript": ">=4.2.0" "typescript": ">=4.2.0"
} }
}, },
"node_modules/ts-deepmerge": {
"version": "6.2.0",
"resolved": "https://registry.npmjs.org/ts-deepmerge/-/ts-deepmerge-6.2.0.tgz",
"integrity": "sha512-2qxI/FZVDPbzh63GwWIZYE7daWKtwXZYuyc8YNq0iTmMUwn4mL0jRLsp6hfFlgbdRSR4x2ppe+E86FnvEpN7Nw==",
"engines": {
"node": ">=14.13.1"
}
},
"node_modules/ts-interface-checker": { "node_modules/ts-interface-checker": {
"version": "0.1.13", "version": "0.1.13",
"resolved": "https://registry.npmjs.org/ts-interface-checker/-/ts-interface-checker-0.1.13.tgz", "resolved": "https://registry.npmjs.org/ts-interface-checker/-/ts-interface-checker-0.1.13.tgz",
@ -19268,6 +19237,233 @@
"url": "https://github.com/sponsors/wooorm" "url": "https://github.com/sponsors/wooorm"
} }
}, },
"packages/api": {
"name": "@documenso/api",
"version": "1.0.0",
"license": "MIT",
"dependencies": {
"@documenso/lib": "*",
"@documenso/prisma": "*",
"@ts-rest/core": "^3.30.5",
"@ts-rest/next": "^3.30.5",
"luxon": "^3.4.0",
"superjson": "^1.13.1",
"ts-pattern": "^5.0.5",
"zod": "^3.22.4"
},
"devDependencies": {}
},
"packages/api/node_modules/@next/env": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/env/-/env-13.5.6.tgz",
"integrity": "sha512-Yac/bV5sBGkkEXmAX5FWPS9Mmo2rthrOPRQQNfycJPkjUAUclomCPH7QFVCDQ4Mp2k2K1SSM6m0zrxYrOwtFQw==",
"peer": true
},
"packages/api/node_modules/@next/swc-darwin-arm64": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-13.5.6.tgz",
"integrity": "sha512-5nvXMzKtZfvcu4BhtV0KH1oGv4XEW+B+jOfmBdpFI3C7FrB/MfujRpWYSBBO64+qbW8pkZiSyQv9eiwnn5VIQA==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"darwin"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-darwin-x64": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-13.5.6.tgz",
"integrity": "sha512-6cgBfxg98oOCSr4BckWjLLgiVwlL3vlLj8hXg2b+nDgm4bC/qVXXLfpLB9FHdoDu4057hzywbxKvmYGmi7yUzA==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"darwin"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-linux-arm64-gnu": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-13.5.6.tgz",
"integrity": "sha512-txagBbj1e1w47YQjcKgSU4rRVQ7uF29YpnlHV5xuVUsgCUf2FmyfJ3CPjZUvpIeXCJAoMCFAoGnbtX86BK7+sg==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"linux"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-linux-arm64-musl": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-13.5.6.tgz",
"integrity": "sha512-cGd+H8amifT86ZldVJtAKDxUqeFyLWW+v2NlBULnLAdWsiuuN8TuhVBt8ZNpCqcAuoruoSWynvMWixTFcroq+Q==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"linux"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-linux-x64-gnu": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-13.5.6.tgz",
"integrity": "sha512-Mc2b4xiIWKXIhBy2NBTwOxGD3nHLmq4keFk+d4/WL5fMsB8XdJRdtUlL87SqVCTSaf1BRuQQf1HvXZcy+rq3Nw==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"linux"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-linux-x64-musl": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-13.5.6.tgz",
"integrity": "sha512-CFHvP9Qz98NruJiUnCe61O6GveKKHpJLloXbDSWRhqhkJdZD2zU5hG+gtVJR//tyW897izuHpM6Gtf6+sNgJPQ==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"linux"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-win32-arm64-msvc": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-13.5.6.tgz",
"integrity": "sha512-aFv1ejfkbS7PUa1qVPwzDHjQWQtknzAZWGTKYIAaS4NMtBlk3VyA6AYn593pqNanlicewqyl2jUhQAaFV/qXsg==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"win32"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-win32-ia32-msvc": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-13.5.6.tgz",
"integrity": "sha512-XqqpHgEIlBHvzwG8sp/JXMFkLAfGLqkbVsyN+/Ih1mR8INb6YCc2x/Mbwi6hsAgUnqQztz8cvEbHJUbSl7RHDg==",
"cpu": [
"ia32"
],
"optional": true,
"os": [
"win32"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@next/swc-win32-x64-msvc": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-13.5.6.tgz",
"integrity": "sha512-Cqfe1YmOS7k+5mGu92nl5ULkzpKuxJrP3+4AEuPmrpFZ3BHxTY3TnHmU1On3bFmFFs6FbTcdF58CCUProGpIGQ==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"win32"
],
"peer": true,
"engines": {
"node": ">= 10"
}
},
"packages/api/node_modules/@ts-rest/next": {
"version": "3.30.5",
"resolved": "https://registry.npmjs.org/@ts-rest/next/-/next-3.30.5.tgz",
"integrity": "sha512-NasfUN7SnwcjJNbxvvcemC4fOv4f4IF5I14wVqQODN0HWPokkrta6XLuv0eKQJYdB32AS7VINQhls8Sj1AIN0g==",
"peerDependencies": {
"@ts-rest/core": "3.30.5",
"next": "^12.0.0 || ^13.0.0",
"zod": "^3.22.3"
},
"peerDependenciesMeta": {
"zod": {
"optional": true
}
}
},
"packages/api/node_modules/next": {
"version": "13.5.6",
"resolved": "https://registry.npmjs.org/next/-/next-13.5.6.tgz",
"integrity": "sha512-Y2wTcTbO4WwEsVb4A8VSnOsG1I9ok+h74q0ZdxkwM3EODqrs4pasq7O0iUxbcS9VtWMicG7f3+HAj0r1+NtKSw==",
"peer": true,
"dependencies": {
"@next/env": "13.5.6",
"@swc/helpers": "0.5.2",
"busboy": "1.6.0",
"caniuse-lite": "^1.0.30001406",
"postcss": "8.4.31",
"styled-jsx": "5.1.1",
"watchpack": "2.4.0"
},
"bin": {
"next": "dist/bin/next"
},
"engines": {
"node": ">=16.14.0"
},
"optionalDependencies": {
"@next/swc-darwin-arm64": "13.5.6",
"@next/swc-darwin-x64": "13.5.6",
"@next/swc-linux-arm64-gnu": "13.5.6",
"@next/swc-linux-arm64-musl": "13.5.6",
"@next/swc-linux-x64-gnu": "13.5.6",
"@next/swc-linux-x64-musl": "13.5.6",
"@next/swc-win32-arm64-msvc": "13.5.6",
"@next/swc-win32-ia32-msvc": "13.5.6",
"@next/swc-win32-x64-msvc": "13.5.6"
},
"peerDependencies": {
"@opentelemetry/api": "^1.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"sass": "^1.3.0"
},
"peerDependenciesMeta": {
"@opentelemetry/api": {
"optional": true
},
"sass": {
"optional": true
}
}
},
"packages/app-tests": { "packages/app-tests": {
"name": "@documenso/app-tests", "name": "@documenso/app-tests",
"version": "1.0.0", "version": "1.0.0",

1
packages/api/index.ts Normal file
View File

@ -0,0 +1 @@
export {};

1
packages/api/next.ts Normal file
View File

@ -0,0 +1 @@
export { createNextRouter } from '@ts-rest/next';

28
packages/api/package.json Normal file
View File

@ -0,0 +1,28 @@
{
"name": "@documenso/api",
"version": "1.0.0",
"main": "./index.ts",
"types": "./index.ts",
"license": "MIT",
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"clean": "rimraf node_modules"
},
"files": [
"index.ts",
"next.ts",
"v1/"
],
"dependencies": {
"@documenso/lib": "*",
"@documenso/prisma": "*",
"@ts-rest/core": "^3.30.5",
"@ts-rest/next": "^3.30.5",
"luxon": "^3.4.0",
"superjson": "^1.13.1",
"ts-pattern": "^5.0.5",
"zod": "^3.22.4"
},
"devDependencies": {}
}

View File

@ -0,0 +1,8 @@
{
"extends": "@documenso/tsconfig/react-library.json",
"include": ["."],
"exclude": ["dist", "build", "node_modules"],
"compilerOptions": {
"strict": true,
}
}

View File

@ -0,0 +1,84 @@
import { initContract } from '@ts-rest/core';
import {
ZSendDocumentForSigningMutationSchema as SendDocumentMutationSchema,
ZAuthorizationHeadersSchema,
ZCreateDocumentMutationSchema,
ZDeleteDocumentMutationSchema,
ZGetDocumentsQuerySchema,
ZSuccessfulDocumentResponseSchema,
ZSuccessfulResponseSchema,
ZSuccessfulSigningResponseSchema,
ZUnsuccessfulResponseSchema,
ZUploadDocumentSuccessfulSchema,
} from './schema';
const c = initContract();
export const ApiContractV1 = c.router(
{
getDocuments: {
method: 'GET',
path: '/documents',
query: ZGetDocumentsQuerySchema,
responses: {
200: ZSuccessfulResponseSchema,
401: ZUnsuccessfulResponseSchema,
404: ZUnsuccessfulResponseSchema,
},
summary: 'Get all documents',
},
getDocument: {
method: 'GET',
path: `/documents/:id`,
responses: {
200: ZSuccessfulDocumentResponseSchema,
401: ZUnsuccessfulResponseSchema,
404: ZUnsuccessfulResponseSchema,
},
summary: 'Get a single document',
},
createDocument: {
method: 'POST',
path: '/documents',
body: ZCreateDocumentMutationSchema,
responses: {
200: ZUploadDocumentSuccessfulSchema,
401: ZUnsuccessfulResponseSchema,
404: ZUnsuccessfulResponseSchema,
},
summary: 'Upload a new document and get a presigned URL',
},
sendDocument: {
method: 'PATCH',
path: '/documents/:id/send',
body: SendDocumentMutationSchema,
responses: {
200: ZSuccessfulSigningResponseSchema,
400: ZUnsuccessfulResponseSchema,
401: ZUnsuccessfulResponseSchema,
404: ZUnsuccessfulResponseSchema,
500: ZUnsuccessfulResponseSchema,
},
summary: 'Send a document for signing',
},
deleteDocument: {
method: 'DELETE',
path: `/documents/:id`,
body: ZDeleteDocumentMutationSchema,
responses: {
200: ZSuccessfulDocumentResponseSchema,
401: ZUnsuccessfulResponseSchema,
404: ZUnsuccessfulResponseSchema,
},
summary: 'Delete a document',
},
},
{
baseHeaders: ZAuthorizationHeadersSchema,
},
);

View File

@ -0,0 +1,178 @@
import { createNextRoute } from '@ts-rest/next';
import { upsertDocumentMeta } from '@documenso/lib/server-only/document-meta/upsert-document-meta';
import { deleteDocument } from '@documenso/lib/server-only/document/delete-document';
import { findDocuments } from '@documenso/lib/server-only/document/find-documents';
import { getDocumentById } from '@documenso/lib/server-only/document/get-document-by-id';
import { sendDocument } from '@documenso/lib/server-only/document/send-document';
import { setFieldsForDocument } from '@documenso/lib/server-only/field/set-fields-for-document';
import { setRecipientsForDocument } from '@documenso/lib/server-only/recipient/set-recipients-for-document';
import { getPresignPostUrl } from '@documenso/lib/universal/upload/server-actions';
import { ApiContractV1 } from './contract';
import { authenticatedMiddleware } from './middleware/authenticated';
export const ApiContractV1Implementation = createNextRoute(ApiContractV1, {
getDocuments: authenticatedMiddleware(async (args, user) => {
const page = Number(args.query.page) || 1;
const perPage = Number(args.query.perPage) || 10;
const { data: documents, totalPages } = await findDocuments({ page, perPage, userId: user.id });
return {
status: 200,
body: {
documents,
totalPages,
},
};
}),
getDocument: authenticatedMiddleware(async (args, user) => {
const { id: documentId } = args.params;
try {
const document = await getDocumentById({ id: Number(documentId), userId: user.id });
return {
status: 200,
body: document,
};
} catch (err) {
return {
status: 404,
body: {
message: 'Document not found',
},
};
}
}),
deleteDocument: authenticatedMiddleware(async (args, user) => {
const { id: documentId } = args.params;
try {
const document = await getDocumentById({ id: Number(documentId), userId: user.id });
const deletedDocument = await deleteDocument({
id: Number(documentId),
userId: user.id,
status: document.status,
});
return {
status: 200,
body: deletedDocument,
};
} catch (err) {
return {
status: 404,
body: {
message: 'Document not found',
},
};
}
}),
createDocument: authenticatedMiddleware(async (args, _user) => {
const { body } = args;
try {
const { url, key } = await getPresignPostUrl(body.fileName, body.contentType);
return {
status: 200,
body: {
url,
key,
},
};
} catch (err) {
return {
status: 404,
body: {
message: 'An error has occured while uploading the file',
},
};
}
}),
sendDocument: authenticatedMiddleware(async (args, user) => {
const { id } = args.params;
const { body } = args;
const document = await getDocumentById({ id: Number(id), userId: user.id });
if (!document) {
return {
status: 404,
body: {
message: 'Document not found',
},
};
}
if (document.status === 'PENDING') {
return {
status: 400,
body: {
message: 'Document is already waiting for signing',
},
};
}
try {
await setRecipientsForDocument({
userId: user.id,
documentId: Number(id),
recipients: [
{
email: body.signerEmail,
name: body.signerName ?? '',
},
],
});
await setFieldsForDocument({
documentId: Number(id),
userId: user.id,
fields: body.fields.map((field) => ({
signerEmail: body.signerEmail,
type: field.fieldType,
pageNumber: field.pageNumber,
pageX: field.pageX,
pageY: field.pageY,
pageWidth: field.pageWidth,
pageHeight: field.pageHeight,
})),
});
if (body.emailBody || body.emailSubject) {
await upsertDocumentMeta({
documentId: Number(id),
subject: body.emailSubject ?? '',
message: body.emailBody ?? '',
});
}
await sendDocument({
documentId: Number(id),
userId: user.id,
});
return {
status: 200,
body: {
message: 'Document sent for signing successfully',
},
};
} catch (err) {
return {
status: 500,
body: {
message: 'An error has occured while sending the document for signing',
},
};
}
}),
});

View File

@ -0,0 +1,37 @@
import type { NextApiRequest } from 'next';
import { getUserByApiToken } from '@documenso/lib/server-only/public-api/get-user-by-token';
import type { User } from '@documenso/prisma/client';
export const authenticatedMiddleware = <
T extends {
req: NextApiRequest;
},
R extends {
status: number;
body: unknown;
},
>(
handler: (args: T, user: User) => Promise<R>,
) => {
return async (args: T) => {
try {
const { authorization: token } = args.req.headers;
if (!token) {
throw new Error('Token was not provided for authenticated middleware');
}
const user = await getUserByApiToken({ token });
return await handler(args, user);
} catch (_err) {
return {
status: 401,
body: {
message: 'Unauthorized',
},
} as const;
}
};
};

87
packages/api/v1/schema.ts Normal file
View File

@ -0,0 +1,87 @@
import { z } from 'zod';
import { FieldType } from '@documenso/prisma/client';
export const ZGetDocumentsQuerySchema = z.object({
page: z.string().optional(),
perPage: z.string().optional(),
});
export type TGetDocumentsQuerySchema = z.infer<typeof ZGetDocumentsQuerySchema>;
export const ZDeleteDocumentMutationSchema = z.string();
export type TDeleteDocumentMutationSchema = z.infer<typeof ZDeleteDocumentMutationSchema>;
export const ZSuccessfulDocumentResponseSchema = z.object({
id: z.number(),
userId: z.number(),
title: z.string(),
status: z.string(),
documentDataId: z.string(),
createdAt: z.date(),
updatedAt: z.date(),
completedAt: z.date().nullable(),
});
export type TSuccessfulDocumentResponseSchema = z.infer<typeof ZSuccessfulDocumentResponseSchema>;
export const ZSendDocumentForSigningMutationSchema = z.object({
signerEmail: z.string(),
signerName: z.string().optional(),
emailSubject: z.string().optional(),
emailBody: z.string().optional(),
fields: z.array(
z.object({
fieldType: z.nativeEnum(FieldType),
pageNumber: z.number(),
pageX: z.number(),
pageY: z.number(),
pageWidth: z.number(),
pageHeight: z.number(),
}),
),
});
export type TSendDocumentForSigningMutationSchema = z.infer<
typeof ZSendDocumentForSigningMutationSchema
>;
export const ZUploadDocumentSuccessfulSchema = z.object({
url: z.string(),
key: z.string(),
});
export type TUploadDocumentSuccessfulSchema = z.infer<typeof ZUploadDocumentSuccessfulSchema>;
export const ZCreateDocumentMutationSchema = z.object({
fileName: z.string(),
contentType: z.string().default('PDF'),
});
export type TCreateDocumentMutationSchema = z.infer<typeof ZCreateDocumentMutationSchema>;
export const ZSuccessfulResponseSchema = z.object({
documents: ZSuccessfulDocumentResponseSchema.array(),
totalPages: z.number(),
});
export type TSuccessfulResponseSchema = z.infer<typeof ZSuccessfulResponseSchema>;
export const ZSuccessfulSigningResponseSchema = z.object({
message: z.string(),
});
export type TSuccessfulSigningResponseSchema = z.infer<typeof ZSuccessfulSigningResponseSchema>;
export const ZUnsuccessfulResponseSchema = z.object({
message: z.string(),
});
export type TUnsuccessfulResponseSchema = z.infer<typeof ZUnsuccessfulResponseSchema>;
export const ZAuthorizationHeadersSchema = z.object({
authorization: z.string(),
});
export type TAuthorizationHeadersSchema = z.infer<typeof ZAuthorizationHeadersSchema>;

View File

@ -5,7 +5,7 @@ export type GetUserTokensOptions = {
}; };
export const getUserTokens = async ({ userId }: GetUserTokensOptions) => { export const getUserTokens = async ({ userId }: GetUserTokensOptions) => {
return prisma.apiToken.findMany({ return await prisma.apiToken.findMany({
where: { where: {
userId, userId,
}, },
@ -16,5 +16,8 @@ export const getUserTokens = async ({ userId }: GetUserTokensOptions) => {
createdAt: true, createdAt: true,
expires: true, expires: true,
}, },
orderBy: {
createdAt: 'desc',
},
}); });
}; };

View File

@ -4,10 +4,16 @@ export const ZGetApiTokenByIdQuerySchema = z.object({
id: z.number().min(1), id: z.number().min(1),
}); });
export type TGetApiTokenByIdQuerySchema = z.infer<typeof ZGetApiTokenByIdQuerySchema>;
export const ZCreateTokenMutationSchema = z.object({ export const ZCreateTokenMutationSchema = z.object({
tokenName: z.string().min(3, { message: 'The token name should be 3 characters or longer' }), tokenName: z.string().min(3, { message: 'The token name should be 3 characters or longer' }),
}); });
export type TCreateTokenMutationSchema = z.infer<typeof ZCreateTokenMutationSchema>;
export const ZDeleteTokenByIdMutationSchema = z.object({ export const ZDeleteTokenByIdMutationSchema = z.object({
id: z.number().min(1), id: z.number().min(1),
}); });
export type TDeleteTokenByIdMutationSchema = z.infer<typeof ZDeleteTokenByIdMutationSchema>;