osrs-json-hiscores 2.12.0 → 2.12.1

package/lib/utils/helpers.js

@@ -1,92 +1,109 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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) {
-    return axios_1.default.get(url, {
-        headers: {
-            // without User-Agent header requests may be rejected by DDoS protection mechanism
-            'User-Agent': ua.firefox(80)
-        }
-    });
-};
-exports.httpGet = httpGet;
+"use strict";
+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) {
+    return axios_1.default.get(url, {
+        headers: {
+            // without User-Agent header requests may be rejected by DDoS protection mechanism
+            'User-Agent': ua.firefox(80)
+        }
+    });
+};
+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,14 @@
-"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;
+    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);

package/package.json

@@ -1,114 +1,117 @@
-{
-  "name": "osrs-json-hiscores",
-  "version": "2.12.0",
-  "description": "The Old School Runescape API wrapper that does more!",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib/**/*"
-  ],
-  "scripts": {
-    "dev": "yarn build --watch",
-    "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "eslint --fix \"src/**/*.ts\"",
-    "test": "jest",
-    "prepublish": "yarn run build",
-    "release": "np"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/maxswa/osrs-json-hiscores.git"
-  },
-  "keywords": [
-    "oldschool",
-    "runescape",
-    "osrs",
-    "api",
-    "json",
-    "hiscores",
-    "stats",
-    "skills"
-  ],
-  "author": "maxswa",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/maxswa/osrs-json-hiscores/issues"
-  },
-  "homepage": "https://github.com/maxswa/osrs-json-hiscores#readme",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.{ts}": [
-      "eslint --fix",
-      "prettier --write",
-      "git add"
-    ]
-  },
-  "eslintConfig": {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-      "project": "./tsconfig.eslint.json"
-    },
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint-config-airbnb-typescript",
-      "prettier"
-    ],
-    "ignorePatterns": [
-      "**/@types/*"
-    ]
-  },
-  "prettier": {
-    "trailingComma": "none",
-    "tabWidth": 2,
-    "semi": true,
-    "singleQuote": true
-  },
-  "jest": {
-    "transform": {
-      "^.+\\.(t|j)sx?$": "ts-jest"
-    },
-    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx",
-      "json",
-      "node"
-    ],
-    "testEnvironment": "node"
-  },
-  "dependencies": {
-    "axios": "^0.21.1",
-    "jsdom": "^16.3.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",
-    "husky": "^5.2.0",
-    "jest": "^26.6.3",
-    "lint-staged": "^10.5.4",
-    "np": "6.5.0",
-    "prettier": "^2.2.1",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3"
-  }
-}
+{
+  "name": "osrs-json-hiscores",
+  "version": "2.12.1",
+  "description": "The Old School Runescape API wrapper that does more!",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "dev": "yarn build --watch",
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint --fix \"src/**/*.ts\"",
+    "test": "jest",
+    "prepublish": "yarn run build",
+    "release": "np"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/maxswa/osrs-json-hiscores.git"
+  },
+  "keywords": [
+    "oldschool",
+    "runescape",
+    "osrs",
+    "api",
+    "json",
+    "hiscores",
+    "stats",
+    "skills"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "author": "maxswa",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/maxswa/osrs-json-hiscores/issues"
+  },
+  "homepage": "https://github.com/maxswa/osrs-json-hiscores#readme",
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{ts}": [
+      "eslint --fix",
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "eslintConfig": {
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "project": "./tsconfig.eslint.json"
+    },
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "extends": [
+      "eslint-config-airbnb-typescript",
+      "prettier"
+    ],
+    "ignorePatterns": [
+      "**/@types/*"
+    ]
+  },
+  "prettier": {
+    "trailingComma": "none",
+    "tabWidth": 2,
+    "semi": true,
+    "singleQuote": true
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.(t|j)sx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
+    ],
+    "testEnvironment": "node"
+  },
+  "dependencies": {
+    "axios": "^0.21.1",
+    "jsdom": "^16.3.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",
+    "husky": "^5.2.0",
+    "jest": "^26.6.3",
+    "lint-staged": "^10.5.4",
+    "np": "6.5.0",
+    "prettier": "^2.2.1",
+    "ts-jest": "^26.5.4",
+    "typescript": "^4.2.3"
+  }
+}