"use strict"; // Modules from file import shared from "./scripts/shared.js"; import { authenticate, urlExists, isF95URL } from "./scripts/network-helper.js"; import { getGameInfo } from "./scripts/scraper.js"; import { searchGame, searchMod } from "./scripts/searcher.js"; import { getUserData as retrieveUserData } from "./scripts/user-scraper.js"; import { fetchLatest } from "./scripts/latest-fetch.js"; const fetchPlatformData = require("./scripts/platform-data.js").fetchPlatformData; // Classes from file import Credentials from "./scripts/classes/credentials.js"; import GameInfo from "./scripts/classes/game-info.js"; import LoginResult from "./scripts/classes/login-result.js"; import UserData from "./scripts/classes/user-data.js"; import PrefixParser from "./scripts/classes/prefix-parser.js"; //#region Global variables const USER_NOT_LOGGED = "User not authenticated, unable to continue"; //#endregion //#region Export classes module.exports.GameInfo = GameInfo; module.exports.LoginResult = LoginResult; module.exports.UserData = UserData; module.exports.PrefixParser = PrefixParser; //#endregion Export classes //#region Export properties /** * @public * Set the logger level for module debugging. */ /* istambul ignore next */ module.exports.loggerLevel = shared.logger.level; exports.loggerLevel = "warn"; // By default log only the warn messages /** * Indicates whether a user is logged in to the F95Zone platform or not. */ export function isLogged(): boolean { return shared.isLogged; }; //#endregion Export properties //#region Export methods /** * Log in to the F95Zone platform. * This **must** be the first operation performed before accessing any other script functions. * @returns {Promise} Result of the operation */ export async function login(username: string, password: string): Promise { /* istanbul ignore next */ if (shared.isLogged) { shared.logger.info(`${username} already authenticated`); return new LoginResult(true, `${username} already authenticated`); } shared.logger.trace("Fetching token..."); const creds = new Credentials(username, password); await creds.fetchToken(); shared.logger.trace(`Authentication for ${username}`); const result = await authenticate(creds); shared.setIsLogged(result.success); // Load platform data if (result.success) await fetchPlatformData(); /* istambul ignore next */ if (result.success) shared.logger.info("User logged in through the platform"); else shared.logger.warn(`Error during authentication: ${result.message}`); return result; }; /** * Chek if exists a new version of the game. * You **must** be logged in to the portal before calling this method. * @param {GameInfo} info Information about the game to get the version for * @returns {Promise} true if an update is available, false otherwise */ export async function checkIfGameHasUpdate(info: GameInfo): Promise { /* istanbul ignore next */ if (!shared.isLogged) { shared.logger.warn(USER_NOT_LOGGED); return false; } // F95 change URL at every game update, // so if the URL is different an update is available const exists = await urlExists(info.url, true); if (!exists) return true; // Parse version from title const onlineInfo = await getGameInfo(info.url); const onlineVersion = onlineInfo.version; // Compare the versions return onlineVersion.toUpperCase() !== info.version.toUpperCase(); }; /** * Starting from the name, it gets all the information about the game you are looking for. * You **must** be logged in to the portal before calling this method. * @param {String} name Name of the game searched * @param {Boolean} mod Indicate if you are looking for mods or games * @returns {Promise} List of information obtained where each item corresponds to * an identified game (in the case of homonymy of titles) */ export async function getGameData (name: string, mod: boolean): Promise { /* istanbul ignore next */ if (!shared.isLogged) { shared.logger.warn(USER_NOT_LOGGED); return null; } // Gets the search results of the game/mod being searched for const urls = mod ? await searchMod(name) : await searchGame(name); // Process previous partial results const results = []; for (const url of urls) { // Start looking for information const info = await getGameInfo(url); if (info) results.push(info); } return results; }; /** * Starting from the url, it gets all the information about the game you are looking for. * You **must** be logged in to the portal before calling this method. * @param {String} url URL of the game to obtain information of * @returns {Promise} Information about the game. If no game was found, null is returned */ export async function getGameDataFromURL(url: string): Promise { /* istanbul ignore next */ if (!shared.isLogged) { shared.logger.warn(USER_NOT_LOGGED); return null; } // Check URL validity const exists = await urlExists(url); if (!exists) throw new URIError(`${url} is not a valid URL`); if (!isF95URL(url)) throw new Error(`${url} is not a valid F95Zone URL`); // Get game data return await getGameInfo(url); }; /** * Gets the data of the currently logged in user. * You **must** be logged in to the portal before calling this method. * @returns {Promise} Data of the user currently logged in */ export async function getUserData(): Promise { /* istanbul ignore next */ if (!shared.isLogged) { shared.logger.warn(USER_NOT_LOGGED); return null; } return await retrieveUserData(); }; /** * Gets the latest updated games that match the specified parameters. * You **must** be logged in to the portal before calling this method. * @param {Object} args * Parameters used for the search. * @param {String[]} [args.tags] * List of tags to be included in the search (max 5). * @param {Number} [args.datelimit] * Number of days since the game was last updated. * The entered value will be approximated to the nearest valid one. * Use `0` to select no time limit. * @param {String[]} [args.prefixes] * Prefixes to be included in the search. * @param {String} [args.sorting] * Method of sorting the results between (default: `date`): * `date`, `likes`, `views`, `name`, `rating` * @param {Number} limit Maximum number of results * @returns {Promise} List of games */ export async function getLatestUpdates(args, limit: number): Promise { // Check limit value if(limit <= 0) throw new Error("limit must be greater than 0"); // Prepare the parser const parser = new PrefixParser(); // Get the closest date limit let filterDate = 0; if(args.datelimit) { const validDate = [365, 180, 90, 30, 14, 7, 3, 1, 0]; filterDate = getNearestValueFromArray(validDate, args.datelimit); } // Fetch the games const query = { tags: args.tags ? parser.prefixesToIDs(args.tags) : [], prefixes: args.prefixes ? parser.prefixesToIDs(args.prefixes) : [], sort: args.sorting ? args.sorting : "date", date: filterDate, }; const urls = await fetchLatest(query, limit); // Get the gamedata from urls const promiseList = urls.map((u: string) => exports.getGameDataFromURL(u)); return await Promise.all(promiseList); }; //#endregion //#region Private Methods /** * Given an array of numbers, get the nearest value for a given `value`. * @param {Number[]} array List of default values * @param {Number} value Value to search */ function getNearestValueFromArray(array: number[], value: number) { // Script taken from: // https://www.gavsblog.com/blog/find-closest-number-in-array-javascript array.sort((a, b) => { return Math.abs(value - a) - Math.abs(value - b); }); return array[0]; } //#endregion