@muhammedaksam/easiarr 0.4.2 → 0.5.0

package/src/config/schema.ts

@@ -16,6 +16,7 @@ export interface EasiarrConfig {
   network?: NetworkConfig
   traefik?: TraefikConfig
   vpn?: VpnConfig
+  monitor?: MonitorConfig
   createdAt: string
   updatedAt: string
 }
@@ -27,6 +28,38 @@ export interface VpnConfig {
   provider?: string // For future use (e.g. custom, airvpn, protonvpn)
 }
 
+// ==========================================
+// Monitoring Configuration
+// ==========================================
+
+export type MonitorCheckType = "health" | "diskspace" | "status" | "queue"
+
+export interface MonitorOptions {
+  health: boolean
+  diskspace: boolean
+  status: boolean
+  queue: boolean
+}
+
+export interface CategoryMonitorConfig {
+  category: AppCategory
+  enabled: boolean
+  checks: MonitorOptions
+}
+
+export interface AppMonitorConfig {
+  appId: AppId
+  override: boolean // If true, uses app-specific settings instead of category defaults
+  enabled: boolean
+  checks: MonitorOptions
+}
+
+export interface MonitorConfig {
+  categories: CategoryMonitorConfig[]
+  apps: AppMonitorConfig[] // App-specific overrides
+  pollIntervalSeconds: number
+}
+
 export interface TraefikConfig {
   enabled: boolean
   domain: string
@@ -152,6 +185,7 @@ export interface AppDefinition {
   cap_add?: string[]
   apiKeyMeta?: ApiKeyMeta
   rootFolder?: RootFolderMeta
+  prowlarrCategoryIds?: number[]
   /** Architecture compatibility info - omit if supports all */
   arch?: ArchCompatibility
 }

package/src/index.ts

@@ -21,6 +21,10 @@ async function main() {
     consoleOptions: {
       startInDebugMode: false,
     },
+    exitOnCtrlC: true,
+    onDestroy: () => {
+      process.exit(0)
+    },
   })
 
   const app = new App(renderer)

package/src/ui/components/FooterHint.ts

@@ -0,0 +1,119 @@
+/**
+ * Footer Hint Types and Utilities
+ * Provides a flexible array-based structure for footer hints
+ */
+
+/** Base interface for all footer hint types with common styling */
+export interface FooterHintBase {
+  /** Foreground color */
+  fg?: string
+  /** Background color */
+  bg?: string
+}
+
+/** A simple text message hint (e.g., "Press ? for help.") */
+export interface FooterHintText extends FooterHintBase {
+  type: "text"
+  value: string
+}
+
+/** A keyboard shortcut hint (e.g., key: "↓", value: "Down") */
+export interface FooterHintKey extends FooterHintBase {
+  type: "key"
+  key: string
+  value: string
+  /** Color for the key part (default: bright/highlighted) */
+  keyColor?: string
+  /** Color for the value part (default: dimmer) */
+  valueColor?: string
+  /** Background color for the key badge */
+  keyBgColor?: string
+  /** Whether to show brackets around the key */
+  withBrackets?: boolean
+}
+
+/** Separator between hint groups */
+export interface FooterHintSeparator extends FooterHintBase {
+  type: "separator"
+  char?: string
+}
+
+/** Union type for all hint item types */
+export type FooterHintItem = FooterHintText | FooterHintKey | FooterHintSeparator
+
+/** Array of hint items */
+export type FooterHint = FooterHintItem[]
+
+/** Default separator character */
+const DEFAULT_SEPARATOR = "  "
+
+/**
+ * Render footer hints to a plain string
+ * Used by PageLayout for backward-compatible rendering
+ */
+export function renderFooterHint(hints: FooterHint): string {
+  return hints
+    .map((item) => {
+      switch (item.type) {
+        case "text":
+          return item.value
+        case "key":
+          return `${item.key}: ${item.value}`
+        case "separator":
+          return item.char ?? DEFAULT_SEPARATOR
+        default:
+          return ""
+      }
+    })
+    .join(DEFAULT_SEPARATOR)
+}
+
+/**
+ * Parse legacy string format to FooterHint array
+ * Supports both "Key: Action" and "Key Action" formats
+ */
+export function parseFooterHintString(hint: string): FooterHint {
+  // Split on double spaces (common separator in existing hints)
+  const parts = hint.split(/\s{2,}/)
+
+  return parts.map((part): FooterHintItem => {
+    // Try to parse as "Key: Action" or "Key Action" format
+    const colonMatch = part.match(/^([^\s:]+):\s*(.+)$/)
+    if (colonMatch) {
+      return { type: "key", key: colonMatch[1], value: colonMatch[2] }
+    }
+
+    const spaceMatch = part.match(/^([^\s]+)\s+(.+)$/)
+    if (spaceMatch) {
+      return { type: "key", key: spaceMatch[1], value: spaceMatch[2] }
+    }
+
+    // Fallback to text
+    return { type: "text", value: part }
+  })
+}
+
+/**
+ * Helper to create a key hint
+ */
+export function key(
+  key: string,
+  value: string,
+  options?: { keyColor?: string; valueColor?: string; keyBgColor?: string; withBrackets?: boolean }
+): FooterHintKey {
+  return { type: "key", key, value, ...options }
+}
+
+/**
+ * Helper to create a text hint
+ */
+export function text(value: string, fg?: string): FooterHintText {
+  return { type: "text", value, fg }
+}
+
+/**
+ * Helper to create a separator
+ */
+export function separator(char?: string): FooterHintSeparator {
+  return { type: "separator", char }
+}

package/src/ui/components/PageLayout.ts

@@ -1,10 +1,11 @@
-import { BoxRenderable, TextRenderable, type CliRenderer } from "@opentui/core"
+import { BoxRenderable, TextRenderable, TextNodeRenderable, type CliRenderer } from "@opentui/core"
 import { getVersion } from "../../VersionInfo"
+import { type FooterHint } from "./FooterHint"
 
 export interface PageLayoutOptions {
   title: string
   stepInfo?: string
-  footerHint?: string
+  footerHint?: FooterHint | string
 }
 
 export interface PageLayoutResult {
@@ -79,15 +80,62 @@ export function createPageLayout(renderer: CliRenderer, options: PageLayoutOptio
     backgroundColor: "#1a1a2e",
   })
 
-  // Hint text
-  const hintText = footerHint || "↑↓ Navigate  Enter Select  q Quit"
-  footerBox.add(
-    new TextRenderable(renderer, {
-      id: `${idPrefix}-footer-hint`,
-      content: hintText,
-      fg: "#aaaaaa",
+  // Hint text - handle both array and string formats
+  // Always append separator + Ctrl+C Exit when hints are provided
+  const hintContainer = new TextRenderable(renderer, {
+    id: `${idPrefix}-footer-hint`,
+    content: "",
+    fg: "#aaaaaa",
+  })
+
+  if (!footerHint) {
+    hintContainer.content = "↑↓: Navigate  Enter: Select  Ctrl+C: Exit"
+  } else if (typeof footerHint === "string") {
+    hintContainer.content = footerHint + "  Ctrl+C: Exit"
+  } else {
+    // Append separator and global Ctrl+C hint (styled red for demo)
+    const hintsWithExit: FooterHint = [
+      ...footerHint,
+      { type: "separator", char: " | " },
+      { type: "key", key: "Ctrl+C", value: "Exit", keyColor: "#ff6666", valueColor: "#888888" },
+    ]
+
+    // Build styled content using TextNodeRenderable
+    const DEFAULT_KEY_COLOR = "#8be9fd" // cyan/bright
+    const DEFAULT_VALUE_COLOR = "#aaaaaa" // dim
+    const DEFAULT_SEP_COLOR = "#555555"
+
+    // Helper to create a styled text node
+    const styledText = (text: string, fg?: string, bg?: string): TextNodeRenderable => {
+      const node = new TextNodeRenderable({ fg, bg })
+      node.add(text)
+      return node
+    }
+
+    hintsWithExit.forEach((item, idx) => {
+      if (item.type === "separator") {
+        hintContainer.add(styledText(item.char ?? "  ", DEFAULT_SEP_COLOR))
+      } else if (item.type === "text") {
+        hintContainer.add(styledText(item.value, item.fg ?? DEFAULT_VALUE_COLOR))
+        // Add spacing after text (except last)
+        if (idx < hintsWithExit.length - 1 && hintsWithExit[idx + 1]?.type !== "separator") {
+          hintContainer.add(styledText("  "))
+        }
+      } else if (item.type === "key") {
+        const keyDisplay = item.withBrackets ? `[${item.key}]` : item.key
+        // Key part (styled)
+        hintContainer.add(styledText(keyDisplay, item.keyColor ?? DEFAULT_KEY_COLOR, item.keyBgColor))
+        // Colon + Value
+        hintContainer.add(styledText(`: ${item.value}`, item.valueColor ?? DEFAULT_VALUE_COLOR))
+        // Add spacing after (except last or before separator)
+        if (idx < hintsWithExit.length - 1 && hintsWithExit[idx + 1]?.type !== "separator") {
+          hintContainer.add(styledText("  "))
+        }
+      }
     })
-  )
+  }
+
+  footerBox.add(hintContainer)
 
   // Version
   footerBox.add(

package/src/ui/screens/AdvancedSettings.ts

@@ -58,7 +58,10 @@ export class AdvancedSettings {
     const { container: page, content } = createPageLayout(this.renderer, {
       title: "Advanced Settings",
       stepInfo: "Direct File Editing",
-      footerHint: "Enter Select  Esc Back",
+      footerHint: [
+        { type: "key", key: "Enter", value: "Select" },
+        { type: "key", key: "Esc", value: "Back" },
+      ],
     })
 
     const menu = new SelectRenderable(this.renderer, {

package/src/ui/screens/ApiKeyViewer.ts

@@ -235,7 +235,12 @@ export class ApiKeyViewer extends BoxRenderable {
     const { container, content } = createPageLayout(this.cliRenderer, {
       title: "API Key Extractor",
       stepInfo: "Found Keys",
-      footerHint: hasFoundKeys ? "S Save to .env  Esc/Enter Return" : "Esc/Enter: Return",
+      footerHint: hasFoundKeys
+        ? [
+            { type: "key", key: "S", value: "Save to .env" },
+            { type: "key", key: "Esc/Enter", value: "Return" },
+          ]
+        : [{ type: "key", key: "Esc/Enter", value: "Return" }],
     })
     this.add(container)
 

package/src/ui/screens/AppConfigurator.ts

@@ -95,7 +95,12 @@ export class AppConfigurator extends BoxRenderable {
     const { container, content } = createPageLayout(this.cliRenderer, {
       title: "Configure Apps",
       stepInfo: "Global Credentials",
-      footerHint: "Tab Cycle Fields/Shortcuts  O Override  Enter Continue  Esc Skip",
+      footerHint: [
+        { type: "key", key: "Tab", value: "Cycle Fields/Shortcuts" },
+        { type: "key", key: "O", value: "Override" },
+        { type: "key", key: "Enter", value: "Continue" },
+        { type: "key", key: "Esc", value: "Skip" },
+      ],
     })
     this.pageContainer = container
     this.add(container)
@@ -358,7 +363,7 @@ export class AppConfigurator extends BoxRenderable {
     const { container, content } = createPageLayout(this.cliRenderer, {
       title: "Configure Apps",
       stepInfo: "Setting up root folders",
-      footerHint: "Please wait...",
+      footerHint: [{ type: "text", value: "Please wait..." }],
     })
     this.pageContainer = container
     this.contentBox = content
@@ -427,7 +432,10 @@ export class AppConfigurator extends BoxRenderable {
     const { container, content } = createPageLayout(this.cliRenderer, {
       title: "Configure Apps",
       stepInfo: "qBittorrent Credentials",
-      footerHint: "Enter credentials from qBittorrent WebUI  Esc Skip",
+      footerHint: [
+        { type: "text", value: "Enter credentials from qBittorrent WebUI" },
+        { type: "key", key: "Esc", value: "Skip" },
+      ],
     })
     this.pageContainer = container
     this.add(container)
@@ -483,7 +491,10 @@ export class AppConfigurator extends BoxRenderable {
     const { container, content } = createPageLayout(this.cliRenderer, {
       title: "Configure Apps",
       stepInfo: "SABnzbd Credentials",
-      footerHint: "Enter API key from SABnzbd Config → General  Esc Skip",
+      footerHint: [
+        { type: "text", value: "Enter API key from SABnzbd Config → General" },
+        { type: "key", key: "Esc", value: "Skip" },
+      ],
     })
     this.pageContainer = container
     this.add(container)
@@ -615,7 +626,7 @@ export class AppConfigurator extends BoxRenderable {
     const { container, content } = createPageLayout(this.cliRenderer, {
       title: "Configure Apps",
       stepInfo: "Complete",
-      footerHint: "Press any key to return",
+      footerHint: [{ type: "text", value: "Press any key to return" }],
     })
     this.add(container)
 

package/src/ui/screens/AppManager.ts

@@ -54,7 +54,12 @@ export class AppManager {
     const { container: page, content } = createPageLayout(this.renderer as CliRenderer, {
       title: "Manage Apps",
       stepInfo: "Toggle apps linked to your configuration",
-      footerHint: "←→ Tab  Enter Toggle  s Save  q Back",
+      footerHint: [
+        { type: "key", key: "←→", value: "Tab" },
+        { type: "key", key: "Enter", value: "Toggle" },
+        { type: "key", key: "s", value: "Save" },
+        { type: "key", key: "q", value: "Back" },
+      ],
     })
     this.page = page
 

package/src/ui/screens/ContainerControl.ts

@@ -47,7 +47,10 @@ export class ContainerControl {
     const { container: page, content } = createPageLayout(this.renderer as CliRenderer, {
       title: "Container Control",
       stepInfo: finalStepInfo,
-      footerHint: "Enter Select/Action  q Back",
+      footerHint: [
+        { type: "key", key: "Enter", value: "Select/Action" },
+        { type: "key", key: "q", value: "Back" },
+      ],
     })
 
     if (!dockerOk) {

package/src/ui/screens/FullAutoSetup.ts

@@ -47,7 +47,10 @@ export class FullAutoSetup extends BoxRenderable {
     const { container: pageContainer, content: contentBox } = createPageLayout(cliRenderer, {
       title: "Full Auto Setup",
       stepInfo: "Configure all services automatically",
-      footerHint: "Enter Start/Continue  Esc Back",
+      footerHint: [
+        { type: "key", key: "Enter", value: "Start/Continue" },
+        { type: "key", key: "Esc", value: "Back" },
+      ],
     })
     super(cliRenderer, { width: "100%", height: "100%" })
     this.add(pageContainer)

package/src/ui/screens/MainMenu.ts

@@ -15,6 +15,7 @@ import { TRaSHProfileSetup } from "./TRaSHProfileSetup"
 import { ProwlarrSetup } from "./ProwlarrSetup"
 import { QBittorrentSetup } from "./QBittorrentSetup"
 import { FullAutoSetup } from "./FullAutoSetup"
+import { MonitorDashboard } from "./MonitorDashboard"
 
 export class MainMenu {
   private renderer: RenderContext
@@ -37,7 +38,7 @@ export class MainMenu {
     const { container: page, content } = createPageLayout(this.renderer as CliRenderer, {
       title: "Main Menu",
       stepInfo: "Docker Compose Generator for *arr Ecosystem",
-      footerHint: "Enter Select  Ctrl+C Exit",
+      footerHint: [{ type: "key", key: "Enter", value: "Select" }],
     })
     this.page = page
 
@@ -82,7 +83,7 @@ export class MainMenu {
     this.menu = new SelectRenderable(this.renderer, {
       id: "main-menu-select",
       width: "100%",
-      height: 10,
+      flexGrow: 1,
       options: [
         {
           name: "📦 Manage Apps",
@@ -124,6 +125,10 @@ export class MainMenu {
           name: "🚀 Full Auto Setup",
           description: "Run all configurations (Auth, Root Folders, Prowlarr, etc.)",
         },
+        {
+          name: "📊 Monitor Dashboard",
+          description: "Configure app health monitoring",
+        },
         { name: "❌ Exit", description: "Close easiarr" },
       ],
     })
@@ -211,7 +216,18 @@ export class MainMenu {
           this.container.add(autoSetup)
           break
         }
-        case 10:
+        case 10: {
+          // Monitor Dashboard
+          this.menu.blur()
+          this.page.visible = false
+          const monitor = new MonitorDashboard(this.renderer as CliRenderer, this.config, () => {
+            this.page.visible = true
+            this.menu.focus()
+          })
+          this.container.add(monitor)
+          break
+        }
+        case 11:
           process.exit(0)
           break
       }