From e6486465decd612f7e437abe904960a47ff359ce Mon Sep 17 00:00:00 2001 From: kamtschatka Date: Mon, 1 Jul 2024 13:03:53 +0200 Subject: refactor: added the bookmark type to the database (#256) * refactoring asset types Extracted out functions to silently delete assets and to update them after crawling Generalized the mapping of assets to bookmark fields to make extending them easier * Added the bookmark type to the database Introduced an enum to have better type safety cleaned up the code and based some code on the type directly * add BookmarkType.UNKNWON * lint and remove unused function --------- Co-authored-by: MohamedBassem --- apps/web/components/dashboard/UploadDropzone.tsx | 5 +++-- apps/web/components/dashboard/bookmarks/BookmarkCard.tsx | 8 ++++---- apps/web/components/dashboard/bookmarks/BookmarkOptions.tsx | 7 ++++--- .../components/dashboard/bookmarks/BookmarkedTextEditor.tsx | 6 ++++-- apps/web/components/dashboard/bookmarks/EditorCard.tsx | 12 ++++++++---- .../web/components/dashboard/preview/AssetContentSection.tsx | 4 ++-- apps/web/components/dashboard/preview/BookmarkPreview.tsx | 12 ++++++------ apps/web/components/dashboard/preview/EditableTitle.tsx | 8 ++++---- apps/web/components/dashboard/preview/LinkContentSection.tsx | 8 ++++++-- apps/web/components/dashboard/preview/TextContentSection.tsx | 4 ++-- 10 files changed, 43 insertions(+), 31 deletions(-) (limited to 'apps/web/components') diff --git a/apps/web/components/dashboard/UploadDropzone.tsx b/apps/web/components/dashboard/UploadDropzone.tsx index 2807b892..05e8901e 100644 --- a/apps/web/components/dashboard/UploadDropzone.tsx +++ b/apps/web/components/dashboard/UploadDropzone.tsx @@ -8,6 +8,7 @@ import { TRPCClientError } from "@trpc/client"; import DropZone from "react-dropzone"; import { useCreateBookmarkWithPostHook } from "@hoarder/shared-react/hooks/bookmarks"; +import { BookmarkTypes } from "@hoarder/shared/types/bookmarks"; import { zUploadErrorSchema, zUploadResponseSchema, @@ -50,7 +51,7 @@ export function useUploadAsset() { onSuccess: async (resp) => { const assetType = resp.contentType === "application/pdf" ? "pdf" : "image"; - return createBookmark({ ...resp, type: "asset", assetType }); + return createBookmark({ ...resp, type: BookmarkTypes.ASSET, assetType }); }, onError: (error, req) => { const err = zUploadErrorSchema.parse(JSON.parse(error.message)); @@ -68,7 +69,7 @@ export function useUploadAsset() { onSuccess: async (resp) => { return Promise.all( resp.map((url) => - createBookmark({ type: "link", url: url.toString() }), + createBookmark({ type: BookmarkTypes.LINK, url: url.toString() }), ), ); }, diff --git a/apps/web/components/dashboard/bookmarks/BookmarkCard.tsx b/apps/web/components/dashboard/bookmarks/BookmarkCard.tsx index 76316de7..ec0d4069 100644 --- a/apps/web/components/dashboard/bookmarks/BookmarkCard.tsx +++ b/apps/web/components/dashboard/bookmarks/BookmarkCard.tsx @@ -1,7 +1,7 @@ import { api } from "@/lib/trpc"; -import type { ZBookmark } from "@hoarder/shared/types/bookmarks"; import { isBookmarkStillLoading } from "@hoarder/shared-react/utils/bookmarkUtils"; +import { BookmarkTypes, ZBookmark } from "@hoarder/shared/types/bookmarks"; import AssetCard from "./AssetCard"; import LinkCard from "./LinkCard"; @@ -34,21 +34,21 @@ export default function BookmarkCard({ ); switch (bookmark.content.type) { - case "link": + case BookmarkTypes.LINK: return ( ); - case "text": + case BookmarkTypes.TEXT: return ( ); - case "asset": + case BookmarkTypes.ASSET: return ( - {bookmark.content.type === "text" && ( + {bookmark.content.type === BookmarkTypes.TEXT && ( setTextEditorOpen(true)}> Edit @@ -151,7 +152,7 @@ export default function BookmarkOptions({ bookmark }: { bookmark: ZBookmark }) { /> {bookmark.archived ? "Un-archive" : "Archive"} - {bookmark.content.type === "link" && ( + {bookmark.content.type === BookmarkTypes.LINK && ( { navigator.clipboard.writeText( @@ -191,7 +192,7 @@ export default function BookmarkOptions({ bookmark }: { bookmark: ZBookmark }) { )} - {bookmark.content.type === "link" && ( + {bookmark.content.type === BookmarkTypes.LINK && ( diff --git a/apps/web/components/dashboard/bookmarks/BookmarkedTextEditor.tsx b/apps/web/components/dashboard/bookmarks/BookmarkedTextEditor.tsx index db69e1a3..74e94f94 100644 --- a/apps/web/components/dashboard/bookmarks/BookmarkedTextEditor.tsx +++ b/apps/web/components/dashboard/bookmarks/BookmarkedTextEditor.tsx @@ -14,7 +14,7 @@ import { Textarea } from "@/components/ui/textarea"; import { toast } from "@/components/ui/use-toast"; import { api } from "@/lib/trpc"; -import type { ZBookmark } from "@hoarder/shared/types/bookmarks"; +import { BookmarkTypes, ZBookmark } from "@hoarder/shared/types/bookmarks"; export function BookmarkedTextEditor({ bookmark, @@ -27,7 +27,9 @@ export function BookmarkedTextEditor({ }) { const isNewBookmark = bookmark === undefined; const [noteText, setNoteText] = useState( - bookmark && bookmark.content.type == "text" ? bookmark.content.text : "", + bookmark && bookmark.content.type == BookmarkTypes.TEXT + ? bookmark.content.text + : "", ); const invalidateOneBookmarksCache = diff --git a/apps/web/components/dashboard/bookmarks/EditorCard.tsx b/apps/web/components/dashboard/bookmarks/EditorCard.tsx index a1055e8e..78bd0742 100644 --- a/apps/web/components/dashboard/bookmarks/EditorCard.tsx +++ b/apps/web/components/dashboard/bookmarks/EditorCard.tsx @@ -19,6 +19,7 @@ import { useForm } from "react-hook-form"; import { z } from "zod"; import { useCreateBookmarkWithPostHook } from "@hoarder/shared-react/hooks/bookmarks"; +import { BookmarkTypes } from "@hoarder/shared/types/bookmarks"; import { useUploadAsset } from "../UploadDropzone"; @@ -99,7 +100,7 @@ export default function EditorCard({ className }: { className?: string }) { if (urls.length === 1) { // Only 1 url in the textfield --> simply import it - mutate({ type: "link", url: text }); + mutate({ type: BookmarkTypes.LINK, url: text }); return; } // multiple urls found --> ask the user if it should be imported as multiple URLs or as a text bookmark @@ -128,7 +129,7 @@ export default function EditorCard({ className }: { className?: string }) { tryToImportUrls(text); } catch (e) { // Not a URL - mutate({ type: "text", text }); + mutate({ type: BookmarkTypes.TEXT, text }); } }; @@ -240,7 +241,10 @@ export default function EditorCard({ className }: { className?: string }) { variant="secondary" loading={isPending} onClick={() => { - mutate({ type: "text", text: multiUrlImportState.text }); + mutate({ + type: BookmarkTypes.TEXT, + text: multiUrlImportState.text, + }); setMultiUrlImportState(null); }} > @@ -254,7 +258,7 @@ export default function EditorCard({ className }: { className?: string }) { loading={isPending} onClick={() => { multiUrlImportState.urls.forEach((url) => - mutate({ type: "link", url: url.toString() }), + mutate({ type: BookmarkTypes.LINK, url: url.toString() }), ); setMultiUrlImportState(null); }} diff --git a/apps/web/components/dashboard/preview/AssetContentSection.tsx b/apps/web/components/dashboard/preview/AssetContentSection.tsx index 4d6bb976..03ab8a43 100644 --- a/apps/web/components/dashboard/preview/AssetContentSection.tsx +++ b/apps/web/components/dashboard/preview/AssetContentSection.tsx @@ -1,10 +1,10 @@ import Image from "next/image"; import Link from "next/link"; -import type { ZBookmark } from "@hoarder/shared/types/bookmarks"; +import { BookmarkTypes, ZBookmark } from "@hoarder/shared/types/bookmarks"; export function AssetContentSection({ bookmark }: { bookmark: ZBookmark }) { - if (bookmark.content.type != "asset") { + if (bookmark.content.type != BookmarkTypes.ASSET) { throw new Error("Invalid content type"); } diff --git a/apps/web/components/dashboard/preview/BookmarkPreview.tsx b/apps/web/components/dashboard/preview/BookmarkPreview.tsx index 6a1068af..01e57e05 100644 --- a/apps/web/components/dashboard/preview/BookmarkPreview.tsx +++ b/apps/web/components/dashboard/preview/BookmarkPreview.tsx @@ -17,11 +17,11 @@ import dayjs from "dayjs"; import relativeTime from "dayjs/plugin/relativeTime"; import { CalendarDays, ExternalLink } from "lucide-react"; -import type { ZBookmark } from "@hoarder/shared/types/bookmarks"; import { isBookmarkStillCrawling, isBookmarkStillLoading, } from "@hoarder/shared-react/utils/bookmarkUtils"; +import { BookmarkTypes, ZBookmark } from "@hoarder/shared/types/bookmarks"; import ActionBar from "./ActionBar"; import { AssetContentSection } from "./AssetContentSection"; @@ -66,10 +66,10 @@ function CreationTime({ createdAt }: { createdAt: Date }) { } function getSourceUrl(bookmark: ZBookmark) { - if (bookmark.content.type === "link") { + if (bookmark.content.type === BookmarkTypes.LINK) { return bookmark.content.url; } - if (bookmark.content.type === "asset") { + if (bookmark.content.type === BookmarkTypes.ASSET) { return bookmark.content.sourceUrl; } return null; @@ -108,15 +108,15 @@ export default function BookmarkPreview({ let content; switch (bookmark.content.type) { - case "link": { + case BookmarkTypes.LINK: { content = ; break; } - case "text": { + case BookmarkTypes.TEXT: { content = ; break; } - case "asset": { + case BookmarkTypes.ASSET: { content = ; break; } diff --git a/apps/web/components/dashboard/preview/EditableTitle.tsx b/apps/web/components/dashboard/preview/EditableTitle.tsx index 237ad108..03b95e74 100644 --- a/apps/web/components/dashboard/preview/EditableTitle.tsx +++ b/apps/web/components/dashboard/preview/EditableTitle.tsx @@ -1,7 +1,7 @@ import { toast } from "@/components/ui/use-toast"; import { useUpdateBookmark } from "@hoarder/shared-react/hooks/bookmarks"; -import { ZBookmark } from "@hoarder/shared/types/bookmarks"; +import { BookmarkTypes, ZBookmark } from "@hoarder/shared/types/bookmarks"; import { EditableText } from "../EditableText"; @@ -16,13 +16,13 @@ export function EditableTitle({ bookmark }: { bookmark: ZBookmark }) { let title: string | null = null; switch (bookmark.content.type) { - case "link": + case BookmarkTypes.LINK: title = bookmark.content.title ?? bookmark.content.url; break; - case "text": + case BookmarkTypes.TEXT: title = null; break; - case "asset": + case BookmarkTypes.ASSET: title = bookmark.content.fileName ?? null; break; } diff --git a/apps/web/components/dashboard/preview/LinkContentSection.tsx b/apps/web/components/dashboard/preview/LinkContentSection.tsx index 3aeacdcd..f2069821 100644 --- a/apps/web/components/dashboard/preview/LinkContentSection.tsx +++ b/apps/web/components/dashboard/preview/LinkContentSection.tsx @@ -10,7 +10,11 @@ import { } from "@/components/ui/select"; import { ScrollArea } from "@radix-ui/react-scroll-area"; -import { ZBookmark, ZBookmarkedLink } from "@hoarder/shared/types/bookmarks"; +import { + BookmarkTypes, + ZBookmark, + ZBookmarkedLink, +} from "@hoarder/shared/types/bookmarks"; function FullPageArchiveSection({ link }: { link: ZBookmarkedLink }) { return ( @@ -63,7 +67,7 @@ export default function LinkContentSection({ }) { const [section, setSection] = useState("cached"); - if (bookmark.content.type != "link") { + if (bookmark.content.type != BookmarkTypes.LINK) { throw new Error("Invalid content type"); } diff --git a/apps/web/components/dashboard/preview/TextContentSection.tsx b/apps/web/components/dashboard/preview/TextContentSection.tsx index 2df1e964..76cb23ea 100644 --- a/apps/web/components/dashboard/preview/TextContentSection.tsx +++ b/apps/web/components/dashboard/preview/TextContentSection.tsx @@ -1,10 +1,10 @@ import { MarkdownComponent } from "@/components/ui/markdown-component"; import { ScrollArea } from "@radix-ui/react-scroll-area"; -import type { ZBookmark } from "@hoarder/shared/types/bookmarks"; +import { BookmarkTypes, ZBookmark } from "@hoarder/shared/types/bookmarks"; export function TextContentSection({ bookmark }: { bookmark: ZBookmark }) { - if (bookmark.content.type != "text") { + if (bookmark.content.type != BookmarkTypes.TEXT) { throw new Error("Invalid content type"); } return ( -- cgit v1.2.3-70-g09d2