@muhammedaksam/easiarr 1.4.0 → 1.4.1

package/src/config/manager.ts

@@ -1,150 +0,0 @@
-/**
- * Configuration Manager
- * Handles reading and writing config to $XDG_CONFIG_HOME/easiarr/
- */
-
-import { existsSync } from "node:fs"
-import { copyFile, mkdir, readFile, writeFile } from "node:fs/promises"
-import { homedir } from "node:os"
-import { join } from "node:path"
-
-import type { EasiarrConfig } from "./schema"
-import { debugLog } from "~/utils/debug"
-import { VersionInfo } from "~/VersionInfo"
-import { detectGid, detectTimezone, detectUid } from "./defaults"
-import { DEFAULT_CONFIG } from "./schema"
-
-const CONFIG_DIR_NAME = "easiarr"
-const CONFIG_FILE_NAME = "config.json"
-const BACKUP_DIR_NAME = "backups"
-
-export function getConfigDir(): string {
-  const xdgConfigHome = process.env.XDG_CONFIG_HOME || join(homedir(), ".config")
-  return join(xdgConfigHome, CONFIG_DIR_NAME)
-}
-
-export function getConfigPath(): string {
-  return join(getConfigDir(), CONFIG_FILE_NAME)
-}
-
-export function getBackupDir(): string {
-  return join(getConfigDir(), BACKUP_DIR_NAME)
-}
-
-export function getComposePath(): string {
-  return join(getConfigDir(), "docker-compose.yml")
-}
-
-export async function ensureConfigDir(): Promise<void> {
-  const configDir = getConfigDir()
-  const backupDir = getBackupDir()
-
-  if (!existsSync(configDir)) {
-    await mkdir(configDir, { recursive: true })
-  }
-
-  if (!existsSync(backupDir)) {
-    await mkdir(backupDir, { recursive: true })
-  }
-}
-
-export async function configExists(): Promise<boolean> {
-  return existsSync(getConfigPath())
-}
-
-/**
- * Migrate config to current version
- * Preserves user settings while adding new fields with defaults
- */
-function migrateConfig(oldConfig: Partial<EasiarrConfig>): EasiarrConfig {
-  return {
-    // Start with defaults for new fields
-    ...DEFAULT_CONFIG,
-    // Preserve all user settings
-    ...oldConfig,
-    // Always update version to current
-    version: VersionInfo.version,
-    // Ensure required fields have values
-    umask: oldConfig.umask ?? "002",
-    apps: oldConfig.apps ?? [],
-    createdAt: oldConfig.createdAt ?? new Date().toISOString(),
-    updatedAt: new Date().toISOString(),
-  } as EasiarrConfig
-}
-
-export async function loadConfig(): Promise<EasiarrConfig | null> {
-  const configPath = getConfigPath()
-  debugLog("Config", `Loading config from ${configPath}`)
-
-  if (!existsSync(configPath)) {
-    debugLog("Config", "Config file not found")
-    return null
-  }
-
-  try {
-    const content = await readFile(configPath, "utf-8")
-    let config = JSON.parse(content) as EasiarrConfig
-    debugLog("Config", `Loaded config version ${config.version}`)
-
-    // Auto-migrate if version differs from current package version
-    if (config.version !== VersionInfo.version) {
-      debugLog("Config", `Migrating config from ${config.version} to ${VersionInfo.version}`)
-      config = migrateConfig(config)
-      // Save migrated config (creates backup first)
-      await saveConfig(config)
-    }
-
-    return config
-  } catch (error) {
-    debugLog("Config", `Failed to load config: ${error}`)
-    console.error("Failed to load config:", error)
-    return null
-  }
-}
-
-export async function saveConfig(config: EasiarrConfig): Promise<void> {
-  await ensureConfigDir()
-
-  const configPath = getConfigPath()
-  debugLog("Config", `Saving config to ${configPath}`)
-
-  // Create backup if config already exists
-  if (existsSync(configPath)) {
-    await backupConfig()
-  }
-
-  // Update timestamp
-  config.updatedAt = new Date().toISOString()
-
-  await writeFile(configPath, JSON.stringify(config, null, 2), "utf-8")
-  debugLog("Config", `Config saved (${config.apps.length} apps)`)
-}
-
-export async function backupConfig(): Promise<void> {
-  const configPath = getConfigPath()
-
-  if (!existsSync(configPath)) {
-    return
-  }
-
-  const backupDir = getBackupDir()
-  const timestamp = new Date().toISOString().replace(/[:.]/g, "-")
-  const backupPath = join(backupDir, `config-${timestamp}.json`)
-
-  await copyFile(configPath, backupPath)
-  debugLog("Config", `Backup created: ${backupPath}`)
-}
-
-export function createDefaultConfig(rootDir: string): EasiarrConfig {
-  const now = new Date().toISOString()
-
-  return {
-    ...DEFAULT_CONFIG,
-    rootDir,
-    timezone: detectTimezone(),
-    uid: detectUid(),
-    gid: detectGid(),
-    createdAt: now,
-    updatedAt: now,
-  }
-}

package/src/config/recyclarr-config.ts

@@ -1,181 +0,0 @@
-/**
- * Recyclarr Configuration Generator
- * Generates recyclarr.yml for automatic TRaSH Guides profile sync
- */
-
-import { mkdir, writeFile } from "node:fs/promises"
-import { join } from "node:path"
-
-import YAML from "yaml"
-
-import type { AppId, EasiarrConfig } from "./schema"
-import { debugLog } from "~/utils/debug"
-import { readEnv } from "~/utils/env"
-
-/**
- * Get API key for an app from the .env file
- */
-async function getAppApiKey(appId: AppId): Promise<string | null> {
-  const env = await readEnv()
-  const envKey = `API_KEY_${appId.toUpperCase()}`
-  return env[envKey] ?? null
-}
-
-// TRaSH Guide Custom Format IDs for common unwanted content
-const UNWANTED_CFS = {
-  radarr: [
-    "ed38b889b31be83fda192888e2286d83", // BR-DISK
-    "90a6f9a284dff5103f6346090e6280c8", // LQ
-    "e204b80c87be9497a8a6eaff48f72905", // LQ (Release Title)
-    "dc98083864ea246d05a42df0d05f81cc", // x265 (HD)
-    "0a3f082873eb454bde444150b70253cc", // Extras
-  ],
-  sonarr: [
-    "85c61753df5da1fb2aab6f2a47426b09", // BR-DISK
-    "9c11cd3f07101cdba90a2d81cf0e56b4", // LQ
-    "e2315f990da2e2cbfc9fa5b7a6fcfe48", // LQ (Release Title)
-    "47435ece6b99a0b477caf360e79ba0bb", // x265 (HD)
-    "fbcb31d8dabd2a319072b84fc0b7249c", // Extras
-  ],
-}
-
-// TRaSH Guide Quality Definition types
-const QUALITY_DEFINITIONS = {
-  radarr: "movie",
-  sonarr: "series",
-}
-
-// Default quality profiles to assign scores to
-const DEFAULT_PROFILES = {
-  radarr: ["HD", "HD-1080p", "Ultra-HD", "Any"],
-  sonarr: ["WEB-1080p", "WEB-DL (1080p)", "HD-1080p", "Any"],
-}
-
-interface RecyclarrInstance {
-  base_url: string
-  api_key: string
-  quality_definition?: {
-    type: string
-    preferred_ratio?: number
-  }
-  custom_formats?: Array<{
-    trash_ids: string[]
-    quality_profiles: Array<{
-      name: string
-    }>
-  }>
-}
-
-interface RecyclarrConfig {
-  radarr?: Record<string, RecyclarrInstance>
-  sonarr?: Record<string, RecyclarrInstance>
-}
-
-/**
- * Generate recyclarr.yml configuration for enabled *arr apps
- */
-export async function generateRecyclarrConfig(config: EasiarrConfig): Promise<string> {
-  debugLog("Recyclarr", "Generating recyclarr.yml configuration")
-
-  const recyclarrConfig: RecyclarrConfig = {}
-
-  // Check for enabled Radarr
-  const radarrApp = config.apps.find((a) => a.id === "radarr" && a.enabled)
-  if (radarrApp) {
-    const apiKey = await getAppApiKey("radarr")
-    if (apiKey) {
-      const port = radarrApp.port ?? 7878
-      recyclarrConfig.radarr = {
-        radarr_main: {
-          base_url: `http://radarr:${port}`,
-          api_key: apiKey,
-          quality_definition: {
-            type: QUALITY_DEFINITIONS.radarr,
-            preferred_ratio: 0.5,
-          },
-          custom_formats: [
-            {
-              trash_ids: UNWANTED_CFS.radarr,
-              quality_profiles: DEFAULT_PROFILES.radarr.map((name) => ({ name })),
-            },
-          ],
-        },
-      }
-      debugLog("Recyclarr", "Added Radarr configuration")
-    } else {
-      debugLog("Recyclarr", "Radarr enabled but no API key found - skipping")
-    }
-  }
-
-  // Check for enabled Sonarr
-  const sonarrApp = config.apps.find((a) => a.id === "sonarr" && a.enabled)
-  if (sonarrApp) {
-    const apiKey = await getAppApiKey("sonarr")
-    if (apiKey) {
-      const port = sonarrApp.port ?? 8989
-      recyclarrConfig.sonarr = {
-        sonarr_main: {
-          base_url: `http://sonarr:${port}`,
-          api_key: apiKey,
-          quality_definition: {
-            type: QUALITY_DEFINITIONS.sonarr,
-          },
-          custom_formats: [
-            {
-              trash_ids: UNWANTED_CFS.sonarr,
-              quality_profiles: DEFAULT_PROFILES.sonarr.map((name) => ({ name })),
-            },
-          ],
-        },
-      }
-      debugLog("Recyclarr", "Added Sonarr configuration")
-    } else {
-      debugLog("Recyclarr", "Sonarr enabled but no API key found - skipping")
-    }
-  }
-
-  // Generate YAML
-  const yamlContent = YAML.stringify(recyclarrConfig, {
-    indent: 2,
-    lineWidth: 0,
-  })
-
-  // Add header comment
-  const header = `# Recyclarr Configuration
-# Generated by easiarr - https://github.com/muhammedaksam/easiarr
-# 
-# This configuration syncs TRaSH Guides profiles to your *arr apps.
-# Recyclarr runs daily via cron to keep profiles up to date.
-#
-# For more options, see: https://recyclarr.dev/reference/configuration/
-#
-# To manually trigger sync: docker compose run --rm recyclarr sync
-#
-
-`
-
-  return header + yamlContent
-}
-
-/**
- * Save recyclarr.yml to the config directory
- */
-export async function saveRecyclarrConfig(config: EasiarrConfig): Promise<string> {
-  const recyclarrDir = join(config.rootDir, "config", "recyclarr")
-  await mkdir(recyclarrDir, { recursive: true })
-
-  const configContent = await generateRecyclarrConfig(config)
-  const configPath = join(recyclarrDir, "recyclarr.yml")
-
-  await writeFile(configPath, configContent, "utf-8")
-  debugLog("Recyclarr", `Saved recyclarr.yml to ${configPath}`)
-
-  return configPath
-}
-
-/**
- * Get the path to the recyclarr config file
- */
-export function getRecyclarrConfigPath(config: EasiarrConfig): string {
-  return join(config.rootDir, "config", "recyclarr", "recyclarr.yml")
-}

package/src/config/schema.ts

@@ -1,310 +0,0 @@
-/**
- * easiarr Configuration Schema
- * TypeScript interfaces for configuration management
- */
-
-import { VersionInfo } from "~/VersionInfo"
-
-export interface EasiarrConfig {
-  version: string
-  rootDir: string
-  timezone: string
-  uid: number
-  gid: number
-  umask: string
-  apps: AppConfig[]
-  network?: NetworkConfig
-  /** Which reverse proxy to use: traefik, caddy, or none */
-  reverseProxy?: "traefik" | "caddy" | "none"
-  traefik?: TraefikConfig
-  caddy?: CaddyConfig
-  vpn?: VpnConfig
-  monitor?: MonitorConfig
-  /** Bind-mount container logs to host for external log aggregation */
-  logMount?: boolean
-  createdAt: string
-  updatedAt: string
-}
-
-export type ReverseProxyType = "traefik" | "caddy" | "none"
-
-export interface CaddyConfig {
-  enabled: boolean
-  domain: string
-  /** Email for ACME/Let's Encrypt */
-  email?: string
-}
-
-export type VpnMode = "full" | "mini" | "none"
-
-export interface VpnConfig {
-  mode: VpnMode
-  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
-  entrypoint: string
-  middlewares: string[]
-  /** Basic auth using username/password */
-  basicAuth?: {
-    enabled: boolean
-    username: string
-    password: string
-  }
-}
-
-export interface AppConfig {
-  id: AppId
-  enabled: boolean
-  port?: number
-  customEnv?: Record<string, string>
-  customVolumes?: string[]
-  labels?: string[]
-  devices?: string[]
-  cap_add?: string[]
-}
-
-export interface NetworkConfig {
-  name: string
-  driver: "bridge" | "host" | "none"
-}
-
-export type AppId =
-  // Media Management (Servarr)
-  | "radarr"
-  | "sonarr"
-  | "lidarr"
-  | "readarr"
-  | "bazarr"
-  | "mylar3"
-  | "whisparr"
-  | "audiobookshelf"
-  // Indexers
-  | "prowlarr"
-  | "jackett"
-  | "flaresolverr"
-  // Download Clients
-  | "qbittorrent"
-  | "sabnzbd"
-  | "slskd"
-  | "soularr"
-  // Media Servers
-  | "plex"
-  | "jellyfin"
-  | "tautulli"
-  | "tdarr"
-  // Request Management
-  | "overseerr"
-  | "jellyseerr"
-  // Dashboards
-  | "homarr"
-  | "heimdall"
-  | "homepage"
-  // Utilities
-  | "huntarr"
-  | "maintainerr"
-  | "unpackerr"
-  | "filebot"
-  | "chromium"
-  | "guacamole"
-  | "guacd"
-  | "ddns-updater"
-  | "easiarr"
-  | "recyclarr"
-  | "profilarr"
-  // VPN
-  | "gluetun"
-  // Monitoring & Infra
-  | "portainer"
-  | "dozzle"
-  | "uptime-kuma"
-  // Monitoring
-  | "grafana"
-  | "prometheus"
-  // Reverse Proxy
-  | "traefik"
-  | "traefik-certs-dumper"
-  | "caddy"
-  | "cloudflared"
-  | "crowdsec"
-  // Network/VPN
-  | "headscale"
-  | "headplane"
-  | "tailscale"
-  // Authentication
-  | "authentik"
-  | "authentik-worker"
-  // Database
-  | "postgresql"
-  | "valkey"
-
-export type AppCategory =
-  | "servarr"
-  | "indexer"
-  | "downloader"
-  | "mediaserver"
-  | "request"
-  | "dashboard"
-  | "utility"
-  | "vpn"
-  | "monitoring"
-  | "infrastructure"
-
-export type Architecture = "x64" | "arm64" | "arm32"
-
-export interface ArchCompatibility {
-  /** Architectures with full support */
-  supported?: Architecture[]
-  /** Architectures with deprecated/broken support - will show warning */
-  deprecated?: Architecture[]
-  /** Warning message to show for deprecated architectures */
-  warning?: string
-}
-
-export interface AppDefinition {
-  id: AppId
-  name: string
-  description: string
-  category: AppCategory
-  defaultPort: number
-  /** Internal container port if different from defaultPort */
-  internalPort?: number
-  /** Additional port mappings (e.g., "8083:8080" for dashboard ports) */
-  secondaryPorts?: string[]
-  image: string
-  puid: number
-  pgid: number
-  volumes: (rootDir: string) => string[]
-  environment?: Record<string, string>
-  dependsOn?: AppId[]
-  trashGuide?: string
-  secrets?: AppSecret[]
-  devices?: string[]
-  cap_add?: string[]
-  /** Custom command to run (e.g., "tunnel run" for cloudflared) */
-  command?: string
-  apiKeyMeta?: ApiKeyMeta
-  rootFolder?: RootFolderMeta
-  prowlarrCategoryIds?: number[]
-  /** Architecture compatibility info - omit if supports all */
-  arch?: ArchCompatibility
-  /** Minimum password length requirement for user creation */
-  minPasswordLength?: number
-  /** Homepage dashboard configuration */
-  homepage?: HomepageMeta
-  /** Auto-setup capability metadata */
-  autoSetup?: AutoSetupCapability
-  /** Use Docker's user: directive instead of PUID/PGID env vars (e.g., slskd) */
-  useDockerUser?: boolean
-  /** Path inside container where logs are stored (e.g., "/config/logs"), for bind-mounting */
-  logVolume?: string
-}
-
-/** Auto-setup capability for an app */
-export interface AutoSetupCapability {
-  /** Type of auto-setup support: full (complete config), partial (basic config), manual (user must configure) */
-  type: "full" | "partial" | "manual"
-  /** Human-readable description of what gets configured */
-  description: string
-  /** Other apps that must be set up first */
-  requires?: AppId[]
-  /** Environment variables required for setup */
-  envVars?: string[]
-}
-
-/** Homepage dashboard widget/service configuration */
-export interface HomepageMeta {
-  /** Icon name from Dashboard Icons (e.g., "radarr.png", "mdi-web") */
-  icon?: string
-  /** Widget type for Homepage (e.g., "radarr", "sonarr", "qbittorrent") */
-  widget?: string
-  /** Custom widget fields if needed */
-  widgetFields?: Record<string, string>
-}
-
-export interface RootFolderMeta {
-  path: string // e.g. "/data/media/movies"
-  apiVersion: "v1" | "v3"
-}
-
-export interface ApiKeyMeta {
-  configFile: string // Relative to config volume root
-  parser: ApiKeyParserType
-  selector: string // Regex group 1, or XML tag, or INI key, JSON/YAML dot path
-  /** INI section name (for parser: "ini") */
-  section?: string
-  /** INI key that controls if API is enabled (for parser: "ini") */
-  enabledKey?: string
-  /** Generate API key if missing or None (for apps like Mylar3) */
-  generateIfMissing?: boolean
-  description?: string
-  transform?: (value: string) => string
-}
-
-export type ApiKeyParserType = "xml" | "ini" | "json" | "yaml" | "regex"
-
-export interface AppSecret {
-  name: string
-  description: string
-  required: boolean
-  default?: string
-  generate?: boolean // Suggest auto-generation
-  mask?: boolean // Mask input
-}
-
-export const APP_CATEGORIES: Record<AppCategory, string> = {
-  servarr: "Media Management",
-  indexer: "Indexers",
-  downloader: "Download Clients",
-  mediaserver: "Media Servers",
-  request: "Request Management",
-  dashboard: "Dashboards",
-  utility: "Utilities",
-  vpn: "VPN",
-  monitoring: "Monitoring",
-  infrastructure: "Infrastructure",
-}
-
-export const DEFAULT_CONFIG: Omit<EasiarrConfig, "createdAt" | "updatedAt"> = {
-  version: VersionInfo.version,
-  rootDir: "",
-  timezone: "",
-  uid: 1000,
-  gid: 1000,
-  umask: "002",
-  apps: [],
-}