Merge branch 'release/v2.1.0'

Author: MatthewSH

README.md

@@ -39,4 +39,4 @@ api.getDataUsage()
 ```
 
 ## Documentation / Methods
-You can view all the available methods and documentation on the [PaladinsDev website](https://paladins.dev/docs/paladins.js/v/2.0.0/).
+You can view all the available methods and documentation on the [PaladinsDev website](https://paladins.dev/docs/paladins.js/v/2.1.0/).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "paladins.js",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A JavaScript package to help make communication with the Paladins API from Hi-Rez/Evil Mojo easier.",
   "keywords": [
     "paladins",
@@ -15,7 +15,7 @@
   "scripts": {
     "test": "jest",
     "compile": "./node_modules/.bin/tsc",
-    "docs": "node_modules/.bin/typedoc --theme node_modules/typedoc-clarity-theme/bin --out ./docs ./src",
+    "docs": "node_modules/.bin/typedoc --options ./typedoc.json",
     "prepublish": "npm run compile"
   },
   "repository": {
@@ -50,10 +50,10 @@
     "@types/request": "^2.48.4",
     "@types/request-promise": "^4.1.46",
     "cross-env": "^7.0.2",
+    "eledoc": "^0.2.1",
     "jest": "^25.2.7",
     "ts-jest": "^25.3.1",
-    "typedoc": "^0.14.2",
-    "typedoc-clarity-theme": "^1.1.0",
+    "typedoc": "^0.17.4",
     "typescript": "^3.2.4"
   }
 }

src/api.ts

@@ -7,12 +7,15 @@ import md5 from 'md5';
 import rp from 'request-promise';
 import sr from 'sync-request';
 import { NotFoundError, PrivateProfileError, UnauthorizedDeveloper } from './errors';
+import { Portals } from './util/enumerations';
 
 export default class API {
+    /** @ignore */
     private serviceUrl: string = 'http://api.paladins.com/paladinsapi.svc';
+    /** @ignore */
     private sessionCache: { [key: string]: any} = {};
 
-    constructor(private options: { [key: string]: any} = { }) {
+    constructor(/** @ignore */private options: { [key: string]: any} = { }) {
         this.options = Util.mergeDefaults(DefaultOptions, options);
 
         this.setupModule();
@@ -138,7 +141,10 @@ export default class API {
 
     /**
      * Get an array of players with the requested name.
+     * 
+     * Will be removed in future releases. Please use {@link API.searchPlayers} for searching.
      *
+     * @deprecated
      * @param {string} name
      * @returns {Promise<any>}
      * @memberof API
@@ -237,6 +243,18 @@ export default class API {
         return this.endpoint('getmatchhistory', [playerId]);
     }
 
+    /**
+     * Get the queue stats of a player.
+     *
+     * @param {number} playerId
+     * @param {number} queueId
+     * @returns {Promise<any>}
+     * @memberof API
+     */
+    public getPlayerQueueStats(playerId: number, queueId: number): Promise<any> {
+        return this.endpoint('getqueuestats', [playerId, null, null, null, queueId]);
+    }
+
     /**
      * Get the information for an ended match.
      *
@@ -248,6 +266,41 @@ export default class API {
         return this.endpoint('getmodedetails', [matchId]);
     }
 
+    /**
+     * Get details on multiple matches
+     *
+     * @param {number[]} matchIds
+     * @param {boolean} [returnSorted=true] Makes each match sorted in the object. If you set this to false, it may improve performance when requesting many matches but it will return everything in a single array.
+     * @returns {Promise<any>}
+     * @memberof API
+     */
+    public getMatchModeDetailsBatch(matchIds: number[], returnSorted: boolean = true): Promise<any> {
+        if (returnSorted) {
+            return new Promise((resolve, reject) => {
+                this.endpoint('getmatchdetailsbatch', [matchIds.join(',')])
+                    .then((data) => {
+                        let sorted: { [key: string]: any[] } = {}
+
+                        data.forEach((matchPlayer: any) => {
+                            if (sorted[matchPlayer['Match']]) {
+                                sorted[matchPlayer['Match']].push(matchPlayer);
+                            } else {
+                                sorted[matchPlayer['Match']] = [];
+                                sorted[matchPlayer['Match']].push(matchPlayer);
+                            }
+                        });
+
+                        return resolve(sorted);
+                    })
+                    .catch((err) => {
+                        return reject(err);
+                    })
+            })
+        } else {
+            return this.endpoint('getmatchdetailsbatch', [matchIds.join(',')]);
+        }
+    }
+
     /**
      * Get match details from an ended match.
      *
@@ -280,6 +333,35 @@ export default class API {
         return this.endpoint('getdataused', [], true);
     }
 
+    /**
+     * Do a general player search that returns more detail information on the players.
+     *
+     * @param {string} name 
+     * @param {boolean} [mapPortals=false] Map the portals to their general name. WARNING: This can severely affect performance if you are doing generic names because of Switch results.
+     * @returns {Promise<any>}
+     * @memberof API
+     */
+    public searchPlayers(name: string, mapPortals: boolean = false): Promise<any> {
+        if (mapPortals) {
+            return new Promise((resolve, reject) => {
+                this.endpoint('searchplayers', [name])
+                    .then((data) => {
+                        data.forEach((player: any) => {
+                            player['portal_name'] = Portals[player['portal_id']];
+                        });
+
+                        return resolve(data);
+                    })
+                    .catch((err) => {
+                        return reject(err);
+                    })
+            })
+        } else {
+            return this.endpoint('searchplayers', [name]);
+        }
+    }
+
+    /** @ignore */
     private endpoint(endpoint: string, args: Array<any>, returnFirstElement: boolean = false): Promise<any> {
         let fArgs = <any>[endpoint].concat(args);
         let url = this.buildUrl.apply(this, fArgs);
@@ -305,14 +387,17 @@ export default class API {
         })
     }
 
+    /** @ignore */
     private getTimestamp() {
         return moment().utc().format('YYYYMMDDHHmmss');
     }
 
+    /** @ignore */
     private getSignature(method: string) {
         return md5(`${this.options['devId']}${method}${this.options['authKey']}${this.getTimestamp()}`)
     }
 
+    /** @ignore */
     private setSession(): string {
         let response = sr('GET', `${this.getServiceUrl()}/createsessionJson/${this.options['devId']}/${this.getSignature('createsession')}/${this.getTimestamp()}`);
         let body = JSON.parse(response.body.toString());
@@ -332,10 +417,12 @@ export default class API {
         return this.sessionCache['sessionId'];
     }
 
+    /** @ignore */
     private saveSessionCache() {
         fs.writeFileSync(path.resolve(__dirname, 'cache', 'session.json'), JSON.stringify(this.sessionCache));
     }
 
+    /** @ignore */
     private getSession(): string {
         if (this.sessionCache['sessionId'] == undefined || this.sessionCache['sessionId'] == null || this.sessionCache['sessionId'].length < 1) {
             return this.setSession();
@@ -344,6 +431,7 @@ export default class API {
         return this.sessionCache['sessionId'];
     }
 
+    /** @ignore */
     private buildUrl(method: string, player?: any, lang?: number, matchId?: number, champId?: number, queue?: number, tier?: number, season?: number, platform?: number) {
         let session = this.getSession();
         let baseUrl = `${this.getServiceUrl()}/${method}Json/${this.options['devId']}/${this.getSignature(method)}/${session}/${this.getTimestamp()}`;
@@ -383,12 +471,14 @@ export default class API {
         return baseUrl;
     }
 
+    /** @ignore */
     private makeRequest(url: string) {
         return rp(url).then((r: any) => {
             return r;
         });
     }
 
+    /** @ignore */
     private setupModule() {
         try {
             let data = fs.readFileSync(path.resolve(__dirname, 'cache', 'session.json'));

src/paladins.ts

@@ -1,3 +1,4 @@
+/** @ignore *//** */
 import API from './api';
 
 export default API;

src/util/enumerations.ts

@@ -0,0 +1,79 @@
+export enum Portals {
+    Unknown = 0,
+    HiRez = 1,
+    Steam = 5,
+    Epic = 28,
+    PSN = 9,
+    XboxLive = 10,
+    Nintendo = 22,
+    Discord = 25,
+    Mixer = 14,
+    Facebook = 12,
+    Google = 13
+}
+
+export enum Languages {
+    English = 1,
+    German = 2,
+    French = 3,
+    Chinese = 5,
+    Spanish = 9,
+    Portuguese = 10,
+    Russian = 11,
+    Polish = 12,
+    Turkish = 13
+}
+
+export enum Ranks {
+    Qualifying = 0,
+    Bronze_V = 1,
+    Bronze_IV = 2,
+    Bronze_III = 3,
+    Bronze_II = 4,
+    Bronze_I = 5,
+    Silver_V = 6,
+    Silver_IV = 7,
+    Silver_III = 8,
+    Silver_II = 9,
+    Silver_I = 10,
+    Gold_V = 11,
+    Gold_IV = 12,
+    Gold_III = 13,
+    Gold_II = 14,
+    Gold_I = 15,
+    Platinum_V = 16,
+    Platinum_IV = 17,
+    Platinum_III = 18,
+    Platinum_II = 19,
+    Platinum_I = 20,
+    Diamond_V = 21,
+    Diamond_IV = 22,
+    Diamond_III = 23,
+    Diamond_II = 24,
+    Diamond_I = 25,
+    Master = 26,
+    Grandmaster = 27
+}
+
+export enum ProfileStates {
+    Offline = 0,
+    In_Lobby = 1,
+    Champion_Selection = 2,
+    In_Match = 3,
+    Online = 4,
+    Unknown = 5
+}
+
+export enum Queue {
+    Unknown = 0,
+    Casual_Siege = 424,
+    Team_Deathmatch = 469,
+    Onslaught = 452,
+    Ranked_Keyboard = 486,
+    Ranked_Controller = 428,
+    Shooting_Range = 434,
+    Training_Siege = 425,
+    Training_Team_Deathmatch = 470,
+    Training_Onslaught = 453,
+    Test_Maps = 445
+}

src/util/util.ts

@@ -1,3 +1,4 @@
+/** @ignore *//** */
 const has = (o: any, k: any) => Object.prototype.hasOwnProperty.call(o, k);
 
 export default class Util {

typedoc.json

@@ -0,0 +1,9 @@
+{
+    "name": "PaladinsJS",
+    "inputFiles": ["./src"],
+    "exclude": ["**/*+(index|.spec|.e2e).ts"],
+    "mode": "modules",
+    "out": "docs",
+    "theme": "default",
+    "includeVersion": true
+}