mcp-arr-suite 1.0.0

package/dist/clients/arr-client.d.ts

@@ -0,0 +1,681 @@
+/**
+ * *arr Suite API Client
+ *
+ * All *arr applications share the same REST API pattern with X-Api-Key authentication.
+ * Extend ArrClient to add a new service.
+ */
+export type ArrService = 'sonarr' | 'radarr' | 'lidarr' | 'prowlarr';
+export interface ArrConfig {
+    url: string;
+    apiKey: string;
+}
+export interface SystemStatus {
+    appName: string;
+    version: string;
+    buildTime: string;
+    isDebug: boolean;
+    isProduction: boolean;
+    isAdmin: boolean;
+    isUserInteractive: boolean;
+    startupPath: string;
+    appData: string;
+    osName: string;
+    isDocker: boolean;
+    isLinux: boolean;
+    isOsx: boolean;
+    isWindows: boolean;
+}
+export interface QueueItem {
+    id: number;
+    title: string;
+    status: string;
+    trackedDownloadStatus: string;
+    trackedDownloadState: string;
+    statusMessages: Array<{
+        title: string;
+        messages: string[];
+    }>;
+    downloadId: string;
+    protocol: string;
+    downloadClient: string;
+    outputPath: string;
+    sizeleft: number;
+    size: number;
+    timeleft: string;
+    estimatedCompletionTime: string;
+}
+export interface QualityProfile {
+    id: number;
+    name: string;
+    upgradeAllowed: boolean;
+    cutoff: number;
+    items: Array<{
+        id?: number;
+        name?: string;
+        quality?: {
+            id: number;
+            name: string;
+            source: string;
+            resolution: number;
+        };
+        items?: Array<{
+            quality: {
+                id: number;
+                name: string;
+            };
+        }>;
+        allowed: boolean;
+    }>;
+    minFormatScore: number;
+    cutoffFormatScore: number;
+    formatItems: Array<{
+        format: number;
+        name: string;
+        score: number;
+    }>;
+}
+export interface QualityDefinition {
+    id: number;
+    quality: {
+        id: number;
+        name: string;
+        source: string;
+        resolution: number;
+    };
+    title: string;
+    weight: number;
+    minSize: number;
+    maxSize: number;
+    preferredSize: number;
+}
+export interface DownloadClient {
+    id: number;
+    name: string;
+    implementation: string;
+    implementationName: string;
+    configContract: string;
+    enable: boolean;
+    protocol: string;
+    priority: number;
+    removeCompletedDownloads: boolean;
+    removeFailedDownloads: boolean;
+    fields: Array<{
+        name: string;
+        value: unknown;
+    }>;
+    tags: number[];
+}
+export interface NamingConfig {
+    renameEpisodes?: boolean;
+    replaceIllegalCharacters: boolean;
+    colonReplacementFormat?: string;
+    standardEpisodeFormat?: string;
+    dailyEpisodeFormat?: string;
+    animeEpisodeFormat?: string;
+    seriesFolderFormat?: string;
+    seasonFolderFormat?: string;
+    specialsFolderFormat?: string;
+    multiEpisodeStyle?: number;
+    renameMovies?: boolean;
+    movieFolderFormat?: string;
+    standardMovieFormat?: string;
+    renameTracks?: boolean;
+    artistFolderFormat?: string;
+    albumFolderFormat?: string;
+    trackFormat?: string;
+}
+export interface MediaManagementConfig {
+    recycleBin: string;
+    recycleBinCleanupDays: number;
+    downloadPropersAndRepacks: string;
+    deleteEmptyFolders: boolean;
+    fileDate: string;
+    rescanAfterRefresh: string;
+    setPermissionsLinux: boolean;
+    chmodFolder: string;
+    chownGroup: string;
+    skipFreeSpaceCheckWhenImporting: boolean;
+    minimumFreeSpaceWhenImporting: number;
+    copyUsingHardlinks: boolean;
+    importExtraFiles: boolean;
+    extraFileExtensions: string;
+    enableMediaInfo: boolean;
+}
+export interface HealthCheck {
+    source: string;
+    type: string;
+    message: string;
+    wikiUrl: string;
+}
+export interface Tag {
+    id: number;
+    label: string;
+}
+export interface RootFolder {
+    id: number;
+    path: string;
+    accessible: boolean;
+    freeSpace: number;
+    unmappedFolders?: Array<{
+        name: string;
+        path: string;
+    }>;
+}
+export interface Indexer {
+    id: number;
+    name: string;
+    enableRss: boolean;
+    enableAutomaticSearch: boolean;
+    enableInteractiveSearch: boolean;
+    protocol: string;
+    priority: number;
+    added: string;
+}
+export interface SearchResult {
+    title: string;
+    sortTitle: string;
+    status: string;
+    overview: string;
+    year: number;
+    images: Array<{
+        coverType: string;
+        url: string;
+    }>;
+    remotePoster?: string;
+    tvdbId?: number;
+    tmdbId?: number;
+    imdbId?: string;
+    foreignArtistId?: string;
+    artistName?: string;
+    disambiguation?: string;
+}
+export interface Series {
+    id: number;
+    title: string;
+    sortTitle: string;
+    status: string;
+    overview: string;
+    network: string;
+    airTime: string;
+    year: number;
+    path: string;
+    qualityProfileId: number;
+    seasonFolder: boolean;
+    monitored: boolean;
+    runtime: number;
+    tvdbId: number;
+    imdbId: string;
+    titleSlug: string;
+    genres: string[];
+    tags: number[];
+    seasons: Array<{
+        seasonNumber: number;
+        monitored: boolean;
+    }>;
+    statistics: {
+        seasonCount: number;
+        episodeFileCount: number;
+        episodeCount: number;
+        totalEpisodeCount: number;
+        sizeOnDisk: number;
+        percentOfEpisodes: number;
+    };
+}
+export interface Episode {
+    id: number;
+    seriesId: number;
+    tvdbId: number;
+    episodeFileId: number;
+    seasonNumber: number;
+    episodeNumber: number;
+    title: string;
+    airDate: string;
+    airDateUtc: string;
+    overview: string;
+    hasFile: boolean;
+    monitored: boolean;
+    absoluteEpisodeNumber: number;
+    episodeFile?: {
+        id: number;
+        relativePath: string;
+        path: string;
+        size: number;
+        dateAdded: string;
+        quality: {
+            quality: {
+                id: number;
+                name: string;
+            };
+        };
+    };
+}
+export interface Movie {
+    id: number;
+    title: string;
+    sortTitle: string;
+    sizeOnDisk: number;
+    status: string;
+    overview: string;
+    inCinemas: string;
+    physicalRelease: string;
+    digitalRelease: string;
+    year: number;
+    hasFile: boolean;
+    studio: string;
+    path: string;
+    qualityProfileId: number;
+    monitored: boolean;
+    minimumAvailability: string;
+    isAvailable: boolean;
+    runtime: number;
+    imdbId: string;
+    tmdbId: number;
+    titleSlug: string;
+    genres: string[];
+    tags: number[];
+    movieFile?: {
+        id: number;
+        relativePath: string;
+        path: string;
+        size: number;
+        dateAdded: string;
+        quality: {
+            quality: {
+                id: number;
+                name: string;
+            };
+        };
+    };
+}
+export interface Artist {
+    id: number;
+    artistName: string;
+    sortName: string;
+    status: string;
+    overview: string;
+    artistType: string;
+    disambiguation: string;
+    path: string;
+    qualityProfileId: number;
+    metadataProfileId: number;
+    monitored: boolean;
+    monitorNewItems: string;
+    genres: string[];
+    foreignArtistId: string;
+    tags: number[];
+    statistics: {
+        albumCount: number;
+        trackFileCount: number;
+        trackCount: number;
+        totalTrackCount: number;
+        sizeOnDisk: number;
+        percentOfTracks: number;
+    };
+}
+export interface Album {
+    id: number;
+    title: string;
+    disambiguation: string;
+    overview: string;
+    artistId: number;
+    foreignAlbumId: string;
+    monitored: boolean;
+    profileId: number;
+    duration: number;
+    albumType: string;
+    genres: string[];
+    statistics?: {
+        trackFileCount: number;
+        trackCount: number;
+        totalTrackCount: number;
+        sizeOnDisk: number;
+        percentOfTracks: number;
+    };
+    releaseDate: string;
+    grabbed: boolean;
+}
+export interface MetadataProfile {
+    id: number;
+    name: string;
+    minPopularity?: number;
+    skipMissingDate: boolean;
+    skipMissingIsbn: boolean;
+    skipPartsAndSets: boolean;
+    skipSeriesSecondary: boolean;
+    allowedLanguages?: string;
+    minPages?: number;
+}
+export interface DiskSpace {
+    path: string;
+    label: string;
+    freeSpace: number;
+    totalSpace: number;
+}
+export interface MovieFile {
+    id: number;
+    movieId: number;
+    relativePath: string;
+    path: string;
+    size: number;
+    dateAdded: string;
+    quality: {
+        quality: {
+            id: number;
+            name: string;
+            source: string;
+            resolution: number;
+        };
+        revision: {
+            version: number;
+            real: number;
+        };
+    };
+    mediaInfo?: {
+        audioChannels: number;
+        audioCodec: string;
+        audioLanguages: string;
+        subtitles: string;
+        videoCodec: string;
+        videoDynamicRange: string;
+        videoDynamicRangeType: string;
+    };
+    originalFilePath?: string;
+    qualityCutoffNotMet: boolean;
+    languages: Array<{
+        id: number;
+        name: string;
+    }>;
+    edition: string;
+}
+export interface HistoryRecord {
+    id: number;
+    movieId: number;
+    sourceTitle: string;
+    languages: Array<{
+        id: number;
+        name: string;
+    }>;
+    quality: {
+        quality: {
+            id: number;
+            name: string;
+        };
+    };
+    customFormats?: Array<{
+        id: number;
+        name: string;
+    }>;
+    qualityCutoffNotMet: boolean;
+    date: string;
+    downloadId?: string;
+    eventType: string;
+    data: Record<string, string>;
+}
+export interface BlocklistRecord {
+    id: number;
+    movieId: number;
+    sourceTitle: string;
+    languages: Array<{
+        id: number;
+        name: string;
+    }>;
+    quality: {
+        quality: {
+            id: number;
+            name: string;
+        };
+    };
+    date: string;
+    protocol: string;
+    indexer: string;
+    message: string;
+}
+export interface WantedRecord {
+    page: number;
+    pageSize: number;
+    sortKey: string;
+    sortDirection: string;
+    totalRecords: number;
+    records: Movie[];
+}
+export interface EpisodeFile {
+    id: number;
+    seriesId: number;
+    seasonNumber: number;
+    relativePath: string;
+    path: string;
+    size: number;
+    dateAdded: string;
+    quality: {
+        quality: {
+            id: number;
+            name: string;
+        };
+        revision: {
+            version: number;
+            real: number;
+        };
+    };
+    mediaInfo?: {
+        audioChannels: number;
+        audioCodec: string;
+        audioLanguages: string;
+        subtitles: string;
+        videoCodec: string;
+        videoDynamicRange: string;
+        videoDynamicRangeType: string;
+    };
+    qualityCutoffNotMet: boolean;
+    languages: Array<{
+        id: number;
+        name: string;
+    }>;
+}
+export interface SeriesHistoryRecord {
+    id: number;
+    episodeId: number;
+    seriesId: number;
+    sourceTitle: string;
+    languages: Array<{
+        id: number;
+        name: string;
+    }>;
+    quality: {
+        quality: {
+            id: number;
+            name: string;
+        };
+    };
+    qualityCutoffNotMet: boolean;
+    date: string;
+    downloadId?: string;
+    eventType: string;
+    data: Record<string, string>;
+}
+export interface SeriesWantedRecord {
+    page: number;
+    pageSize: number;
+    sortKey: string;
+    sortDirection: string;
+    totalRecords: number;
+    records: Series[];
+}
+export interface SeriesBlocklistRecord {
+    id: number;
+    seriesId: number;
+    episodeIds: number[];
+    sourceTitle: string;
+    languages: Array<{
+        id: number;
+        name: string;
+    }>;
+    quality: {
+        quality: {
+            id: number;
+            name: string;
+        };
+    };
+    date: string;
+    protocol: string;
+    indexer: string;
+    message: string;
+}
+export interface IndexerStats {
+    id: number;
+    indexerId: number;
+    indexerName: string;
+    averageResponseTime: number;
+    numberOfQueries: number;
+    numberOfGrabs: number;
+    numberOfRssQueries: number;
+    numberOfAuthQueries: number;
+    numberOfFailedQueries: number;
+    numberOfFailedGrabs: number;
+    numberOfFailedRssQueries: number;
+    numberOfFailedAuthQueries: number;
+}
+export declare class ArrClient {
+    private readonly config;
+    private readonly serviceName;
+    protected apiVersion: string;
+    constructor(serviceName: ArrService, config: ArrConfig);
+    protected request<T>(endpoint: string, options?: RequestInit): Promise<T>;
+    getStatus(): Promise<SystemStatus>;
+    getQueue(): Promise<{
+        records: QueueItem[];
+        totalRecords: number;
+    }>;
+    getCalendar(start?: string, end?: string): Promise<unknown[]>;
+    getQualityProfiles(): Promise<QualityProfile[]>;
+    getQualityDefinitions(): Promise<QualityDefinition[]>;
+    getDownloadClients(): Promise<DownloadClient[]>;
+    getNamingConfig(): Promise<NamingConfig>;
+    getMediaManagement(): Promise<MediaManagementConfig>;
+    getHealth(): Promise<HealthCheck[]>;
+    getTags(): Promise<Tag[]>;
+    getRootFolders(): Promise<RootFolder[]>;
+    getIndexers(): Promise<Indexer[]>;
+    testConnection(): Promise<boolean>;
+}
+export declare class SonarrClient extends ArrClient {
+    constructor(config: ArrConfig);
+    getSeries(): Promise<Series[]>;
+    getSeriesById(id: number): Promise<Series>;
+    searchSeries(term: string): Promise<SearchResult[]>;
+    addSeries(series: Partial<Series> & {
+        tvdbId: number;
+        rootFolderPath: string;
+        qualityProfileId: number;
+    }): Promise<Series>;
+    getEpisodes(seriesId: number, seasonNumber?: number): Promise<Episode[]>;
+    searchMissing(seriesId: number): Promise<{
+        id: number;
+    }>;
+    searchEpisode(episodeIds: number[]): Promise<{
+        id: number;
+    }>;
+    refreshSeries(seriesId: number): Promise<{
+        id: number;
+    }>;
+    deleteSeries(seriesId: number, deleteFiles?: boolean, addImportListExclusion?: boolean): Promise<void>;
+    updateSeries(seriesId: number, changes: Partial<Series>): Promise<Series>;
+    getDiskSpace(): Promise<DiskSpace[]>;
+    getHistory(seriesId?: number, page?: number, pageSize?: number): Promise<{
+        records: SeriesHistoryRecord[];
+        totalRecords: number;
+    }>;
+    removeFromQueue(queueId: number, blocklist?: boolean, removeFromClient?: boolean): Promise<void>;
+    removeFromQueueBulk(ids: number[], blocklist?: boolean, removeFromClient?: boolean): Promise<void>;
+    getWantedMissing(page?: number, pageSize?: number): Promise<SeriesWantedRecord>;
+    getWantedCutoff(page?: number, pageSize?: number): Promise<SeriesWantedRecord>;
+    getEpisodeFiles(seriesId: number): Promise<EpisodeFile[]>;
+    deleteEpisodeFile(fileId: number): Promise<void>;
+    getBlocklist(page?: number, pageSize?: number): Promise<{
+        records: SeriesBlocklistRecord[];
+        totalRecords: number;
+    }>;
+    deleteFromBlocklist(blocklistId: number): Promise<void>;
+    monitorEpisodes(episodeIds: number[], monitored: boolean): Promise<void>;
+    setSeasonPass(series: Array<{
+        id: number;
+        monitored: boolean;
+        seasons: Array<{
+            seasonNumber: number;
+            monitored: boolean;
+        }>;
+    }>): Promise<void>;
+}
+export declare class RadarrClient extends ArrClient {
+    constructor(config: ArrConfig);
+    getMovies(): Promise<Movie[]>;
+    getMovieById(id: number): Promise<Movie>;
+    searchMovies(term: string): Promise<SearchResult[]>;
+    addMovie(movie: Partial<Movie> & {
+        tmdbId: number;
+        rootFolderPath: string;
+        qualityProfileId: number;
+    }): Promise<Movie>;
+    searchMovie(movieId: number): Promise<{
+        id: number;
+    }>;
+    refreshMovie(movieId: number): Promise<{
+        id: number;
+    }>;
+    deleteMovie(movieId: number, deleteFiles?: boolean, addImportExclusion?: boolean): Promise<void>;
+    updateMovie(movieId: number, changes: Partial<Movie>): Promise<Movie>;
+    getDiskSpace(): Promise<DiskSpace[]>;
+    getHistory(movieId?: number, page?: number, pageSize?: number): Promise<{
+        records: HistoryRecord[];
+        totalRecords: number;
+    }>;
+    removeFromQueue(queueId: number, blocklist?: boolean, removeFromClient?: boolean): Promise<void>;
+    removeFromQueueBulk(ids: number[], blocklist?: boolean, removeFromClient?: boolean): Promise<void>;
+    getWantedMissing(page?: number, pageSize?: number): Promise<WantedRecord>;
+    getWantedCutoff(page?: number, pageSize?: number): Promise<WantedRecord>;
+    getMovieFiles(movieId: number): Promise<MovieFile[]>;
+    deleteMovieFile(fileId: number): Promise<void>;
+    getBlocklist(page?: number, pageSize?: number): Promise<{
+        records: BlocklistRecord[];
+        totalRecords: number;
+    }>;
+    deleteFromBlocklist(blocklistId: number): Promise<void>;
+}
+export declare class LidarrClient extends ArrClient {
+    constructor(config: ArrConfig);
+    getArtists(): Promise<Artist[]>;
+    getArtistById(id: number): Promise<Artist>;
+    searchArtists(term: string): Promise<SearchResult[]>;
+    addArtist(artist: Partial<Artist> & {
+        foreignArtistId: string;
+        rootFolderPath: string;
+        qualityProfileId: number;
+        metadataProfileId: number;
+    }): Promise<Artist>;
+    getAlbums(artistId?: number): Promise<Album[]>;
+    getAlbumById(id: number): Promise<Album>;
+    searchAlbum(albumId: number): Promise<{
+        id: number;
+    }>;
+    searchMissingAlbums(artistId: number): Promise<{
+        id: number;
+    }>;
+    getCalendar(start?: string, end?: string): Promise<Album[]>;
+    getMetadataProfiles(): Promise<MetadataProfile[]>;
+}
+export declare class ProwlarrClient extends ArrClient {
+    constructor(config: ArrConfig);
+    getIndexers(): Promise<Indexer[]>;
+    testAllIndexers(): Promise<Array<{
+        id: number;
+        isValid: boolean;
+        validationFailures: Array<{
+            propertyName: string;
+            errorMessage: string;
+        }>;
+    }>>;
+    getIndexerStats(): Promise<{
+        indexers: IndexerStats[];
+    }>;
+    search(query: string, categories?: number[]): Promise<unknown[]>;
+}
+//# sourceMappingURL=arr-client.d.ts.map