From e65047049178f26ef10ddda6a1516a7ac6881fb4 Mon Sep 17 00:00:00 2001 From: Marco Hofmann Date: Wed, 23 Oct 2024 15:58:35 +0200 Subject: [PATCH] Add Spoolman Widget --- docs/widgets/services/spoolman.md | 17 +++++++ mkdocs.yml | 1 + src/utils/config/service-helpers.js | 6 +++ src/widgets/components.js | 1 + src/widgets/spoolman/component.jsx | 70 +++++++++++++++++++++++++++++ src/widgets/spoolman/widget.js | 14 ++++++ src/widgets/widgets.js | 2 + 7 files changed, 111 insertions(+) create mode 100644 docs/widgets/services/spoolman.md create mode 100644 src/widgets/spoolman/component.jsx create mode 100644 src/widgets/spoolman/widget.js diff --git a/docs/widgets/services/spoolman.md b/docs/widgets/services/spoolman.md new file mode 100644 index 000000000..9dea81001 --- /dev/null +++ b/docs/widgets/services/spoolman.md @@ -0,0 +1,17 @@ +--- +title: Spoolman +description: Spoolman Widget Configuration +--- + +Learn more about [Spoolman](https://github.com/Donkie/Spoolman). + +4 spools are displayed by default. If more than 4 spools are configured in spoolman you can use the spoolIds configuration option to filter for spools by their id. + +```yaml +widget: + type: spoolman + url: http://spoolman.host.or.ip + spoolIds: + - 1 + - 4 +``` diff --git a/mkdocs.yml b/mkdocs.yml index 1e9d59cc8..5b350d717 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -138,6 +138,7 @@ nav: - widgets/services/scrutiny.md - widgets/services/sonarr.md - widgets/services/speedtest-tracker.md + - widgets/services/spoolman.md - widgets/services/stash.md - widgets/services/stocks.md - widgets/services/swagdashboard.md diff --git a/src/utils/config/service-helpers.js b/src/utils/config/service-helpers.js index 1566a135b..a09e8070b 100644 --- a/src/utils/config/service-helpers.js +++ b/src/utils/config/service-helpers.js @@ -492,6 +492,9 @@ export function cleanServiceGroups(groups) { // technitium range, + + // spoolman + spoolIds } = cleanedService.widget; let fieldsList = fields; @@ -653,6 +656,9 @@ export function cleanServiceGroups(groups) { if (metrics) cleanedService.widget.metrics = metrics; if (refreshInterval) cleanedService.widget.refreshInterval = refreshInterval; } + if (type === "spoolman") { + if (spoolIds !== undefined) cleanedService.widget.spoolIds = spoolIds; + } } return cleanedService; diff --git a/src/widgets/components.js b/src/widgets/components.js index aa476c464..bea37cf2e 100644 --- a/src/widgets/components.js +++ b/src/widgets/components.js @@ -111,6 +111,7 @@ const components = { scrutiny: dynamic(() => import("./scrutiny/component")), sonarr: dynamic(() => import("./sonarr/component")), speedtest: dynamic(() => import("./speedtest/component")), + spoolman: dynamic(() => import("./spoolman/component")), stash: dynamic(() => import("./stash/component")), stocks: dynamic(() => import("./stocks/component")), strelaysrv: dynamic(() => import("./strelaysrv/component")), diff --git a/src/widgets/spoolman/component.jsx b/src/widgets/spoolman/component.jsx new file mode 100644 index 000000000..df87db225 --- /dev/null +++ b/src/widgets/spoolman/component.jsx @@ -0,0 +1,70 @@ +import { useTranslation } from "next-i18next"; + +import Container from "components/services/widget/container"; +import Block from "components/services/widget/block"; +import useWidgetAPI from "utils/proxy/use-widget-api"; + +export default function Component({ service }) { + const { t } = useTranslation(); + const { widget } = service; + + const { data: spoolData, error: spoolError } = useWidgetAPI(widget, "spools"); + + // Helper to handle filtering based on spoolIds + const filterSpools = (data, spoolIds) => { + if (!spoolIds || spoolIds.length === 0) return data; // No filtering if no spoolIds + const limitedspoolIds = spoolIds.slice(0, 4); // Limit to 4 names + return data.filter(spool => spoolIds.includes(spool.id)); + }; + + // Helper to limit spoolData length + const limitSpoolData = (data, limit = 4) => (data.length > limit ? data.slice(0, limit) : data); + + // Error handling + if (spoolError) { + return ; + } + + // Loading state + if (!spoolData) { + return ( + + + + + ); + } + + // API error or unexpected response + if (spoolData.error || spoolData.message) { + return ; + } + + // No spools available + if (spoolData.length === 0) { + return ( + + + + ); + } + + // Filter and limit spools + let filteredSpoolData = filterSpools(spoolData, widget.spoolIds); + filteredSpoolData = limitSpoolData(filteredSpoolData); + + // Render filtered and limited spools + return ( + + {filteredSpoolData.map((spool) => ( + + ))} + + ); +} diff --git a/src/widgets/spoolman/widget.js b/src/widgets/spoolman/widget.js new file mode 100644 index 000000000..4cc2e5c15 --- /dev/null +++ b/src/widgets/spoolman/widget.js @@ -0,0 +1,14 @@ +import credentialedProxyHandler from "utils/proxy/handlers/credentialed"; + +const widget = { + api: "{url}/api/v1/{endpoint}", + proxyHandler: credentialedProxyHandler, + + mappings: { + spools : { + endpoint: "spool", + } + }, +}; + +export default widget; diff --git a/src/widgets/widgets.js b/src/widgets/widgets.js index 0cad5346d..8eb3f51fc 100644 --- a/src/widgets/widgets.js +++ b/src/widgets/widgets.js @@ -102,6 +102,7 @@ import sabnzbd from "./sabnzbd/widget"; import scrutiny from "./scrutiny/widget"; import sonarr from "./sonarr/widget"; import speedtest from "./speedtest/widget"; +import spoolman from "./spoolman/widget"; import stash from "./stash/widget"; import stocks from "./stocks/widget"; import strelaysrv from "./strelaysrv/widget"; @@ -237,6 +238,7 @@ const widgets = { scrutiny, sonarr, speedtest, + spoolman, stash, stocks, strelaysrv,