Client.js

  1. const fetch = require('node-fetch');
  2. const Package = require('../package.json');
  4. const Account = require('./Account');
  5. const Match = require('./Match').Match;
  6. const StoreItem = require('./StoreItem');
  7. const Challenges = require('./Challenges');
  9. /**
  10.  * The client for interacting with the Fortnite Tracker API
  11.  * @class Client
  12.  * @param {string} key Fortnite Tracker API token
  13.  */
  14. class Client {
  15.     constructor(key) {
  17.         if (!key) {
  18.             throw new Error('No API key passed.');
  19.         }
  21.         this.key = key;
  23.         this.headers = {
  24.             'User-Agent': `fortnite.js v${Package.version} (${Package.homepage})`,
  25.             'TRN-Api-Key': this.key
  26.         };
  28.         this.rateLimit = {
  29.             limit: 30,
  30.             remaining: 30
  31.         };
  33.     }
  35.     /**
  36.      * Makes the request to the API
  37.      * @private
  38.      * @param {string} link URL endpoint of API
  39.      * @returns {Promise<Object>}
  40.      * @memberof Client
  41.      */
  42.     _request(link) {
  43.         return fetch(link, { headers: this.headers })
  44.             .then(r => {
  45.                 this.rateLimit = {
  46.                     limit: Number(r.headers.get('x-ratelimit-limit-minute')),
  47.                     remaining: Number(r.headers.get('x-ratelimit-remaining-minute'))
  48.                 };
  50.                 if (!r.ok) return Promise.reject(r.statusText);
  52.                 return r.json();
  53.             })
  54.             .catch(e => Promise.reject(`HTTP ${e}`));
  55.     }
  57.     /**
  58.      * Get user info
  59.      * @param {string} username username of the user to search for
  60.      * @param {string=} [platform='pc'] platform to search for user in (pc, xbl, or psn)
  61.      * @param {boolean=} [raw=false] whether to return raw response from API
  62.      * @returns {(Promise<Account>|Promise<Object>)}
  63.      * @memberof Client
  64.      */
  65.     get(username, platform = 'pc', raw = false) {
  66.         return this._request(`https://api.fortnitetracker.com/v1/profile/${platform}/${encodeURI(username)}`)
  67.             .then(r => r.error ? Promise.reject(r) : r)
  68.             .then(r => raw ? r : new Account(r))
  69.             .catch(e => Promise.reject(e));
  70.     }
  72.     /**
  73.      * Get user's matches
  74.      * @param {string} accountId user's account ID found in user info
  75.      * @param {boolean=} [raw=false] whether to return raw response from API
  76.      * @returns {(Promise<Array<Match>>|Promise<Array<Object>>)}
  77.      * @memberof Client
  78.      */
  79.     getMatches(accountId, raw = false) {
  80.         return this._request(`https://api.fortnitetracker.com/v1/profile/account/${accountId}/matches`)
  81.             .then(r => r.error ? Promise.reject(r.error) : r)
  82.             .then(r => raw ? r : r.map(m => new Match(m)))
  83.             .catch(e => Promise.reject(e));
  84.     }
  86.     /**
  87.      * Get current store items
  88.      * @param {boolean=} [raw=false] whether to return raw response from API
  89.      * @returns {Promise<Array<StoreItem>>|Promise<Array<Object>>}
  90.      * @memberof Client
  91.      */
  92.     getStore(raw = false) {
  93.         return this._request('https://api.fortnitetracker.com/v1/store')
  94.             .then(r => r.error ? Promise.reject(r.error) : r)
  95.             .then(r => raw ? r : r.map(item => new StoreItem(item)))
  96.             .catch(e => Promise.reject(e));
  97.     }
  99.     /**
  100.      * Get currently weekly challenges
  101.      * @param {boolean=} [raw=false] whether to return raw response from API
  102.      * @returns {(Promise<Challenges>|Promise<Object>)}
  103.      * @memberof Client
  104.      */
  105.     getChallenges(raw = false) {
  106.         return this._request('https://api.fortnitetracker.com/v1/challenges')
  107.             .then(r => r.error ? Promise.reject(r.error) : r)
  108.             .then(r => raw ? r : new Challenges(r))
  109.             .catch(e => Promise.reject(e));
  110.     }
  111. }
  113. module.exports = Client;