feat: API can now handle manual bookmark creation

Author: Zac-Zajdel

app/api/bookmarks/route.ts

@@ -70,29 +70,41 @@ export const GET = withAuthManager(
 export const POST = withAuthManager(
   async ({ req, user }): Promise<NextResponse<OasisResponse<Bookmark>>> => {
     const schema = createBookmarkSchema(user);
-    const { url } = await schema.parseAsync(await req.json());
+    const { url, title, description, iconName, isManual } =
+      await schema.parseAsync(await req.json());
 
-    // TODO - add manual creation of bookmark logic.
-
-    const { result } = await ogs({
-      url: url,
-      fetchOptions: {
-        headers: {
-          'user-agent':
-            'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36',
+    let createdBookmark;
+    if (isManual) {
+      createdBookmark = await prisma.bookmark.create({
+        data: {
+          url,
+          userId: user.id,
+          title: title || 'must be required',
+          description: description,
+          iconName: iconName,
         },
-      },
-    });
-
-    const createdBookmark = await prisma.bookmark.create({
-      data: {
-        userId: user.id,
+      });
+    } else {
+      const { result } = await ogs({
         url: url,
-        title: result.ogTitle || result.ogSiteName || 'Title',
-        description: result.ogDescription || result.twitterDescription || '',
-        imageUrl: parseUrl(result?.favicon),
-      },
-    });
+        fetchOptions: {
+          headers: {
+            'user-agent':
+              'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36',
+          },
+        },
+      });
+
+      createdBookmark = await prisma.bookmark.create({
+        data: {
+          url,
+          userId: user.id,
+          title: result.ogTitle || result.ogSiteName || 'Title',
+          description: result.ogDescription || result.twitterDescription || '',
+          imageUrl: parseUrl(result?.favicon),
+        },
+      });
+    }
 
     return NextResponse.json(
       {

lib/zod/bookmarks.ts

@@ -46,6 +46,14 @@ export const createBookmarkSchema = (user: AuthUser) => {
   return z
     .object({
       url: z.string().url(),
+      title: z.string().optional(),
+      description: z.string().nullable().optional(),
+      iconName: z.string().nullable().optional(),
+      isManual: z.boolean().optional(),
+    })
+    .refine((data) => !data.isManual || (data.isManual && data.title), {
+      message: 'Title is required',
+      path: ['title'],
     })
     .superRefine(async (data, ctx) => {
       const urlExists = await prisma.bookmark.findFirst({
@@ -73,6 +81,9 @@ export const updateBookmarkSchema = (user: AuthUser) => {
       description: z.string().nullable().optional(),
       isFavorite: z.boolean(),
       iconName: z.string().nullable().optional(),
+      // TODO - What happens if it isn't something valid?
+      // TODO - valid without having to update this every single time there is a release of new icons?
+      // TODO - Maybe make a scripts folder with a command that updates a types file containing these?
     })
     .superRefine(async (data, ctx) => {
       const bookmarkExists = await prisma.bookmark.findFirst({

prisma/seed.ts

@@ -67,7 +67,7 @@ async function seedExternalApiToken(user: User): Promise<void> {
   await prisma.apiToken.create({
     data: {
       userId: user.id,
-      name: 'Custom API Token',
+      name: `API Token - ${randomBytes(5).toString('hex').toString()}`,
       token: hashedApiToken,
     },
   });

tests/bookmarks/create-bookmark.test.ts renamed to tests/bookmarks/create-automatic-bookmark.test.ts

@@ -4,8 +4,7 @@ import { OasisTestContext, getSetupData } from '@/tests/utils/setup';
 import { Bookmark } from '@prisma/client';
 import { afterAll, expect, test } from 'vitest';
 
-// TODO - Rename this to automatic and create one for manual
-test('POST /bookmarks', async (ctx: OasisTestContext) => {
+test('POST AUTOMATIC /bookmarks', async (ctx: OasisTestContext) => {
   const { user } = getSetupData();
   const { http } = await new IntegrationHarness(ctx).init();
 

tests/bookmarks/create-manual-bookmark.test.ts

@@ -0,0 +1,42 @@
+import { prisma } from '@/lib/db';
+import { IntegrationHarness } from '@/tests/utils/integration';
+import { OasisTestContext, getSetupData } from '@/tests/utils/setup';
+import { Bookmark } from '@prisma/client';
+import { afterAll, expect, test } from 'vitest';
+
+test('POST MANUAL /bookmarks', async (ctx: OasisTestContext) => {
+  const { user } = getSetupData();
+  const { http } = await new IntegrationHarness(ctx).init();
+
+  const {
+    status,
+    data: { success, message, data: bookmark },
+  } = await http.post<Bookmark>({
+    path: '/bookmarks',
+    body: {
+      url: 'https://www.youtube.com/',
+      title: 'Youtube',
+      description: 'Watch Videos',
+      iconName: 'Video',
+      isManual: true,
+    },
+  });
+
+  expect(status).toBe(201);
+  expect(success).toBe(true);
+  expect(message).toBe('Bookmark was created successfully.');
+  expect(bookmark).toEqual(
+    expect.objectContaining({
+      userId: user.id,
+      url: 'https://www.youtube.com/',
+      title: 'Youtube',
+      description: 'Watch Videos',
+      iconName: 'Video',
+      visits: 0,
+    }),
+  );
+});
+
+afterAll(async () => {
+  await prisma.bookmark.deleteMany({});
+});