feat: download clients integration and widget

.gitignore

@@ -54,4 +54,7 @@ db.sqlite
 *.log
 
 apps/tasks/tasks.cjs
-apps/websocket/wssServer.cjs
+apps/websocket/wssServer.cjs
+
+#personal backgrounds
+apps/nextjs/public/images/background.png

.vscode/settings.json

@@ -12,10 +12,17 @@
     "cqmin",
     "homarr",
     "jellyfin",
+    "mantine",
+    "ajnart",
+    "Meierschlumpf",
+    "manuel-rw",
+    "SeDemal",
+    "Sabnzbd",
+    "Sonarr",
     "superjson",
+    "tabler",
     "trpc",
-    "Umami",
-    "Sonarr"
+    "Umami"
   ],
   "i18n-ally.dirStructure": "auto",
   "i18n-ally.enabledFrameworks": ["next-international"],

apps/nextjs/src/app/[locale]/widgets/[kind]/_content.tsx

@@ -86,6 +86,9 @@ export const WidgetPreviewPageContent = ({ kind, integrationData }: WidgetPrevie
     });
   }, [dimensions, openPreviewDimensionsModal]);
 
+  const updateOptions = ({ newOptions }: { newOptions: Record<string, unknown> }) =>
+    setState({ ...state, options: { ...state.options, newOptions } });
+
   return (
     <>
       <Card withBorder w={dimensions.width} h={dimensions.height} p={dimensions.height >= 96 ? undefined : 4}>
@@ -105,6 +108,7 @@ export const WidgetPreviewPageContent = ({ kind, integrationData }: WidgetPrevie
                 isEditMode={editMode}
                 boardId={undefined}
                 itemId={undefined}
+                setOptions={updateOptions}
               />
             </ErrorBoundary>
           )}

apps/nextjs/src/components/board/sections/content.tsx

@@ -99,7 +99,10 @@ const BoardItemContent = ({ item, ...dimensions }: ItemContentProps) => {
   const serverData = useServerDataFor(item.id);
   const Comp = loadWidgetDynamic(item.kind);
   const options = reduceWidgetOptionsWithDefaultValues(item.kind, item.options);
+  const { updateItemOptions } = useItemActions();
   const newItem = { ...item, options };
+  const updateOptions = ({ newOptions }: { newOptions: Record<string, unknown> }) =>
+    updateItemOptions({ itemId: item.id, newOptions });
 
   if (!serverData?.isReady) return null;
 
@@ -124,6 +127,7 @@ const BoardItemContent = ({ item, ...dimensions }: ItemContentProps) => {
             isEditMode={isEditMode}
             boardId={board.id}
             itemId={item.id}
+            setOptions={updateOptions}
             {...dimensions}
           />
         </ErrorBoundary>

apps/nextjs/src/components/board/sections/item.module.css

@@ -1,10 +1,12 @@
 .itemCard {
   @mixin dark {
-    background-color: rgba(46, 46, 46, var(--opacity));
-    border-color: rgba(66, 66, 66, var(--opacity));
+    --background-color: rgb(from var(--mantine-color-dark-6) r g b / var(--opacity));
+    --border-color: rgb(from var(--mantine-color-dark-4) r g b / var(--opacity));
   }
   @mixin light {
-    background-color: rgba(255, 255, 255, var(--opacity));
-    border-color: rgba(222, 226, 230, var(--opacity));
+    --background-color: rgb(from var(--mantine-color-white) r g b / var(--opacity));
+    --border-color: rgb(from var(--mantine-color-gray-3) r g b / var(--opacity));
   }
+  background-color: var(--background-color);
+  border-color: var(--border-color);
 }

packages/api/src/middlewares/integration.ts

@@ -4,6 +4,7 @@ import type { Session } from "@homarr/auth";
 import { hasQueryAccessToIntegrationsAsync } from "@homarr/auth/server";
 import { constructIntegrationPermissions } from "@homarr/auth/shared";
 import { decryptSecret } from "@homarr/common";
+import type { AtLeastOneOf } from "@homarr/common/types";
 import type { Database } from "@homarr/db";
 import { and, eq, inArray } from "@homarr/db";
 import { integrations } from "@homarr/db/schema/sqlite";
@@ -12,7 +13,7 @@ import { z } from "@homarr/validation";
 
 import { publicProcedure } from "../trpc";
 
-type IntegrationAction = "query" | "interact";
+export type IntegrationAction = "query" | "interact";
 
 /**
  * Creates a middleware that provides the integration in the context that is of the specified kinds
@@ -25,7 +26,7 @@ type IntegrationAction = "query" | "interact";
  */
 export const createOneIntegrationMiddleware = <TKind extends IntegrationKind>(
   action: IntegrationAction,
-  ...kinds: [TKind, ...TKind[]] // Ensure at least one kind is provided
+  ...kinds: AtLeastOneOf<TKind> // Ensure at least one kind is provided
 ) => {
   return publicProcedure.input(z.object({ integrationId: z.string() })).use(async ({ input, ctx, next }) => {
     const integration = await ctx.db.query.integrations.findFirst({
@@ -95,7 +96,7 @@ export const createOneIntegrationMiddleware = <TKind extends IntegrationKind>(
  */
 export const createManyIntegrationMiddleware = <TKind extends IntegrationKind>(
   action: IntegrationAction,
-  ...kinds: [TKind, ...TKind[]] // Ensure at least one kind is provided
+  ...kinds: AtLeastOneOf<TKind> // Ensure at least one kind is provided
 ) => {
   return publicProcedure
     .input(z.object({ integrationIds: z.array(z.string()).min(1) }))
@@ -161,7 +162,7 @@ export const createManyIntegrationMiddleware = <TKind extends IntegrationKind>(
  */
 export const createManyIntegrationOfOneItemMiddleware = <TKind extends IntegrationKind>(
   action: IntegrationAction,
-  ...kinds: [TKind, ...TKind[]] // Ensure at least one kind is provided
+  ...kinds: AtLeastOneOf<TKind> // Ensure at least one kind is provided
 ) => {
   return publicProcedure
     .input(z.object({ integrationIds: z.array(z.string()).min(1), itemId: z.string() }))

packages/api/src/router/integration/integration-test-connection.ts

@@ -4,6 +4,8 @@ import type { IntegrationKind, IntegrationSecretKind } from "@homarr/definitions
 import { getAllSecretKindOptions } from "@homarr/definitions";
 import { integrationCreatorByKind, IntegrationTestConnectionError } from "@homarr/integrations";
 
+import { integrationCreators } from "../../../../integrations/src/base/creator";
+
 type FormIntegration = Integration & {
   secrets: {
     kind: IntegrationSecretKind;
@@ -48,7 +50,8 @@ export const testConnectionAsync = async (
     return secrets.find((secret) => secret.source === "form") ?? secrets[0]!;
   });
 
-  const integrationInstance = integrationCreatorByKind(integration.kind, {
+  //Remove "as" conversion as soon as all integrations kinds have been made.
+  const integrationInstance = integrationCreatorByKind(integration.kind as keyof typeof integrationCreators, {
     id: integration.id,
     name: integration.name,
     url: integration.url,

packages/api/src/router/widgets/downloads.ts

@@ -0,0 +1,111 @@
+import { observable } from "@trpc/server/observable";
+
+import { getIntegrationKindsByCategory } from "@homarr/definitions";
+import type { DownloadClientJobsAndStatus, SanitizedIntegration } from "@homarr/integrations";
+import { downloadClientItemSchema, integrationCreatorByKind } from "@homarr/integrations";
+import { createItemAndIntegrationChannel } from "@homarr/redis";
+import { z } from "@homarr/validation";
+
+import type { IntegrationAction } from "../../middlewares/integration";
+import { createManyIntegrationMiddleware } from "../../middlewares/integration";
+import { createTRPCRouter, protectedProcedure, publicProcedure } from "../../trpc";
+
+const createDownloadClientIntegrationMiddleware = (action: IntegrationAction) =>
+  createManyIntegrationMiddleware(action, ...getIntegrationKindsByCategory("downloadClient"));
+
+export const downloadsRouter = createTRPCRouter({
+  getJobsAndStatuses: publicProcedure
+    .unstable_concat(createDownloadClientIntegrationMiddleware("query"))
+    .query(async ({ ctx }) => {
+      return await Promise.all(
+        ctx.integrations.map(async ({ decryptedSecrets: _, ...integration }) => {
+          const channel = createItemAndIntegrationChannel<DownloadClientJobsAndStatus>("downloads", integration.id);
+          const { data, timestamp } = (await channel.getAsync()) ?? { data: null, timestamp: new Date(0) };
+          return {
+            integration,
+            timestamp,
+            data,
+          };
+        }),
+      );
+    }),
+  subscribeToJobsAndStatuses: publicProcedure
+    .unstable_concat(createDownloadClientIntegrationMiddleware("query"))
+    .subscription(({ ctx }) => {
+      return observable<{ integration: SanitizedIntegration; timestamp: Date; data: DownloadClientJobsAndStatus }>(
+        (emit) => {
+          const unsubscribes: (() => void)[] = [];
+          for (const integrationWithSecrets of ctx.integrations) {
+            const { decryptedSecrets: _, ...integration } = integrationWithSecrets;
+            const channel = createItemAndIntegrationChannel<DownloadClientJobsAndStatus>("downloads", integration.id);
+            const unsubscribe = channel.subscribe((data) => {
+              emit.next({
+                integration,
+                timestamp: new Date(),
+                data,
+              });
+            });
+            unsubscribes.push(unsubscribe);
+          }
+          return () => {
+            unsubscribes.forEach((unsubscribe) => {
+              unsubscribe();
+            });
+          };
+        },
+      );
+    }),
+  pause: protectedProcedure
+    .unstable_concat(createDownloadClientIntegrationMiddleware("interact"))
+    .mutation(async ({ ctx }) => {
+      await Promise.all(
+        ctx.integrations.map(async (integration) => {
+          const integrationInstance = integrationCreatorByKind(integration.kind, integration);
+          await integrationInstance.pauseQueueAsync();
+        }),
+      );
+    }),
+  pauseItem: protectedProcedure
+    .unstable_concat(createDownloadClientIntegrationMiddleware("interact"))
+    .input(z.object({ item: downloadClientItemSchema }))
+    .mutation(async ({ ctx, input }) => {
+      await Promise.all(
+        ctx.integrations.map(async (integration) => {
+          const integrationInstance = integrationCreatorByKind(integration.kind, integration);
+          await integrationInstance.pauseItemAsync(input.item);
+        }),
+      );
+    }),
+  resume: protectedProcedure
+    .unstable_concat(createDownloadClientIntegrationMiddleware("interact"))
+    .mutation(async ({ ctx }) => {
+      await Promise.all(
+        ctx.integrations.map(async (integration) => {
+          const integrationInstance = integrationCreatorByKind(integration.kind, integration);
+          await integrationInstance.resumeQueueAsync();
+        }),
+      );
+    }),
+  resumeItem: protectedProcedure
+    .unstable_concat(createDownloadClientIntegrationMiddleware("interact"))
+    .input(z.object({ item: downloadClientItemSchema }))
+    .mutation(async ({ ctx, input }) => {
+      await Promise.all(
+        ctx.integrations.map(async (integration) => {
+          const integrationInstance = integrationCreatorByKind(integration.kind, integration);
+          await integrationInstance.resumeItemAsync(input.item);
+        }),
+      );
+    }),
+  deleteItem: protectedProcedure
+    .unstable_concat(createDownloadClientIntegrationMiddleware("interact"))
+    .input(z.object({ item: downloadClientItemSchema, fromDisk: z.boolean() }))
+    .mutation(async ({ ctx, input }) => {
+      await Promise.all(
+        ctx.integrations.map(async (integration) => {
+          const integrationInstance = integrationCreatorByKind(integration.kind, integration);
+          await integrationInstance.deleteItemAsync(input.item, input.fromDisk);
+        }),
+      );
+    }),
+});

packages/api/src/router/widgets/index.ts

@@ -2,12 +2,12 @@ import { createTRPCRouter } from "../../trpc";
 import { appRouter } from "./app";
 import { calendarRouter } from "./calendar";
 import { dnsHoleRouter } from "./dns-hole";
+import { downloadsRouter } from "./downloads";
 import { mediaServerRouter } from "./media-server";
 import { notebookRouter } from "./notebook";
 import { rssFeedRouter } from "./rssFeed";
 import { smartHomeRouter } from "./smart-home";
 import { weatherRouter } from "./weather";
-import {usenetDownloadsRouter} from "./usenet-downloads";
 
 export const widgetRouter = createTRPCRouter({
   notebook: notebookRouter,
@@ -17,6 +17,6 @@ export const widgetRouter = createTRPCRouter({
   smartHome: smartHomeRouter,
   mediaServer: mediaServerRouter,
   calendar: calendarRouter,
-  usenetDownloads: usenetDownloadsRouter,
+  downloads: downloadsRouter,
   rssFeed: rssFeedRouter,
 });

packages/common/src/number.ts

@@ -19,3 +19,31 @@ export const formatNumber = (value: number, decimalPlaces: number) => {
 export const randomInt = (min: number, max: number) => {
   return Math.floor(Math.random() * (max - min + 1) + min);
 };
+
+/**
+ *  Number of bytes to si format. (Division by 1024)
+ *  Does not accept floats, size in bytes should be an integer.
+ *  Will return "NaI" and logs a warning if a float is passed.
+ *  Concat as parameters so it is not added if the returned value is "NaI" or "∞".
+ *  Returns "∞" if the size is too large to be represented in the current format.
+ */
+export const humanFileSize = (size: number, concat = ""): string => {
+  //64bit limit for Number stops at EiB
+  const siRanges = ["B", "kiB", "MiB", "GiB", "TiB", "PiB", "EiB"];
+  if (!Number.isInteger(size)) {
+    console.warn(
+      "Invalid use of the humanFileSize function with a float, please report this and what integration this is impacting.",
+    );
+    //Not an Integer
+    return "NaI";
+  }
+  let count = 0;
+  while (count < siRanges.length) {
+    const tempSize = size / Math.pow(1024, count);
+    if (tempSize < 1024) {
+      return tempSize.toFixed(Math.min(count, 1)) + siRanges[count] + concat;
+    }
+    count++;
+  }
+  return "∞";
+};

packages/common/src/types.ts

@@ -1 +1,3 @@
 export type MaybePromise<T> = T | Promise<T>;
+
+export type AtLeastOneOf<T> = [T, ...T[]];