Source: Utils/Functions/Net/GithubReleases/script.js

  1. const Downloader = include("utils.functions.net.download");
  2. const Resource = include("utils.functions.net.resource");
  3. const { createTempDir, remove, cat } = include("utils.functions.filesystem.files");
  5. /**
  6.  * A dedicated class used for accessing and downloading releases hosted on GitHub
  7.  */
  8. module.GitHubReleaseDownloader = class GitHubReleaseDownloader {
  9.     /**
  10.      * Constructor
  11.      *
  12.      * @param {string} repositoryOwner The owner of the GitHub repository
  13.      * @param {string} repositoryName The name of the GitHub repository
  14.      * @param {SetupWizard} wizard The setup wizard
  15.      */
  16.     constructor(repositoryOwner, repositoryName, wizard) {
  17.         this.repositoryOwner = repositoryOwner;
  18.         this.repositoryName = repositoryName;
  19.         this.wizard = wizard;
  21.         this.versions = this.fetchReleases();
  22.     }
  24.     /**
  25.      * Fetches the GitHub releases
  26.      *
  27.      * @returns {object[]} The downloaded versions json array
  28.      */
  29.     fetchReleases() {
  30.         const tmpDir = createTempDir();
  32.         const releasesFile = new Downloader()
  33.             .wizard(this.wizard)
  34.             .url(`https://api.github.com/repos/${this.repositoryOwner}/${this.repositoryName}/releases`)
  35.             .message(tr("Fetching versions list..."))
  36.             .to(tmpDir + "/releases.json")
  37.             .get();
  39.         const versions = JSON.parse(cat(releasesFile));
  41.         remove(tmpDir);
  43.         return versions;
  44.     }
  46.     /**
  47.      * Fetches the tags belonging to the releases for the given GitHub repository
  48.      *
  49.      * @returns {string[]} An array containing the tags for the GitHub releases
  50.      */
  51.     getReleases() {
  52.         return this.versions.map(version => version.tag_name);
  53.     }
  55.     /**
  56.      * Fetches the tag belonging to the latest release for the given GitHub repository
  57.      *
  58.      * @returns {string} The tag belonging to the latest release
  59.      */
  60.     getLatestRelease() {
  61.         return this.versions[0].tag_name;
  62.     }
  64.     /**
  65.      * Downloads all assets that belong to the release with the given tag that match a given regex
  66.      *
  67.      * @param {string} tag The tag name of the release
  68.      * @param {RegExp} assetRegex An optional regex describing the desired asset(s)
  69.      * @returns {string[]} An array of paths leading to the downloaded files
  70.      */
  71.     download(tag, assetRegex) {
  72.         const version = this.versions.find(version => version.tag_name === tag);
  74.         return version.assets
  75.             .filter(asset => !assetRegex || asset.name.match(assetRegex))
  76.             .map(asset =>
  77.                 new Resource()
  78.                     .wizard(this.wizard)
  79.                     .url(asset.browser_download_url)
  80.                     .name(asset.name)
  81.                     .get()
  82.             );
  83.     }
  84. };