aboutsummaryrefslogtreecommitdiffstats
path: root/apps/web
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2024-11-03 17:09:47 +0000
committerMohamed Bassem <me@mbassem.com>2024-11-03 17:09:47 +0000
commitcf1a25131fd45ab7c9a72b837be525c24457cd8b (patch)
treecb8b3d4a57a4ce06e500e4c7ceea43924d64a5d4 /apps/web
parent2efc7c8c01866fafad5322fb8783d94821e32ff1 (diff)
downloadkarakeep-cf1a25131fd45ab7c9a72b837be525c24457cd8b.tar.zst
feature: Add support for subscribing to RSS feeds. Fixes #202
Diffstat (limited to 'apps/web')
-rw-r--r--apps/web/app/settings/feeds/page.tsx5
-rw-r--r--apps/web/components/settings/FeedSettings.tsx398
-rw-r--r--apps/web/components/settings/sidebar/items.tsx14
3 files changed, 416 insertions, 1 deletions
diff --git a/apps/web/app/settings/feeds/page.tsx b/apps/web/app/settings/feeds/page.tsx
new file mode 100644
index 00000000..d2d1f182
--- /dev/null
+++ b/apps/web/app/settings/feeds/page.tsx
@@ -0,0 +1,5 @@
+import FeedSettings from "@/components/settings/FeedSettings";
+
+export default function FeedSettingsPage() {
+ return <FeedSettings />;
+}
diff --git a/apps/web/components/settings/FeedSettings.tsx b/apps/web/components/settings/FeedSettings.tsx
new file mode 100644
index 00000000..9f2dbda9
--- /dev/null
+++ b/apps/web/components/settings/FeedSettings.tsx
@@ -0,0 +1,398 @@
+"use client";
+
+import React from "react";
+import { ActionButton } from "@/components/ui/action-button";
+import {
+ Form,
+ FormControl,
+ FormField,
+ FormItem,
+ FormLabel,
+ FormMessage,
+} from "@/components/ui/form";
+import { FullPageSpinner } from "@/components/ui/full-page-spinner";
+import { Input } from "@/components/ui/input";
+import { toast } from "@/components/ui/use-toast";
+import { api } from "@/lib/trpc";
+import { zodResolver } from "@hookform/resolvers/zod";
+import {
+ ArrowDownToLine,
+ CheckCircle,
+ CircleDashed,
+ Edit,
+ Plus,
+ Save,
+ Trash2,
+ XCircle,
+} from "lucide-react";
+import { useForm } from "react-hook-form";
+import { z } from "zod";
+
+import {
+ ZFeed,
+ zNewFeedSchema,
+ zUpdateFeedSchema,
+} from "@hoarder/shared/types/feeds";
+
+import ActionConfirmingDialog from "../ui/action-confirming-dialog";
+import { Button } from "../ui/button";
+import {
+ Dialog,
+ DialogClose,
+ DialogContent,
+ DialogFooter,
+ DialogHeader,
+ DialogTitle,
+ DialogTrigger,
+} from "../ui/dialog";
+import {
+ Table,
+ TableBody,
+ TableCell,
+ TableHead,
+ TableHeader,
+ TableRow,
+} from "../ui/table";
+
+export function FeedsEditorDialog() {
+ const [open, setOpen] = React.useState(false);
+ const apiUtils = api.useUtils();
+
+ const form = useForm<z.infer<typeof zNewFeedSchema>>({
+ resolver: zodResolver(zNewFeedSchema),
+ defaultValues: {
+ name: "",
+ url: "",
+ },
+ });
+
+ React.useEffect(() => {
+ if (open) {
+ form.reset();
+ }
+ }, [open]);
+
+ const { mutateAsync: createFeed, isPending: isCreating } =
+ api.feeds.create.useMutation({
+ onSuccess: () => {
+ toast({
+ description: "Feed has been created!",
+ });
+ apiUtils.feeds.list.invalidate();
+ setOpen(false);
+ },
+ });
+
+ return (
+ <Dialog open={open} onOpenChange={setOpen}>
+ <DialogTrigger asChild>
+ <Button>
+ <Plus className="mr-2 size-4" />
+ Add a Subscription
+ </Button>
+ </DialogTrigger>
+ <DialogContent>
+ <DialogHeader>
+ <DialogTitle>Subscribe to a new Feed</DialogTitle>
+ </DialogHeader>
+ <Form {...form}>
+ <form
+ className="flex flex-col gap-3"
+ onSubmit={form.handleSubmit(async (value) => {
+ await createFeed(value);
+ form.resetField("name");
+ form.resetField("url");
+ })}
+ >
+ <FormField
+ control={form.control}
+ name="name"
+ render={({ field }) => {
+ return (
+ <FormItem className="flex-1">
+ <FormLabel>Name</FormLabel>
+ <FormControl>
+ <Input placeholder="Feed Name" type="text" {...field} />
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ );
+ }}
+ />
+ <FormField
+ control={form.control}
+ name="url"
+ render={({ field }) => {
+ return (
+ <FormItem className="flex-1">
+ <FormLabel>URL</FormLabel>
+ <FormControl>
+ <Input placeholder="Feed URL" type="text" {...field} />
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ );
+ }}
+ />
+ </form>
+ </Form>
+ <DialogFooter>
+ <DialogClose asChild>
+ <Button type="button" variant="secondary">
+ Close
+ </Button>
+ </DialogClose>
+ <ActionButton
+ onClick={form.handleSubmit(async (value) => {
+ await createFeed(value);
+ })}
+ loading={isCreating}
+ variant="default"
+ className="items-center"
+ >
+ <Plus className="mr-2 size-4" />
+ Add
+ </ActionButton>
+ </DialogFooter>
+ </DialogContent>
+ </Dialog>
+ );
+}
+
+export function EditFeedDialog({ feed }: { feed: ZFeed }) {
+ const apiUtils = api.useUtils();
+ const [open, setOpen] = React.useState(false);
+ React.useEffect(() => {
+ if (open) {
+ form.reset({
+ feedId: feed.id,
+ name: feed.name,
+ url: feed.url,
+ });
+ }
+ }, [open]);
+ const { mutateAsync: updateFeed, isPending: isUpdating } =
+ api.feeds.update.useMutation({
+ onSuccess: () => {
+ toast({
+ description: "Feed has been updated!",
+ });
+ setOpen(false);
+ apiUtils.feeds.list.invalidate();
+ },
+ });
+ const form = useForm<z.infer<typeof zUpdateFeedSchema>>({
+ resolver: zodResolver(zUpdateFeedSchema),
+ defaultValues: {
+ feedId: feed.id,
+ name: feed.name,
+ url: feed.url,
+ },
+ });
+ return (
+ <Dialog open={open} onOpenChange={setOpen}>
+ <DialogTrigger asChild>
+ <Button variant="secondary">
+ <Edit className="mr-2 size-4" />
+ Edit
+ </Button>
+ </DialogTrigger>
+ <DialogContent>
+ <DialogHeader>
+ <DialogTitle>Edit Feed</DialogTitle>
+ </DialogHeader>
+
+ <Form {...form}>
+ <form
+ className="flex flex-col gap-3"
+ onSubmit={form.handleSubmit(async (value) => {
+ await updateFeed(value);
+ })}
+ >
+ <FormField
+ control={form.control}
+ name="feedId"
+ render={({ field }) => {
+ return (
+ <FormItem className="hidden">
+ <FormControl>
+ <Input type="hidden" {...field} />
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ );
+ }}
+ />
+ <FormField
+ control={form.control}
+ name="name"
+ render={({ field }) => {
+ return (
+ <FormItem className="flex-1">
+ <FormLabel>Name</FormLabel>
+ <FormControl>
+ <Input placeholder="Feed name" type="text" {...field} />
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ );
+ }}
+ />
+ <FormField
+ control={form.control}
+ name="url"
+ render={({ field }) => {
+ return (
+ <FormItem className="flex-1">
+ <FormLabel>URL</FormLabel>
+ <FormControl>
+ <Input placeholder="Feed url" type="text" {...field} />
+ </FormControl>
+ <FormMessage />
+ </FormItem>
+ );
+ }}
+ />
+ </form>
+ </Form>
+ <DialogFooter>
+ <DialogClose asChild>
+ <Button type="button" variant="secondary">
+ Close
+ </Button>
+ </DialogClose>
+ <ActionButton
+ loading={isUpdating}
+ onClick={form.handleSubmit(async (value) => {
+ await updateFeed(value);
+ })}
+ type="submit"
+ className="items-center"
+ >
+ <Save className="mr-2 size-4" />
+ Save
+ </ActionButton>
+ </DialogFooter>
+ </DialogContent>
+ </Dialog>
+ );
+}
+
+export function FeedRow({ feed }: { feed: ZFeed }) {
+ const apiUtils = api.useUtils();
+ const { mutate: deleteFeed, isPending: isDeleting } =
+ api.feeds.delete.useMutation({
+ onSuccess: () => {
+ toast({
+ description: "Feed has been deleted!",
+ });
+ apiUtils.feeds.list.invalidate();
+ },
+ });
+
+ const { mutate: fetchNow, isPending: isFetching } =
+ api.feeds.fetchNow.useMutation({
+ onSuccess: () => {
+ toast({
+ description: "Feed fetch has been enqueued!",
+ });
+ apiUtils.feeds.list.invalidate();
+ },
+ });
+
+ return (
+ <TableRow>
+ <TableCell>{feed.name}</TableCell>
+ <TableCell>{feed.url}</TableCell>
+ <TableCell>{feed.lastFetchedAt?.toLocaleString()}</TableCell>
+ <TableCell>
+ {feed.lastFetchedStatus === "success" ? (
+ <span title="Successful">
+ <CheckCircle />
+ </span>
+ ) : feed.lastFetchedStatus === "failure" ? (
+ <span title="Failed">
+ <XCircle />
+ </span>
+ ) : (
+ <span title="Pending">
+ <CircleDashed name="Pending" />
+ </span>
+ )}
+ </TableCell>
+ <TableCell className="flex items-center gap-2">
+ <EditFeedDialog feed={feed} />
+ <ActionButton
+ loading={isFetching}
+ variant="secondary"
+ className="items-center"
+ onClick={() => fetchNow({ feedId: feed.id })}
+ >
+ <ArrowDownToLine className="mr-2 size-4" />
+ Fetch Now
+ </ActionButton>
+ <ActionConfirmingDialog
+ title={`Delete Feed "${feed.name}"?`}
+ description={`Are you sure you want to delete the feed "${feed.name}"?`}
+ actionButton={() => (
+ <ActionButton
+ loading={isDeleting}
+ variant="destructive"
+ onClick={() => deleteFeed({ feedId: feed.id })}
+ className="items-center"
+ type="button"
+ >
+ <Trash2 className="mr-2 size-4" />
+ Delete
+ </ActionButton>
+ )}
+ >
+ <Button variant="destructive" disabled={isDeleting}>
+ <Trash2 className="mr-2 size-4" />
+ Delete
+ </Button>
+ </ActionConfirmingDialog>
+ </TableCell>
+ </TableRow>
+ );
+}
+
+export default function FeedSettings() {
+ const { data: feeds, isLoading } = api.feeds.list.useQuery();
+ return (
+ <>
+ <div className="rounded-md border bg-background p-4">
+ <div className="flex flex-col gap-2">
+ <div className="flex items-center justify-between">
+ <div className="mb-2 text-lg font-medium">RSS Subscriptions</div>
+ <FeedsEditorDialog />
+ </div>
+ {isLoading && <FullPageSpinner />}
+ {feeds && feeds.feeds.length == 0 && (
+ <p className="rounded-md bg-muted p-2 text-sm text-muted-foreground">
+ You don&apos;t have any RSS subscriptions yet.
+ </p>
+ )}
+ {feeds && feeds.feeds.length > 0 && (
+ <Table>
+ <TableHeader>
+ <TableRow>
+ <TableHead>Name</TableHead>
+ <TableHead>URL</TableHead>
+ <TableHead>Last Fetch</TableHead>
+ <TableHead>Last Status</TableHead>
+ <TableHead>Actions</TableHead>
+ </TableRow>
+ </TableHeader>
+ <TableBody>
+ {feeds.feeds.map((feed) => (
+ <FeedRow key={feed.id} feed={feed} />
+ ))}
+ </TableBody>
+ </Table>
+ )}
+ </div>
+ </div>
+ </>
+ );
+}
diff --git a/apps/web/components/settings/sidebar/items.tsx b/apps/web/components/settings/sidebar/items.tsx
index 999825db..047ee233 100644
--- a/apps/web/components/settings/sidebar/items.tsx
+++ b/apps/web/components/settings/sidebar/items.tsx
@@ -1,5 +1,12 @@
import React from "react";
-import { ArrowLeft, Download, KeyRound, Sparkles, User } from "lucide-react";
+import {
+ ArrowLeft,
+ Download,
+ KeyRound,
+ Rss,
+ Sparkles,
+ User,
+} from "lucide-react";
export const settingsSidebarItems: {
name: string;
@@ -22,6 +29,11 @@ export const settingsSidebarItems: {
path: "/settings/ai",
},
{
+ name: "RSS Subscriptions",
+ icon: <Rss size={18} />,
+ path: "/settings/feeds",
+ },
+ {
name: "Import / Export",
icon: <Download size={18} />,
path: "/settings/import",