osrs-json-hiscores 2.14.1 → 2.15.0

package/lib/utils/helpers.js

@@ -1,119 +1,119 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateRSN = exports.httpGet = exports.rsnFromElement = exports.numberFromElement = exports.getActivityPageURL = exports.getSkillPageURL = exports.getPlayerTableURL = exports.getStatsURL = void 0;
-var axios_1 = require("axios");
-var ua = require("useragent-generator");
-var constants_1 = require("./constants");
-/**
- * Will generate a stats URL for the official OSRS API.
- *
- * @param gamemode Gamemode to fetch ranks for.
- * @param rsn Username of the player.
- * @returns Encoded stats URL.
- */
-var getStatsURL = function (gamemode, rsn) {
-    return "" + constants_1.GAMEMODE_URL[gamemode] + constants_1.STATS_URL + encodeURIComponent(rsn);
-};
-exports.getStatsURL = getStatsURL;
-/**
- * Will generate a player table URL for the official OSRS hiscores website.
- *
- * @param gamemode Gamemode to fetch ranks for.
- * @param rsn Username of the player.
- * @returns Encoded player table URL.
- */
-var getPlayerTableURL = function (gamemode, rsn) {
-    return "" + constants_1.GAMEMODE_URL[gamemode] + constants_1.SCORES_URL + "table=0&user=" + encodeURIComponent(rsn);
-};
-exports.getPlayerTableURL = getPlayerTableURL;
-/**
- * Will generate a skill table URL for the official OSRS hiscores website.
- *
- * @param gamemode Gamemode to fetch ranks for.
- * @param skill Skill to fetch ranks for.
- * @param page Page number.
- * @returns
- */
-var getSkillPageURL = function (gamemode, skill, page) {
-    return "" + constants_1.GAMEMODE_URL[gamemode] + constants_1.SCORES_URL + "table=" + constants_1.SKILLS.indexOf(skill) + "&page=" + page;
-};
-exports.getSkillPageURL = getSkillPageURL;
-/**
- * Will generate an activity table URL for the official OSRS hiscores website.
- *
- * @param gamemode Gamemode to fetch ranks for.
- * @param activity Activity or boss to fetch ranks for.
- * @param page Page number.
- * @returns
- */
-var getActivityPageURL = function (gamemode, activity, page) {
-    return "" + constants_1.GAMEMODE_URL[gamemode] + constants_1.SCORES_URL + "category_type=1&table=" + constants_1.ACTIVITIES.indexOf(activity) + "&page=" + page;
-};
-exports.getActivityPageURL = getActivityPageURL;
-/**
- * Extracts a number from an OSRS hiscores table cell element.
- *
- * @param el OSRS hiscores table cell element.
- * @returns Number parsed from cell text.
- */
-var numberFromElement = function (el) {
-    var _a;
-    var innerHTML = (el !== null && el !== void 0 ? el : {}).innerHTML;
-    var number = (_a = innerHTML === null || innerHTML === void 0 ? void 0 : innerHTML.replace(/[\n|,]/g, '')) !== null && _a !== void 0 ? _a : '-1';
-    return parseInt(number, 10);
-};
-exports.numberFromElement = numberFromElement;
-/**
- * Extracts a RSN from an OSRS hiscores table cell element.
- *
- * @param el OSRS hiscores table cell element.
- * @returns RSN parsed from cell text.
- */
-var rsnFromElement = function (el) {
-    var _a;
-    var innerHTML = (el !== null && el !== void 0 ? el : {}).innerHTML;
-    return (_a = innerHTML === null || innerHTML === void 0 ? void 0 : innerHTML.replace(/\uFFFD/g, ' ')) !== null && _a !== void 0 ? _a : '';
-};
-exports.rsnFromElement = rsnFromElement;
-/**
- * Will run an Axios `GET` request against a given URL after injecting a `User-Agent` header.
- *
- * @param url URL to run a `GET` request against.
- * @returns Axios response.
- */
-var httpGet = function (url, config) {
-    if (config === void 0) { config = {}; }
-    return axios_1.default.get(url, __assign({ headers: {
-            // without User-Agent header requests may be rejected by DDoS protection mechanism
-            'User-Agent': ua.firefox(80)
-        } }, config));
-};
-exports.httpGet = httpGet;
-/**
- * Validates that a provided RSN has the same username restrictions as Jagex.
- * @param rsn Username to validate.
- * @throws Error if the RSN fails validation.
- */
-var validateRSN = function (rsn) {
-    if (typeof rsn !== 'string') {
-        throw Error('RSN must be a string');
-    }
-    else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
-        throw Error('RSN contains invalid character');
-    }
-    else if (rsn.length > 12 || rsn.length < 1) {
-        throw Error('RSN must be between 1 and 12 characters');
-    }
-};
-exports.validateRSN = validateRSN;
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateRSN = exports.httpGet = exports.rsnFromElement = exports.numberFromElement = exports.getActivityPageURL = exports.getSkillPageURL = exports.getPlayerTableURL = exports.getStatsURL = void 0;
+var axios_1 = require("axios");
+var ua = require("useragent-generator");
+var constants_1 = require("./constants");
+/**
+ * Will generate a stats URL for the official OSRS API.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param rsn Username of the player.
+ * @returns Encoded stats URL.
+ */
+var getStatsURL = function (gamemode, rsn) {
+    return "".concat(constants_1.GAMEMODE_URL[gamemode]).concat(constants_1.STATS_URL).concat(encodeURIComponent(rsn));
+};
+exports.getStatsURL = getStatsURL;
+/**
+ * Will generate a player table URL for the official OSRS hiscores website.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param rsn Username of the player.
+ * @returns Encoded player table URL.
+ */
+var getPlayerTableURL = function (gamemode, rsn) {
+    return "".concat(constants_1.GAMEMODE_URL[gamemode]).concat(constants_1.SCORES_URL, "table=0&user=").concat(encodeURIComponent(rsn));
+};
+exports.getPlayerTableURL = getPlayerTableURL;
+/**
+ * Will generate a skill table URL for the official OSRS hiscores website.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param skill Skill to fetch ranks for.
+ * @param page Page number.
+ * @returns
+ */
+var getSkillPageURL = function (gamemode, skill, page) {
+    return "".concat(constants_1.GAMEMODE_URL[gamemode]).concat(constants_1.SCORES_URL, "table=").concat(constants_1.SKILLS.indexOf(skill), "&page=").concat(page);
+};
+exports.getSkillPageURL = getSkillPageURL;
+/**
+ * Will generate an activity table URL for the official OSRS hiscores website.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param activity Activity or boss to fetch ranks for.
+ * @param page Page number.
+ * @returns
+ */
+var getActivityPageURL = function (gamemode, activity, page) {
+    return "".concat(constants_1.GAMEMODE_URL[gamemode]).concat(constants_1.SCORES_URL, "category_type=1&table=").concat(constants_1.ACTIVITIES.indexOf(activity), "&page=").concat(page);
+};
+exports.getActivityPageURL = getActivityPageURL;
+/**
+ * Extracts a number from an OSRS hiscores table cell element.
+ *
+ * @param el OSRS hiscores table cell element.
+ * @returns Number parsed from cell text.
+ */
+var numberFromElement = function (el) {
+    var _a;
+    var innerHTML = (el !== null && el !== void 0 ? el : {}).innerHTML;
+    var number = (_a = innerHTML === null || innerHTML === void 0 ? void 0 : innerHTML.replace(/[\n|,]/g, '')) !== null && _a !== void 0 ? _a : '-1';
+    return parseInt(number, 10);
+};
+exports.numberFromElement = numberFromElement;
+/**
+ * Extracts a RSN from an OSRS hiscores table cell element.
+ *
+ * @param el OSRS hiscores table cell element.
+ * @returns RSN parsed from cell text.
+ */
+var rsnFromElement = function (el) {
+    var _a;
+    var innerHTML = (el !== null && el !== void 0 ? el : {}).innerHTML;
+    return (_a = innerHTML === null || innerHTML === void 0 ? void 0 : innerHTML.replace(/\uFFFD/g, ' ')) !== null && _a !== void 0 ? _a : '';
+};
+exports.rsnFromElement = rsnFromElement;
+/**
+ * Will run an Axios `GET` request against a given URL after injecting a `User-Agent` header.
+ *
+ * @param url URL to run a `GET` request against.
+ * @returns Axios response.
+ */
+var httpGet = function (url, config) {
+    if (config === void 0) { config = {}; }
+    return axios_1.default.get(url, __assign({ headers: {
+            // without User-Agent header requests may be rejected by DDoS protection mechanism
+            'User-Agent': ua.firefox(80)
+        } }, config));
+};
+exports.httpGet = httpGet;
+/**
+ * Validates that a provided RSN has the same username restrictions as Jagex.
+ * @param rsn Username to validate.
+ * @throws Error if the RSN fails validation.
+ */
+var validateRSN = function (rsn) {
+    if (typeof rsn !== 'string') {
+        throw Error('RSN must be a string');
+    }
+    else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
+        throw Error('RSN contains invalid character');
+    }
+    else if (rsn.length > 12 || rsn.length < 1) {
+        throw Error('RSN must be between 1 and 12 characters');
+    }
+};
+exports.validateRSN = validateRSN;

package/lib/utils/index.d.ts

@@ -1,2 +1,2 @@
-export * from './constants';
-export * from './helpers';
+export * from './constants';
+export * from './helpers';

package/lib/utils/index.js

@@ -1,14 +1,18 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./constants"), exports);
-__exportStar(require("./helpers"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./constants"), exports);
+__exportStar(require("./helpers"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.14.1",
+  "version": "2.15.0",
   "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -61,7 +61,8 @@
       "@typescript-eslint"
     ],
     "extends": [
-      "eslint-config-airbnb-typescript",
+      "airbnb-base",
+      "airbnb-typescript/base",
       "prettier"
     ],
     "ignorePatterns": [
@@ -72,7 +73,8 @@
     "trailingComma": "none",
     "tabWidth": 2,
     "semi": true,
-    "singleQuote": true
+    "singleQuote": true,
+    "endOfLine": "auto"
   },
   "jest": {
     "transform": {
@@ -91,27 +93,24 @@
   },
   "dependencies": {
     "axios": "^0.21.1",
-    "jsdom": "^16.3.0",
+    "jsdom": "^22.1.0",
     "useragent-generator": "^1.1.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.21",
-    "@types/jsdom": "^16.2.3",
-    "@typescript-eslint/eslint-plugin": "^4.19.0",
-    "@typescript-eslint/parser": "^4.19.0",
-    "eslint": "^7.22.0",
-    "eslint-config-airbnb-typescript": "^12.3.1",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-react": "^7.23.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
+    "@types/jest": "^29.5.3",
+    "@types/jsdom": "^21.1.1",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.44.0",
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
     "husky": "^5.2.0",
-    "jest": "^26.6.3",
-    "lint-staged": "^10.5.4",
+    "jest": "^29.6.1",
+    "lint-staged": "^13.2.3",
     "np": "^7.7.0",
-    "prettier": "^2.2.1",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3"
+    "prettier": "^3.0.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
   }
 }