🔀 Merge pull request #229 from LarveyOfficial/rework-AddAppShelfItem

✨Service Addition Overhaul

src/components/AppShelf/AddAppShelfItem.tsx

@@ -12,6 +12,10 @@ import {
   Title,
   Anchor,
   Text,
+  Tabs,
+  MultiSelect,
+  ScrollArea,
+  Switch,
 } from '@mantine/core';
 import { useForm } from '@mantine/form';
 import { useEffect, useState } from 'react';
@@ -19,7 +23,7 @@ import { IconApps as Apps } from '@tabler/icons';
 import { v4 as uuidv4 } from 'uuid';
 import { useDebouncedValue } from '@mantine/hooks';
 import { useConfig } from '../../tools/state';
-import { ServiceTypeList } from '../../tools/types';
+import { ServiceTypeList, StatusCodes } from '../../tools/types';
 
 export function AddItemShelfButton(props: any) {
   const [opened, setOpened] = useState(false);
@@ -113,6 +117,8 @@ export function AddAppShelfItemForm(props: { setOpened: (b: boolean) => void } &
       username: props.username ?? (undefined as unknown as string),
       password: props.password ?? (undefined as unknown as string),
       openedUrl: props.openedUrl ?? (undefined as unknown as string),
+      status: props.status ?? ['200'],
+      newTab: props.newTab ?? true,
     },
     validate: {
       apiKey: () => null,
@@ -133,6 +139,12 @@ export function AddAppShelfItemForm(props: { setOpened: (b: boolean) => void } &
         }
         return null;
       },
+      status: (value: string[]) => {
+        if (!value.length) {
+          return 'Please select a status code';
+        }
+        return null;
+      },
     },
   });
 
@@ -167,6 +179,12 @@ export function AddAppShelfItemForm(props: { setOpened: (b: boolean) => void } &
       </Center>
       <form
         onSubmit={form.onSubmit(() => {
+          if (JSON.stringify(form.values.status) === JSON.stringify(['200'])) {
+            form.values.status = undefined;
+          }
+          if (form.values.newTab === true) {
+            form.values.newTab = undefined;
+          }
           // If service already exists, update it.
           if (config.services && config.services.find((s) => s.id === form.values.id)) {
             setConfig({
@@ -191,117 +209,167 @@ export function AddAppShelfItemForm(props: { setOpened: (b: boolean) => void } &
           form.reset();
         })}
       >
-        <Group direction="column" grow>
+        <Tabs grow>
-          <TextInput
+          <Tabs.Tab label="Options">
-            required
+            <ScrollArea style={{ height: 500 }} scrollbarSize={4}>
-            label="Service name"
+              <Group direction="column" grow>
-            placeholder="Plex"
+                <TextInput
-            {...form.getInputProps('name')}
+                  required
-          />
+                  label="Service name"
+                  placeholder="Plex"
+                  {...form.getInputProps('name')}
+                />
 
-          <TextInput
+                <TextInput
-            required
+                  required
-            label="Icon URL"
+                  label="Icon URL"
-            placeholder="/favicon.svg"
+                  placeholder="/favicon.svg"
-            {...form.getInputProps('icon')}
+                  {...form.getInputProps('icon')}
-          />
+                />
-          <TextInput
+                <TextInput
-            required
+                  required
-            label="Service URL"
+                  label="Service URL"
-            placeholder="http://localhost:7575"
+                  placeholder="http://localhost:7575"
-            {...form.getInputProps('url')}
+                  {...form.getInputProps('url')}
-          />
+                />
-          <TextInput
+                <TextInput
-            label="New tab URL"
+                  label="On Click URL"
-            placeholder="http://sonarr.example.com"
+                  placeholder="http://sonarr.example.com"
-            {...form.getInputProps('openedUrl')}
+                  {...form.getInputProps('openedUrl')}
-          />
+                />
-          <Select
+                <Select
-            label="Service type"
+                  label="Service type"
-            defaultValue="Other"
+                  defaultValue="Other"
-            placeholder="Pick one"
+                  placeholder="Pick one"
-            required
+                  required
-            searchable
+                  searchable
-            data={ServiceTypeList}
+                  data={ServiceTypeList}
-            {...form.getInputProps('type')}
+                  {...form.getInputProps('type')}
-          />
+                />
-          <Select
+                <Select
-            label="Category"
+                  label="Category"
-            data={categoryList}
+                  data={categoryList}
-            placeholder="Select a category or create a new one"
+                  placeholder="Select a category or create a new one"
-            nothingFound="Nothing found"
+                  nothingFound="Nothing found"
-            searchable
+                  searchable
-            clearable
+                  clearable
-            creatable
+                  creatable
-            onClick={(e) => {
+                  onClick={(e) => {
-              e.preventDefault();
+                    e.preventDefault();
-            }}
+                  }}
-            getCreateLabel={(query) => `+ Create "${query}"`}
+                  getCreateLabel={(query) => `+ Create "${query}"`}
-            onCreate={(query) => {}}
+                  onCreate={(query) => {}}
-            {...form.getInputProps('category')}
+                  {...form.getInputProps('category')}
-          />
+                />
-          <LoadingOverlay visible={isLoading} />
+                <LoadingOverlay visible={isLoading} />
-          {(form.values.type === 'Sonarr' ||
+                {(form.values.type === 'Sonarr' ||
-            form.values.type === 'Radarr' ||
+                  form.values.type === 'Radarr' ||
-            form.values.type === 'Lidarr' ||
+                  form.values.type === 'Lidarr' ||
-            form.values.type === 'Readarr') && (
+                  form.values.type === 'Readarr') && (
-            <>
+                  <>
-              <TextInput
+                    <TextInput
+                      required
+                      label="API key"
+                      placeholder="Your API key"
+                      value={form.values.apiKey}
+                      onChange={(event) => {
+                        form.setFieldValue('apiKey', event.currentTarget.value);
+                      }}
+                      error={form.errors.apiKey && 'Invalid API key'}
+                    />
+                    <Text
+                      style={{
+                        alignSelf: 'center',
+                        fontSize: '0.75rem',
+                        textAlign: 'center',
+                        color: 'gray',
+                      }}
+                    >
+                      Tip: Get your API key{' '}
+                      <Anchor
+                        target="_blank"
+                        weight="bold"
+                        style={{ fontStyle: 'inherit', fontSize: 'inherit' }}
+                        href={`${hostname}/settings/general`}
+                      >
+                        here.
+                      </Anchor>
+                    </Text>
+                  </>
+                )}
+                {form.values.type === 'qBittorrent' && (
+                  <>
+                    <TextInput
+                      required
+                      label="Username"
+                      placeholder="admin"
+                      value={form.values.username}
+                      onChange={(event) => {
+                        form.setFieldValue('username', event.currentTarget.value);
+                      }}
+                      error={form.errors.username && 'Invalid username'}
+                    />
+                    <TextInput
+                      required
+                      label="Password"
+                      placeholder="adminadmin"
+                      value={form.values.password}
+                      onChange={(event) => {
+                        form.setFieldValue('password', event.currentTarget.value);
+                      }}
+                      error={form.errors.password && 'Invalid password'}
+                    />
+                  </>
+                )}
+                {(form.values.type === 'Deluge' ||
+                  form.values.type === 'Transmission' ||
+                  form.values.type === 'qBittorrent') && (
+                  <>
+                    <TextInput
+                      label="Username"
+                      placeholder="admin"
+                      value={form.values.username}
+                      onChange={(event) => {
+                        form.setFieldValue('username', event.currentTarget.value);
+                      }}
+                      error={form.errors.username && 'Invalid username'}
+                    />
+                    <TextInput
+                      label="Password"
+                      placeholder="password"
+                      value={form.values.password}
+                      onChange={(event) => {
+                        form.setFieldValue('password', event.currentTarget.value);
+                      }}
+                      error={form.errors.password && 'Invalid password'}
+                    />
+                  </>
+                )}
+              </Group>
+            </ScrollArea>
+          </Tabs.Tab>
+          <Tabs.Tab label="Advanced Options">
+            <Group direction="column" grow>
+              <MultiSelect
                 required
-                label="API key"
+                label="HTTP Status Codes"
-                placeholder="Your API key"
+                data={StatusCodes}
-                value={form.values.apiKey}
+                placeholder="Select valid status codes"
-                onChange={(event) => {
+                clearButtonLabel="Clear selection"
-                  form.setFieldValue('apiKey', event.currentTarget.value);
+                nothingFound="Nothing found"
-                }}
+                defaultValue={['200']}
-                error={form.errors.apiKey && 'Invalid API key'}
+                clearable
+                searchable
+                {...form.getInputProps('status')}
               />
-              <Text
+              <Switch
-                style={{
+                label="Open service in new tab"
-                  alignSelf: 'center',
+                defaultChecked={form.values.newTab}
-                  fontSize: '0.75rem',
+                {...form.getInputProps('newTab')}
-                  textAlign: 'center',
-                  color: 'gray',
-                }}
-              >
-                Tip: Get your API key{' '}
-                <Anchor
-                  target="_blank"
-                  weight="bold"
-                  style={{ fontStyle: 'inherit', fontSize: 'inherit' }}
-                  href={`${hostname}/settings/general`}
-                >
-                  here.
-                </Anchor>
-              </Text>
-            </>
-          )}
-          {(form.values.type === 'Deluge' ||
-            form.values.type === 'Transmission' ||
-            form.values.type === 'qBittorrent') && (
-            <>
-              <TextInput
-                label="Username"
-                placeholder="admin"
-                value={form.values.username}
-                onChange={(event) => {
-                  form.setFieldValue('username', event.currentTarget.value);
-                }}
-                error={form.errors.username && 'Invalid username'}
               />
-              <TextInput
+            </Group>
-                label="Password"
+          </Tabs.Tab>
-                placeholder="password"
+        </Tabs>
-                value={form.values.password}
-                onChange={(event) => {
-                  form.setFieldValue('password', event.currentTarget.value);
-                }}
-                error={form.errors.password && 'Invalid password'}
-              />
-            </>
-          )}
-        </Group>
-
         <Group grow position="center" mt="xl">
           <Button type="submit">{props.message ?? 'Add service'}</Button>
         </Group>

src/components/AppShelf/AppShelfItem.tsx

@@ -83,7 +83,7 @@ export function AppShelfItem(props: any) {
       >
         <Card.Section>
           <Anchor
-            target="_blank"
+            target={service.newTab === false ? '_top' : '_blank'}
             href={service.openedUrl ? service.openedUrl : service.url}
             style={{ color: 'inherit', fontStyle: 'inherit', fontSize: 'inherit' }}
           >
@@ -127,13 +127,14 @@ export function AppShelfItem(props: any) {
                   src={service.icon}
                   fit="contain"
                   onClick={() => {
-                    if (service.openedUrl) window.open(service.openedUrl, '_blank');
+                    if (service.openedUrl) {
-                    else window.open(service.url);
+                      window.open(service.openedUrl, service.newTab === false ? '_top' : '_blank');
+                    } else window.open(service.url, service.newTab === false ? '_top' : '_blank');
                   }}
                 />
               </motion.i>
             </AspectRatio>
-            <PingComponent url={service.url} />
+            <PingComponent url={service.url} status={service.status} />
           </Card.Section>
         </Center>
       </Card>

src/components/AppShelf/AppShelfMenu.tsx

@@ -22,16 +22,7 @@ export default function AppShelfMenu(props: any) {
       >
         <AddAppShelfItemForm
           setOpened={setOpened}
-          name={service.name}
+          {...service}
-          id={service.id}
-          category={service.category}
-          type={service.type}
-          url={service.url}
-          icon={service.icon}
-          apiKey={service.apiKey}
-          username={service.username}
-          password={service.password}
-          openedUrl={service.openedUrl}
           message="Save service"
         />
       </Modal>

src/components/modules/ping/PingModule.story.tsx

@@ -11,6 +11,8 @@ const service: serviceItem = {
   name: 'YouTube',
   icon: 'https://cdn.jsdelivr.net/gh/walkxhub/dashboard-icons/png/youtube.png',
   url: 'https://youtube.com/',
+  status: ['200'],
+  target: "_blank",
 };
 
 export const Default = (args: any) => <PingComponent service={service} />;

src/components/modules/ping/PingModule.tsx

@@ -1,5 +1,5 @@
 import { Indicator, Tooltip } from '@mantine/core';
-import axios from 'axios';
+import axios, { AxiosResponse } from 'axios';
 import { motion } from 'framer-motion';
 import { useEffect, useState } from 'react';
 import { IconPlug as Plug } from '@tabler/icons';
@@ -19,18 +19,37 @@ export default function PingComponent(props: any) {
 
   const { url }: { url: string } = props;
   const [isOnline, setOnline] = useState<State>('loading');
+  const [response, setResponse] = useState(500);
   const exists = config.modules?.[PingModule.title]?.enabled ?? false;
+
+  function statusCheck(response: AxiosResponse) {
+    const { status }: {status: string[]} = props;
+    //Default Status
+    let acceptableStatus = ['200'];
+    if (status !== undefined && status.length) {
+      acceptableStatus = status;
+    }
+    // Checks if reported status is in acceptable status array
+    if (acceptableStatus.indexOf((response.status).toString()) >= 0) {
+      setOnline('online');
+      setResponse(response.status);
+    } else {
+      setOnline('down');
+      setResponse(response.status)
+    }
+  }
+
   useEffect(() => {
     if (!exists) {
       return;
     }
     axios
       .get('/api/modules/ping', { params: { url } })
-      .then(() => {
+      .then((response) => {
-        setOnline('online');
+        statusCheck(response);
       })
-      .catch(() => {
+      .catch((error) => {
-        setOnline('down');
+        statusCheck(error.response);
       });
   }, [config.modules?.[PingModule.title]?.enabled]);
   if (!exists) {
@@ -40,7 +59,7 @@ export default function PingComponent(props: any) {
     <Tooltip
       radius="lg"
       style={{ position: 'absolute', bottom: 20, right: 20 }}
-      label={isOnline === 'loading' ? 'Loading...' : isOnline === 'online' ? 'Online' : 'Offline'}
+      label={isOnline === 'loading' ? 'Loading...' : isOnline === 'online' ? `Online - ${response}` : `Offline - ${response}`}
     >
       <motion.div
         animate={{

src/pages/api/modules/downloads.ts

@@ -38,7 +38,7 @@ async function Post(req: NextApiRequest, res: NextApiResponse) {
       ...(
         await new Deluge({
           baseUrl: delugeService.url,
-          password: delugeService.password,
+          password: 'password' in delugeService ? delugeService.password : '',
         }).getAllData()
       ).torrents
     );
@@ -49,7 +49,7 @@ async function Post(req: NextApiRequest, res: NextApiResponse) {
         await new Transmission({
           baseUrl: transmissionService.url,
           username: transmissionService.username,
-          password: transmissionService.password,
+          password: 'password' in transmissionService ? transmissionService.password : '',
         }).getAllData()
       ).torrents
     );

src/pages/api/modules/ping.ts

@@ -7,10 +7,14 @@ async function Get(req: NextApiRequest, res: NextApiResponse) {
   await axios
     .get(url as string)
     .then((response) => {
-      res.status(200).json(response.data);
+      res.status(response.status).json(response.statusText);
     })
     .catch((error) => {
-      res.status(500).json(error);
+      if (error.response) {
+        res.status(error.response.status).json(error.response.statusText);
+      } else {
+        res.status(500).json('Server Error');
+      }
     });
   // // Make a request to the URL
   // const response = await axios.get(url);

src/tools/types.ts

@@ -31,6 +31,32 @@ interface ConfigModule {
   };
 }
 
+export const StatusCodes = [
+  {value: '200', label: '200 - OK', group:'Sucessful responses'}, 
+  {value: '204', label: '204 - No Content', group:'Sucessful responses'},
+  {value: '301', label: '301 - Moved Permanently', group:'Redirection responses'},
+  {value: '302', label: '302 - Found / Moved Temporarily', group:'Redirection responses'},
+  {value: '304', label: '304 - Not Modified', group:'Redirection responses'},
+  {value: '307', label: '307 - Temporary Redirect', group:'Redirection responses'},
+  {value: '308', label: '308 - Permanent Redirect', group:'Redirection responses'},
+  {value: '400', label: '400 - Bad Request', group:'Client error responses'},
+  {value: '401', label: '401 - Unauthorized', group:'Client error responses'},
+  {value: '403', label: '403 - Forbidden', group:'Client error responses'},
+  {value: '404', label: '404 - Not Found', group:'Client error responses'},
+  {value: '408', label: '408 - Request Timeout', group:'Client error responses'},
+  {value: '410', label: '410 - Gone', group:'Client error responses'},
+  {value: '429', label: '429 - Too Many Requests', group:'Client error responses'},
+  {value: '500', label: '500 - Internal Server Error', group:'Server error responses'},
+  {value: '502', label: '502 - Bad Gateway', group:'Server error responses'},
+  {value: '503', label: '503 - Service Unavailable', group:'Server error responses'},
+  {value: '054', label: '504 - Gateway Timeout Error', group:'Server error responses'},
+  ];
+
+export const Targets = [
+  {value: '_blank', label: 'New Tab'},
+  {value: '_top', label: 'Same Window'}
+]
+
 export const ServiceTypeList = [
   'Other',
   'Emby',
@@ -66,4 +92,6 @@ export interface serviceItem {
   password?: string;
   username?: string;
   openedUrl?: string;
+  newTab?: boolean;
+  status?: string[];
 }