import * as vscode from "vscode";

export interface GithubRepo {
    name: string;
    owner: string;
}

/**
 * Metadata about particular artifact retrieved from GitHub releases.
 */
export interface ArtifactReleaseInfo {
    releaseName: string;
    downloadUrl: string;
}

/**
 * Represents the source of a binary artifact which is either specified by the user
 * explicitly, or bundled by this extension from GitHub releases.
 */
export type BinarySource = BinarySource.ExplicitPath | BinarySource.GithubRelease;

export namespace BinarySource {
    /**
     * Type tag for `BinarySource` discriminated union.
     */
    export const enum Type { ExplicitPath, GithubRelease }

    export interface ExplicitPath {
        type: Type.ExplicitPath;

        /**
         * Filesystem path to the binary specified by the user explicitly.
         */
        path: string;
    }

    export interface GithubRelease {
        type: Type.GithubRelease;

        /**
         * Repository where the binary is stored.
         */
        repo: GithubRepo;

        /**
         * Directory on the filesystem where the bundled binary is stored.
         */
        dir: string;

        /**
         * Name of the binary file. It is stored under the same name on GitHub releases
         * and in local `.dir`.
         */
        file: string;

        /**
         * Tag of github release that denotes a version required by this extension.
         */
        version: string;

        /**
         * Object that provides `get()/update()` operations to store metadata
         * about the actual binary, e.g. its actual version.
         */
        storage: vscode.Memento;
    }

}