v2.22.0

Merge pull request #108 from davidvorona/add-yama
Add Yama, the Master of Pacts
2025-10-15 10:19:04 +00:00 · 2025-05-22 12:22:57 -04:00 · 2025-05-21 14:51:10 -04:00 · 2025-05-21 10:21:23 -07:00 · 2025-02-24 19:46:38 -05:00 · 2025-02-24 19:45:26 -05:00
8 changed files with 41 additions and 8 deletions
--- a/README.md
+++ b/README.md
@@ -179,6 +179,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Vetion                            |            `vetion`            |
 | Vorkath                           |           `vorkath`            |
 | Wintertodt                        |          `wintertodt`          |
+| Yama                              |             `yama`             |
 | Zalcano                           |           `zalcano`            |
 | Zulrah                            |            `zulrah`            |

--- a/tests/b0atyStats.csv
+++ b/tests/b0atyStats.csv
@@ -104,5 +104,6 @@
 97368,51
 15591,2780
 1000405,67
+19722,173
 213696,25
 240082,340
--- a/tests/b0atyStats.json
+++ b/tests/b0atyStats.json
@@ -664,12 +664,18 @@
    },
    {
      "id": 82,
+      "name": "Yama",
+      "rank": 19722,
+      "score": 173
+    },
+    {
+      "id": 83,
      "name": "Zalcano",
      "rank": 213696,
      "score": 25
    },
    {
-      "id": 83,
+      "id": 84,
      "name": "Zulrah",
      "rank": 240082,
      "score": 340
--- a/tests/hiscores.test.ts
+++ b/tests/hiscores.test.ts
@@ -15,7 +15,10 @@ import {
  InvalidFormatError,
  BH_MODES,
  parseJsonStats,
-  HiscoresResponse
+  HiscoresResponse,
+  InvalidRSNError,
+  PlayerNotFoundError,
+  HiScoresError
 } from '../src/index';

 const B0ATY_NAME = 'B0ATY';
@@ -24,6 +27,8 @@ const LYNX_TITAN_SPACE_NAME = 'lYnX tiTaN';
 const LYNX_TITAN_UNDERSCORE_NAME = 'lYnX_tiTaN';
 const LYNX_TITAN_HYPHEN_NAME = 'lYnX-tiTaN';
 const LYNX_TITAN_FORMATTED_NAME = 'Lynx Titan';
+const NON_EXISTENT_NAME = 'nonExistent';
+const ERROR_NAME = 'errorName';

 const attackTopPage = readFileSync(`${__dirname}/attackTopPage.html`, 'utf8');
 const b0atyNamePage = readFileSync(`${__dirname}/b0atyNamePage.html`, 'utf8');
@@ -57,6 +62,12 @@ jest.spyOn(axios, 'get').mockImplementation((url) => {
  if (getStatsURL('main', LYNX_TITAN_FORMATTED_NAME, true) === url) {
    return Promise.resolve({ status: 200, data: lynxTitanStats });
  }
+  if (getPlayerTableURL('main', NON_EXISTENT_NAME) === url) {
+    return Promise.resolve({ data: '<html></html>' });
+  }
+  if (getPlayerTableURL('main', ERROR_NAME)) {
+    return Promise.reject();
+  }
  throw new Error(`No mock response for URL: ${url}`);
 });

@@ -167,6 +178,7 @@ test('Parse CSV to json', () => {
  1940,272
  8623,1340
  605,1694
+  15233,245
  -1,-1
  3867,4583`;

@@ -284,6 +296,7 @@ test('Parse CSV to json', () => {
      vetion: { rank: 1940, score: 272 },
      vorkath: { rank: 8623, score: 1340 },
      wintertodt: { rank: 605, score: 1694 },
+      yama: { rank: 15233, score: 245 },
      zalcano: { rank: -1, score: -1 },
      zulrah: { rank: 3867, score: 4583 }
    }
@@ -322,7 +335,15 @@ describe('Get name format', () => {
    expect(data).toBe(B0ATY_FORMATTED_NAME);
  });
  it('throws an error for a name with invalid characters', async () => {
-    await expect(getRSNFormat('b&aty')).rejects.toBeTruthy();
+    await expect(getRSNFormat('b&aty')).rejects.toThrow(InvalidRSNError);
+  });
+  it('throws an error for a non-existent player', async () => {
+    await expect(getRSNFormat(NON_EXISTENT_NAME)).rejects.toThrow(
+      PlayerNotFoundError
+    );
+  });
+  it('throws an error for a hiscores issue', async () => {
+    await expect(getRSNFormat(ERROR_NAME)).rejects.toThrow(HiScoresError);
  });
 });

@@ -509,7 +530,7 @@ test('Get attack top page', async () => {

 test('Get non-existent player', async () => {
  getStats('fishy').catch((err) => {
-    if (err.response) {
+    if (err?.response) {
      expect(err.response.status).toBe(404);
    }
  });
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "osrs-json-hiscores",
-  "version": "2.21.0",
+  "version": "2.22.0",
  "description": "The Old School Runescape API wrapper that does more!",
  "main": "lib/index.js",
  "types": "lib/index.d.ts",
--- a/src/hiscores.ts
+++ b/src/hiscores.ts
@@ -86,11 +86,12 @@ export async function getOfficialStats(
 */
 export async function getRSNFormat(
  rsn: string,
-  config?: AxiosRequestConfig
+  config?: AxiosRequestConfig,
+  mode: Gamemode = 'main'
 ): Promise<string> {
  validateRSN(rsn);

-  const url = getPlayerTableURL('main', rsn);
+  const url = getPlayerTableURL(mode, rsn);
  try {
    const response = await httpGet<string | Buffer | BinaryData | undefined>(
      url,
@@ -103,10 +104,10 @@ export async function getRSNFormat(
    if (anchor) {
      return rsnFromElement(anchor);
    }
-    throw new PlayerNotFoundError();
  } catch {
    throw new HiScoresError();
  }
+  throw new PlayerNotFoundError();
 }

 /**
--- a/src/types.ts
+++ b/src/types.ts
@@ -130,6 +130,7 @@ export type Boss =
  | 'vetion'
  | 'vorkath'
  | 'wintertodt'
+  | 'yama'
  | 'zalcano'
  | 'zulrah';

--- a/src/utils/constants.ts
+++ b/src/utils/constants.ts
@@ -137,6 +137,7 @@ export const BOSSES: Boss[] = [
  'vetion',
  'vorkath',
  'wintertodt',
+  'yama',
  'zalcano',
  'zulrah'
 ];
@@ -231,6 +232,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
  vetion: "Vet'ion",
  vorkath: 'Vorkath',
  wintertodt: 'Wintertodt',
+  yama: 'Yama',
  zalcano: 'Zalcano',
  zulrah: 'Zulrah'
 };
Author	SHA1	Message	Date
maxswa	6d000df717	v2.22.0	2025-05-22 12:22:57 -04:00
Max Swartwout	5575a83039	Merge pull request #108 from davidvorona/add-yama Add Yama, the Master of Pacts	2025-05-21 14:51:10 -04:00
David Vorona	86d9bcb2e7	Add Yama, the Master of Pacts	2025-05-21 10:21:23 -07:00
maxswa	79c067152c	v2.21.1	2025-02-24 19:46:38 -05:00
Max Swartwout	e51e7bc32e	Merge pull request #107 from maxswa/max/rsn-format-errors Fix RSN format errors, add mode argument.	2025-02-24 19:45:26 -05:00
maxswa	7d7c7f9b08	Fix RSN format errors, add mode.	2025-02-24 19:41:27 -05:00