Ferrite-backup/Ferrite/Protocols/Debrid.swift

//
//  Debrid.swift
//  Ferrite
//
//  Created by Brian Dashore on 6/1/24.
//

import Foundation

public protocol DebridSource {
    // ID of the service
    var id: String { get }
    var abbreviation: String { get }
    var website: String { get }

    // Common authentication functions
    func setApiKey(_ key: String) -> Bool
    func logout() async

    // Fetches a download link from a source
    // Include the instant availability information with the args
    func getDownloadLink(magnet: Magnet, ia: DebridIA?, iaFile: DebridIAFile?) async throws -> String

    // Fetches cloud information from the service
    func getUserDownloads() async throws -> [DebridCloudDownload]
    func getUserTorrents() async throws -> [DebridCloudTorrent]

    // Deletes information from the service
    func deleteDownload(downloadId: String) async throws
    func deleteTorrent(torrentId: String) async throws
}

public protocol PollingDebridSource: DebridSource {
    // Task reference for polling
    var authTask: Task<Void, Error>? { get set }

    // Fetches the Auth URL
    func getAuthUrl() async throws -> URL
}

public protocol OAuthDebridSource: DebridSource {
    // Fetches the auth URL
    func getAuthUrl() throws -> URL

    // Handles an OAuth callback
    func handleAuthCallback(url: URL) throws
}