funcraft-api-v3 0.0.1-security → 3.0.2

package/types/index.d.ts

@@ -0,0 +1,249 @@
+export type StatsResponse = {
+    code: number;
+    error: string;
+    userId: string;
+    username: string;
+    month: number;
+    monthName: string;
+    game: string;
+    rank: number;
+    skin?: string;
+    data: {
+        points: number;
+        gameCount: number;
+        winCount: number;
+        defeatCount: number;
+        gameTime: number;
+        kills: number;
+        deathCount: number;
+    };
+    stats: {
+        winrate: number;
+        kd: number;
+        ragequit?: number;
+        killsPerGame: number;
+        deathsPerGame: number;
+        pointsPerGame: number;
+        timePerGame?: number;
+        killsPerMinute?: number;
+        secondsPerKill?: number;
+        bedsPerGame?: number;
+        nexusPerGame?: number;
+        damagePerGame?: number;
+    };
+};
+export type InfosResponse = {
+    code: number;
+    error: string;
+    grade: string;
+    username: string;
+    userId: string;
+    skin: string;
+    inscription: Date;
+    lastConnection: Date;
+    gloires: number;
+    gameCount: number;
+    points: number;
+    winCount: number;
+    defeatCount: number;
+    gameTime: number;
+    kills: number;
+    deathCount: number;
+    friends?: {
+        nom: string;
+        skin: string;
+    }[];
+    ban: ("TEMP" | "DEF" | "NONE");
+};
+export type AllStatsResponse = {
+    [game: string]: string | number | {
+        [period: string]: StatsResponse;
+        always?: StatsResponse;
+    } | {
+        username: string;
+        skin: string;
+        userId: string;
+    };
+    code: number;
+    error: string;
+    infos: {
+        username: string;
+        skin: string;
+        userId: string;
+    };
+};
+/**
+ * @typedef {{
+ *   code: number,
+ *   error: string,
+ *   userId: string,
+ *   username: string,
+ *   month: number,
+ *   monthName: string,
+ *   game: string,
+ *   rank: number,
+ *   skin?: string,
+ *   data: {
+ *     points: number,
+ *     gameCount: number,
+ *     winCount: number,
+ *     defeatCount: number,
+ *     gameTime: number,
+ *     kills: number,
+ *     deathCount: number
+ *   },
+ *   stats: {
+ *     winrate: number,
+ *     kd: number,
+ *     ragequit?: number,
+ *     killsPerGame: number,
+ *     deathsPerGame: number,
+ *     pointsPerGame: number,
+ *     timePerGame?: number,
+ *     killsPerMinute?: number,
+ *     secondsPerKill?: number,
+ *     bedsPerGame?: number,
+ *     nexusPerGame?: number,
+ *     damagePerGame?: number
+ *   }
+ * }} StatsResponse
+ */
+/**
+ * @typedef {{
+ *   code: number,
+ *   error: string,
+ *   grade: string,
+ *   username: string,
+ *   userId: string,
+ *   skin: string,
+ *   inscription: Date,
+ *   lastConnection: Date,
+ *   gloires: number,
+ *   gameCount: number,
+ *   points: number,
+ *   winCount: number,
+ *   defeatCount: number,
+ *   gameTime: number,
+ *   kills: number,
+ *   deathCount: number,
+ *   friends?:  {
+ *     nom: string,
+ *     skin: string
+ *   }[],
+ *   ban: ("TEMP"|"DEF"|"NONE")
+ * }} InfosResponse
+ */
+/**
+ * @typedef {{
+ *   code: number,
+ *   error: string,
+ *   infos: {
+ *     username: string,
+ *     skin: string,
+ *     userId: string
+ *   },
+ *   [game: string]: (
+ *     number | string | {
+ *       [period: string]: StatsResponse
+ *       always?: StatsResponse
+ *     } | {
+ *       username: string,
+ *       skin: string,
+ *       userId: string
+ *     }
+ *   )
+ * }} AllStatsResponse
+ */
+/**
+ * Get stats for a player, for a game in a specific period
+ * @param {string} period
+ * @param {string} game
+ * @param {string} username
+ * @returns {Promise<StatsResponse>}
+ */
+export function stats(period: string, game: string, username: string): Promise<StatsResponse>;
+/**
+ * Get all stats of a player
+ * @param {string} username
+ * @returns {Promise<AllStatsResponse>}
+ */
+export function allStats(username: string): Promise<AllStatsResponse>;
+/**
+ * Get infos about a player
+ * @param {string} username
+ * @returns {Promise<InfosResponse>}
+ */
+export function infos(username: string, fetchFriends?: boolean): Promise<InfosResponse>;
+/**
+ * Get friends from a player id
+ * @param {string} userId
+ * @returns {Promise<{
+ *   code: number,
+ *   error: string,
+ *   friends: {
+ *     nom: string,
+ *     skin: string
+ *   }[]
+ * }>}
+ */
+export function friends(userId: string): Promise<{
+    code: number;
+    error: string;
+    friends: {
+        nom: string;
+        skin: string;
+    }[];
+}>;
+/**
+ * Get head of a player
+ * @param {string} username
+ * @returns {Promise<string>}
+ */
+export function head(username: string): Promise<string>;
+/**
+ * Get stats table of a game
+ * @param {string} period
+ * @param {string} game
+ * @returns {Promise<StatsResponse[]>}
+ */
+export function table(period: string, game: string): Promise<StatsResponse[]>;
+/**
+ * Compute some stats properties
+ * @param {StatsResponse} stats
+ * @param {boolean} onlyHat
+ * @param {boolean} data
+ * @returns {StatsResponse}
+ */
+export function computeStats(stats: StatsResponse, onlyHat?: boolean, data?: boolean): StatsResponse;
+import parsers = require("./parsers");
+import errors = require("./errors");
+import utils = require("./utils");
+export const data: {
+    games: string[];
+    months: string[];
+    gameAliases: {
+        infecte: string;
+        shoot: string;
+        land: string;
+        mma: string;
+        pvp: string;
+        hika: string;
+        sky: string;
+        rush: string;
+    };
+    monthAliases: {
+        janvier: string;
+        fevrier: string;
+        mars: string;
+        avril: string;
+        mai: string;
+        juin: string;
+        juillet: string;
+        aout: string;
+        septembre: string;
+        octobre: string;
+        novembre: string;
+        decembre: string;
+    };
+};
+export { parsers, errors, utils };

package/types/parsers.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Get stats from html body
+ * @param {string} body
+ * @param {string} href
+ * @param {{ username: string, monthDiff: number, numGame: number, month: number }} data
+ * @returns {import('./').StatsResponse}
+ */
+export function stats(body: string, href: string, { username, monthDiff, numGame, month }: {
+    username: string;
+    monthDiff: number;
+    numGame: number;
+    month: number;
+}): import('./').StatsResponse;
+/**
+ * Get all stats from html body
+ * @param {string} body
+ * @param {string} href
+ * @param {{ username: string }} data
+ * @returns {import('./').AllStatsResponse}
+ */
+export function allStats(body: string, href: string, { username }: {
+    username: string;
+}): import('./').AllStatsResponse;
+/**
+ * Get infos from html body
+ * @param {string} body
+ * @param {string} href
+ * @param {{ username: string }} data
+ * @returns {import('./').InfosResponse}
+ */
+export function infos(body: string, href: string, { username }: {
+    username: string;
+}): import('./').InfosResponse;
+/**
+ * Get friends from html body
+ * @param {string} body
+ * @returns {{
+ *   code: number,
+ *   error: string,
+ *   friends: {
+ *     nom: string,
+ *     skin: string
+ *   }[]
+ * }}
+ */
+export function friends(body: string): {
+    code: number;
+    error: string;
+    friends: {
+        nom: string;
+        skin: string;
+    }[];
+};
+/**
+ * Get stats table from html body
+ * @param {string} body
+ * @param {{ period: string, game: string }} data
+ * @returns {{
+ *   code: number,
+ *   error: string,
+ *   table: import('./').StatsResponse[]
+ * }}
+ */
+export function table(body: string, { period, game }: {
+    period: string;
+    game: string;
+}): {
+    code: number;
+    error: string;
+    table: import('./').StatsResponse[];
+};
+/**
+ * Get head fril html body
+ * @param {string} body
+ * @param {{ username: string }} data
+ * @returns {{
+ *   code: number,
+ *   error: string,
+ *   head: string
+ * }}
+ */
+export function head(body: string, { username }: {
+    username: string;
+}): {
+    code: number;
+    error: string;
+    head: string;
+};
+/**
+ *
+ * @param {object} stats
+ * @param {object} datas
+ * @param {number} month
+ * @param {number} numGame
+ * @returns {object}
+ */
+export function statsFromData(stats: object, datas: object, month: number, numGame: number): object;

package/types/utils.d.ts

@@ -0,0 +1,86 @@
+declare const games: string[];
+declare const months: string[];
+declare namespace gameAliases {
+    const infecte: string;
+    const shoot: string;
+    const land: string;
+    const mma: string;
+    const pvp: string;
+    const hika: string;
+    const sky: string;
+    const rush: string;
+}
+declare namespace monthAliases {
+    const janvier: string;
+    const fevrier: string;
+    const mars: string;
+    const avril: string;
+    const mai: string;
+    const juin: string;
+    const juillet: string;
+    const aout: string;
+    const septembre: string;
+    const octobre: string;
+    const novembre: string;
+    const decembre: string;
+}
+/**
+ * Round a number with a decimal count
+ * @param {string} number
+ * @param {number} decimalCount
+ * @returns {number}
+ */
+export function Round(number: string, decimalCount?: number): number;
+/**
+ * Parse a FunCraft number field
+ * @param {string} value
+ * @returns {number}
+ */
+export function parseFCInt(value: string): number;
+/**
+ * Remove all accents from a string
+ * @param {string} string
+ * @returns {string}
+ */
+export function removeAccents(string: string): string;
+/**
+ * Parse a FunCraft date
+ * @param {string} value
+ * @param {string} utc
+ * @returns {Date}
+ */
+export function parseFCDate(value: string, utc?: string): Date;
+/**
+ * @param {string} period
+ * @returns {number}
+ */
+export function getMonth(period: string): number;
+/**
+ * @param {string} month
+ * @returns {number}
+ */
+export function parseMonth(month: string): number;
+/**
+ * @param {string} game
+ * @returns {string}
+ */
+export function getGame(game: string): string;
+/**
+ * Determine whether a string is a valid period
+ * @param {string} period
+ * @returns {string}
+ */
+export function vGetPeriod(period: string, strict?: boolean): string;
+/**
+ * Determine whether a string is a valid game
+ * @param {string} game
+ * @returns {string}
+ */
+export function vGetGame(game: string): string;
+export declare namespace data {
+    export { games };
+    export { months };
+    export { gameAliases };
+    export { monthAliases };
+}
+export {};

package/utils.js

@@ -0,0 +1,178 @@
+const games = ['rush_mdt', 'hikabrain', 'skywars', 'octogone', 'shootcraft', 'infected', 'blitz', 'pvpsmash', 'survival', 'rush_retro', 'landrush'];
+const months = ['january', 'february', 'march', 'april', 'may', 'june', 'july', 'august', 'september', 'october', 'november', 'december'];
+const gameAliases = {
+	"infecte": "infected",
+	"shoot": "shootcraft",
+	"land": "landrush",
+	"mma": "octogone",
+	"pvp": "pvpsmash",
+	"hika": "hikabrain",
+	"sky": "skywars",
+	"rush": "rush_mdt"
+};
+const monthAliases = {
+	'janvier': 'january',
+	'fevrier': 'february',
+	'mars': 'march',
+	'avril': 'april',
+	'mai': 'may',
+	'juin': 'june',
+	'juillet': 'july',
+	'aout': 'august',
+	'septembre': 'september',
+	'octobre': 'october',
+	'novembre': 'november',
+	'decembre': 'december'
+};
+
+/**
+ * Round a number with a decimal count
+ * @param {string} number 
+ * @param {number} decimalCount 
+ * @returns {number}
+ */
+function Round(number, decimalCount = 0) {
+	return Math.round(number * Math.pow(10, decimalCount)) / Math.pow(10, decimalCount);
+}
+
+/**
+ * Parse a FunCraft number field
+ * @param {string} value 
+ * @returns {number}
+ */
+function parseFCInt(value) {
+	if (value.trim().replace(/\s+/ig, "") === "" || Number.isNaN(parseInt(value, 10)))
+		return 0;
+	else
+		return parseInt(value, 10);
+}
+
+/**
+ * Remove all accents from a string
+ * @param {string} string 
+ * @returns {string}
+ */
+function removeAccents(string) {
+	return string.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
+}
+
+/**
+ * Parse a FunCraft date
+ * @param {string} value 
+ * @param {string} utc 
+ * @returns {Date}
+ */
+function parseFCDate(value, utc = 'UTC+01') {
+	const monthAliases = {
+		'janvier': 'Jan',
+		'fevrier': 'Feb',
+		'mars': 'Mar',
+		'avril': 'Apr',
+		'mai': 'May',
+		'juin': 'Jun',
+		'juillet': 'Jul',
+		'aout': 'Aug',
+		'septembre': 'Sep',
+		'octobre': 'Oct',
+		'novembre': 'Nov',
+		'decembre': 'Dec'
+	};
+	value = removeAccents(value).replace(/, (\d{2})h(\d{2})$/, ' $1:$2:00 ' + utc);
+	for (let month of Object.keys(monthAliases)) {
+		value = value.replace(month, monthAliases[month]);
+	}
+	return new Date(value);
+}
+
+
+/**
+ * @param {string} period 
+ * @returns {number}
+ */
+function getMonth(period) {
+	if (period.match(/^\d+$/) && parseInt(period) <= 12 && parseInt(period) >= 0)
+		return parseInt(period);
+	if (months.includes(period))
+		return months.indexOf(period) + 1;
+	if (Object.keys(monthAliases).includes(period))
+		return months.indexOf(monthAliases[period]) + 1;
+	if (period === "month" || period === "mois")
+		return (new Date()).getMonth() + 1;
+	if (period === "always" || period === "toujours")
+		return 0;
+}
+/**
+ * @param {string} month 
+ * @returns {number}
+ */
+function parseMonth(month) {
+	if (month === undefined)
+		return;
+	else if (month === 0)
+		return 0;
+	let numMonth = (new Date()).getMonth() + 1 - month;
+	if (numMonth < 0)
+		numMonth = 12 + numMonth;
+	return numMonth + 1;
+}
+/**
+ * @param {string} game 
+ * @returns {string}
+ */
+function getGame(game) {
+	game = game.replace(/[\s-]+/g, '_');
+	if (Object.keys(gameAliases).includes(game))
+		game = gameAliases[game];
+	if (games.includes(game))
+		return games.indexOf(game);
+}
+
+
+/**
+ * Determine whether a string is a valid period
+ * @param {string} period 
+ * @returns {string}
+ */
+function vGetPeriod(period, strict = false) {
+	let p;
+	if (strict)
+		p = parseMonth(getMonth(period.trim().toLowerCase().normalize("NFD").replace(/[\u0300-\u036f]/g, "")));
+	else
+		p = getMonth(period.trim().toLowerCase().normalize("NFD").replace(/[\u0300-\u036f]/g, ""));
+	if (p !== undefined) {
+		if (p === 0)
+			p = "always";
+		else
+			p = months[p - 1];
+	}
+	return p;
+}
+/**
+ * Determine whether a string is a valid game
+ * @param {string} game 
+ * @returns {string}
+ */
+function vGetGame(game) {
+	let m = getGame(game.trim().toLowerCase().normalize("NFD").replace(/[\u0300-\u036f]/g, ""));
+	if (m !== undefined)
+		m = games[m];
+	return m;
+}
+
+module.exports = {
+	data: {
+		games,
+		months,
+		gameAliases,
+		monthAliases
+	},
+	Round,
+	parseFCInt,
+	removeAccents,
+	parseFCDate,
+	getMonth,
+	parseMonth,
+	getGame,
+	vGetPeriod,
+	vGetGame
+};