autobrr/web/src/forms/settings/NotificationForms.tsx

720 lines
26 KiB
TypeScript

/*
* Copyright (c) 2021 - 2025, Ludvig Lundgren and the autobrr contributors.
* SPDX-License-Identifier: GPL-2.0-or-later
*/
import { Dialog, DialogPanel, DialogTitle, Transition, TransitionChild } from "@headlessui/react";
import { Fragment } from "react";
import type { FieldProps } from "formik";
import { Field, Form, Formik, FormikErrors, FormikValues } from "formik";
import { XMarkIcon } from "@heroicons/react/24/solid";
import Select from "react-select";
import { useMutation, useQueryClient } from "@tanstack/react-query";
import { APIClient } from "@api/APIClient";
import { NotificationKeys } from "@api/query_keys";
import { EventOptions, NotificationTypeOptions, SelectOption } from "@domain/constants";
import { DEBUG } from "@components/debug";
import { SlideOver } from "@components/panels";
import { ExternalLink } from "@components/ExternalLink";
import { toast } from "@components/hot-toast";
import Toast from "@components/notifications/Toast";
import * as common from "@components/inputs/common";
import { NumberFieldWide, PasswordFieldWide, SwitchGroupWide, TextFieldWide } from "@components/inputs";
import { componentMapType } from "./DownloadClientForms";
import { AddFormProps, UpdateFormProps } from "@forms/_shared";
function FormFieldsDiscord() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-400">
{"Create a "}
<ExternalLink
href="https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks"
className="font-medium text-blue-500 underline underline-offset-1 hover:text-blue-400"
>
webhook integration
</ExternalLink>
{" in your server."}
</p>
</div>
<PasswordFieldWide
name="webhook"
label="Webhook URL"
help="Discord channel webhook url"
placeholder="https://discordapp.com/api/webhooks/xx/xx"
/>
</div>
);
}
function FormFieldsNotifiarr() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-400">
Enable the autobrr integration and optionally create a new API Key.
</p>
</div>
<PasswordFieldWide
name="api_key"
label="API Key"
help="Notifiarr API Key"
/>
</div>
);
}
function FormFieldsLunaSea() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-400">
LunaSea offers notifications across all devices linked to your account (User-Based) or to a single device without an account, using a unique webhook per device (Device-Based).
</p>
<p className="text-sm text-gray-500 dark:text-gray-400">
{"Read the "}
<ExternalLink
href="https://docs.lunasea.app/lunasea/notifications"
className="font-medium text-blue-500 underline underline-offset-1 hover:text-blue-400"
>
LunaSea docs
</ExternalLink>
{"."}
</p>
</div>
<PasswordFieldWide
name="webhook"
label="Webhook URL"
help="LunaSea Webhook URL"
placeholder="https://notify.lunasea.app/v1/custom/user/TOKEN"
/>
</div>
);
}
function FormFieldsTelegram() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-400">
{"Read how to "}
<ExternalLink
href="https://core.telegram.org/bots#3-how-do-i-create-a-bot"
className="font-medium text-blue-500 underline underline-offset-1 hover:text-blue-400"
>
create a bot
</ExternalLink>
{"."}
</p>
</div>
<PasswordFieldWide
name="token"
label="Bot token"
help="Bot token"
/>
<PasswordFieldWide
name="channel"
label="Chat ID"
help="Chat ID"
/>
<PasswordFieldWide
name="topic"
label="Message Thread ID"
help="Message Thread (topic) of a Supergroup"
/>
<TextFieldWide
name="host"
label="Telegram Api Proxy"
help="Reverse proxy domain for api.telegram.org, only needs to be specified if the network you are using has blocked the Telegram API."
placeholder="http(s)://ip:port"
/>
<TextFieldWide
name="username"
label="Sender"
help="Custom sender name to show at the top of a notification"
placeholder="autobrr"
/>
</div>
);
}
function FormFieldsPushover() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-400">
{"Register a new "}
<ExternalLink
href="https://support.pushover.net/i175-how-do-i-get-an-api-or-application-token"
className="font-medium text-blue-500 underline underline-offset-1 hover:text-blue-400"
>
application
</ExternalLink>
{" and add its API Token here."}
</p>
</div>
<PasswordFieldWide
name="api_key"
label="API Token"
help="API Token"
/>
<PasswordFieldWide
name="token"
label="User Key"
help="User Key"
/>
<NumberFieldWide
name="priority"
label="Priority"
help="-2, -1, 0 (default), 1, or 2"
required={true}
/>
</div>
);
}
function FormFieldsGotify() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
</div>
<TextFieldWide
name="host"
label="Gotify URL"
help="Gotify URL"
placeholder="https://some.gotify.server.com"
required={true}
/>
<PasswordFieldWide
name="token"
label="Application Token"
help="Application Token"
required={true}
/>
</div>
);
}
function FormFieldsNtfy() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
</div>
<TextFieldWide
name="host"
label="NTFY URL"
help="NTFY URL"
placeholder="https://ntfy.sh/mytopic"
required={true}
/>
<TextFieldWide
name="username"
label="Username"
help="Username"
/>
<PasswordFieldWide
name="password"
label="Password"
help="Password"
/>
<PasswordFieldWide
name="token"
label="Access token"
help="Access token. Use this or Usernmae+password"
/>
<NumberFieldWide
name="priority"
label="Priority"
help="Max 5, 4, 3 (default), 2, 1 Min"
/>
</div>
);
}
function FormFieldsShoutrrr() {
return (
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Settings
</DialogTitle>
</div>
<TextFieldWide
name="host"
label="URL"
help="URL"
tooltip={
<div><p>See full documentation </p>
<ExternalLink
href="https://containrrr.dev/shoutrrr/services/overview/"
className="font-medium text-blue-500 underline underline-offset-1 hover:text-blue-400"
>
Services
</ExternalLink>
</div>
}
placeholder="smtp://username:password@host:port/?from=fromAddress&to=recipient1"
required={true}
/>
</div>
);
}
const componentMap: componentMapType = {
DISCORD: <FormFieldsDiscord />,
NOTIFIARR: <FormFieldsNotifiarr />,
TELEGRAM: <FormFieldsTelegram />,
PUSHOVER: <FormFieldsPushover />,
GOTIFY: <FormFieldsGotify />,
NTFY: <FormFieldsNtfy />,
SHOUTRRR: <FormFieldsShoutrrr />,
LUNASEA: <FormFieldsLunaSea />
};
interface NotificationAddFormValues {
name: string;
enabled: boolean;
}
export function NotificationAddForm({ isOpen, toggle }: AddFormProps) {
const queryClient = useQueryClient();
const createMutation = useMutation({
mutationFn: (notification: ServiceNotification) => APIClient.notifications.create(notification),
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: NotificationKeys.lists() });
toast.custom((t) => <Toast type="success" body="Notification added!" t={t} />);
toggle();
},
onError: () => {
toast.custom((t) => <Toast type="error" body="Notification could not be added" t={t} />);
}
});
const onSubmit = (formData: unknown) => createMutation.mutate(formData as ServiceNotification);
const testMutation = useMutation({
mutationFn: (n: ServiceNotification) => APIClient.notifications.test(n),
onError: (err) => {
console.error(err);
}
});
const testNotification = (data: unknown) => testMutation.mutate(data as ServiceNotification);
const validate = (values: NotificationAddFormValues) => {
const errors = {} as FormikErrors<FormikValues>;
if (!values.name)
errors.name = "Required";
return errors;
};
return (
<Transition show={isOpen} as={Fragment}>
<Dialog
as="div"
static
className="fixed inset-0 overflow-hidden"
open={isOpen}
onClose={toggle}
>
<div className="absolute inset-0 overflow-hidden">
<DialogPanel className="absolute inset-y-0 right-0 max-w-full flex">
<TransitionChild
as={Fragment}
enter="transform transition ease-in-out duration-500 sm:duration-700"
enterFrom="translate-x-full"
enterTo="translate-x-0"
leave="transform transition ease-in-out duration-500 sm:duration-700"
leaveFrom="translate-x-0"
leaveTo="translate-x-full"
>
<div className="w-screen max-w-2xl dark:border-gray-700 border-l">
<Formik
enableReinitialize={true}
initialValues={{
enabled: true,
type: "",
name: "",
webhook: "",
events: [],
username: ""
}}
onSubmit={onSubmit}
validate={validate}
>
{({ values }) => (
<Form className="h-full flex flex-col bg-white dark:bg-gray-800 shadow-xl overflow-y-auto">
<div className="flex-1">
<div className="px-4 py-6 bg-gray-50 dark:bg-gray-900 sm:px-6">
<div className="flex items-start justify-between space-x-3">
<div className="space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Add Notifications
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-200">
Trigger notifications on different events.
</p>
</div>
<div className="h-7 flex items-center">
<button
type="button"
className="bg-white dark:bg-gray-700 rounded-md text-gray-400 hover:text-gray-500 focus:outline-none focus:ring-2 focus:ring-blue-500"
onClick={toggle}
>
<span className="sr-only">Close panel</span>
<XMarkIcon className="h-6 w-6" aria-hidden="true" />
</button>
</div>
</div>
</div>
<div className="flex flex-col space-y-4 px-1 py-6 sm:py-0 sm:space-y-0">
<TextFieldWide
name="name"
label="Name"
required={true}
/>
<div className="flex items-center justify-between space-y-1 px-4 sm:space-y-0 sm:grid sm:grid-cols-3 sm:gap-4">
<div>
<label
htmlFor="type"
className="block text-sm font-medium text-gray-900 dark:text-white"
>
Type
</label>
</div>
<div className="sm:col-span-2">
<Field name="type" type="select">
{({
field,
form: { setFieldValue, resetForm }
}: FieldProps) => (
<Select
{...field}
isClearable={true}
isSearchable={true}
components={{
Input: common.SelectInput,
Control: common.SelectControl,
Menu: common.SelectMenu,
Option: common.SelectOption,
IndicatorSeparator: common.IndicatorSeparator,
DropdownIndicator: common.DropdownIndicator
}}
placeholder="Choose a type"
styles={{
singleValue: (base) => ({
...base,
color: "unset"
})
}}
theme={(theme) => ({
...theme,
spacing: {
...theme.spacing,
controlHeight: 30,
baseUnit: 2
}
})}
value={field?.value && field.value.value}
onChange={(option: unknown) => {
resetForm();
const opt = option as SelectOption;
// setFieldValue("name", option?.label ?? "")
setFieldValue(
field.name,
opt.value ?? ""
);
}}
options={NotificationTypeOptions}
/>
)}
</Field>
</div>
</div>
<SwitchGroupWide name="enabled" label="Enabled" />
<div className="border-t mt-2 border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Events
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-400">
Select what events to trigger on
</p>
</div>
<div className="space-y-1 px-4 sm:space-y-0 sm:grid sm:gap-4 sm:py-4">
<EventCheckBoxes />
</div>
</div>
</div>
{componentMap[values.type]}
</div>
<div className="flex-shrink-0 px-4 border-t border-gray-200 dark:border-gray-700 py-4 sm:px-6">
<div className="space-x-3 flex justify-end">
<button
type="button"
className="bg-white dark:bg-gray-700 py-2 px-4 border border-gray-300 dark:border-gray-600 rounded-md shadow-sm text-sm font-medium text-gray-700 dark:text-gray-200 hover:bg-gray-50 dark:hover:bg-gray-600 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 dark:focus:ring-blue-500"
onClick={() => testNotification(values)}
>
Test
</button>
<button
type="button"
className="bg-white dark:bg-gray-700 py-2 px-4 border border-gray-300 dark:border-gray-600 rounded-md shadow-sm text-sm font-medium text-gray-700 dark:text-gray-200 hover:bg-gray-50 dark:hover:bg-gray-600 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 dark:focus:ring-blue-500"
onClick={toggle}
>
Cancel
</button>
<button
type="submit"
className="inline-flex justify-center py-2 px-4 border border-transparent shadow-sm text-sm font-medium rounded-md text-white bg-blue-600 dark:bg-blue-600 hover:bg-blue-700 dark:hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 dark:focus:ring-blue-500"
>
Save
</button>
</div>
</div>
<DEBUG values={values} />
</Form>
)}
</Formik>
</div>
</TransitionChild>
</DialogPanel>
</div>
</Dialog>
</Transition>
);
}
const EventCheckBoxes = () => (
<fieldset className="space-y-5">
<legend className="sr-only">Notifications</legend>
{EventOptions.map((e, idx) => (
<div key={idx} className="relative flex items-start">
<div className="flex items-center h-5">
<Field
id={`events-${e.value}`}
aria-describedby={`events-${e.value}-description`}
name="events"
type="checkbox"
value={e.value}
className="focus:ring-blue-500 h-4 w-4 text-blue-600 border-gray-300 rounded"
/>
</div>
<div className="ml-3 text-sm">
<label htmlFor={`events-${e.value}`}
className="font-medium text-gray-900 dark:text-gray-100">
{e.label}
</label>
{e.description && (
<p className="text-gray-500">{e.description}</p>
)}
</div>
</div>
))}
</fieldset>
);
interface InitialValues {
id: number;
enabled: boolean;
type: NotificationType;
name: string;
webhook?: string;
token?: string;
api_key?: string;
priority?: number;
channel?: string;
topic?: string;
host?: string;
events: NotificationEvent[];
username?: string
password?: string
}
export function NotificationUpdateForm({ isOpen, toggle, data: notification }: UpdateFormProps<ServiceNotification>) {
const queryClient = useQueryClient();
const mutation = useMutation({
mutationFn: (notification: ServiceNotification) => APIClient.notifications.update(notification),
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: NotificationKeys.lists() });
toast.custom((t) => <Toast type="success" body={`${notification.name} was updated successfully`} t={t}/>);
toggle();
}
});
const onSubmit = (formData: unknown) => mutation.mutate(formData as ServiceNotification);
const deleteMutation = useMutation({
mutationFn: (notificationID: number) => APIClient.notifications.delete(notificationID),
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: NotificationKeys.lists() });
toast.custom((t) => <Toast type="success" body={`${notification.name} was deleted.`} t={t}/>);
}
});
const deleteAction = () => deleteMutation.mutate(notification.id);
const testMutation = useMutation({
mutationFn: (n: ServiceNotification) => APIClient.notifications.test(n),
onError: (err) => {
console.error(err);
}
});
const testNotification = (data: unknown) => testMutation.mutate(data as ServiceNotification);
const initialValues: InitialValues = {
id: notification.id,
enabled: notification.enabled,
type: notification.type,
name: notification.name,
webhook: notification.webhook,
token: notification.token,
api_key: notification.api_key,
priority: notification.priority,
channel: notification.channel,
topic: notification.topic,
host: notification.host,
events: notification.events || [],
username: notification.username,
password: notification.password
};
return (
<SlideOver<InitialValues>
type="UPDATE"
title="Notification"
isOpen={isOpen}
toggle={toggle}
onSubmit={onSubmit}
deleteAction={deleteAction}
initialValues={initialValues}
testFn={testNotification}
>
{(values) => (
<div>
<TextFieldWide name="name" label="Name" required={true}/>
<div className="space-y-2 divide-y divide-gray-200 dark:divide-gray-700">
<div className="py-4 flex items-center justify-between space-y-1 px-4 sm:space-y-0 sm:grid sm:grid-cols-3 sm:gap-4 sm:py-4">
<div>
<label
htmlFor="type"
className="block text-sm font-medium text-gray-900 dark:text-white"
>
Type
</label>
</div>
<div className="sm:col-span-2">
<Field name="type" type="select">
{({ field, form: { setFieldValue, resetForm } }: FieldProps) => (
<Select {...field}
isClearable={true}
isSearchable={true}
components={{
Input: common.SelectInput,
Control: common.SelectControl,
Menu: common.SelectMenu,
Option: common.SelectOption,
IndicatorSeparator: common.IndicatorSeparator,
DropdownIndicator: common.DropdownIndicator
}}
placeholder="Choose a type"
styles={{
singleValue: (base) => ({
...base,
color: "unset"
})
}}
theme={(theme) => ({
...theme,
spacing: {
...theme.spacing,
controlHeight: 30,
baseUnit: 2
}
})}
value={field?.value && NotificationTypeOptions.find(o => o.value == field?.value)}
onChange={(option: unknown) => {
resetForm();
const opt = option as SelectOption;
setFieldValue(field.name, opt.value ?? "");
}}
options={NotificationTypeOptions}
/>
)}
</Field>
</div>
</div>
<SwitchGroupWide name="enabled" label="Enabled"/>
<div className="border-t border-gray-200 dark:border-gray-700 py-4">
<div className="px-4 space-y-1">
<DialogTitle className="text-lg font-medium text-gray-900 dark:text-white">
Events
</DialogTitle>
<p className="text-sm text-gray-500 dark:text-gray-400">
Select what events to trigger on
</p>
</div>
<div className="space-y-1 px-4 sm:space-y-0 sm:grid sm:gap-4 sm:py-2">
<EventCheckBoxes />
</div>
</div>
</div>
{componentMap[values.type]}
</div>
)}
</SlideOver>
);
}