kol.js 0.1.4 → 0.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kol.js",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "main": "src/index.ts",
   "type": "module",
   "files": [
@@ -13,21 +13,20 @@
     "format": "prettier --write ."
   },
   "devDependencies": {
-    "@types/tough-cookie": "^4",
-    "prettier": "^3.2.5",
-    "typescript": "^5.4.5",
-    "vitest": "^1.6.0"
+    "prettier": "^3.3.3",
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.0"
   },
   "dependencies": {
-    "@xmldom/xmldom": "^0.8.10",
+    "@xmldom/xmldom": "^0.9.2",
     "async-mutex": "^0.5.0",
     "date-fns": "^3.6.0",
-    "got": "^14.3.0",
+    "got": "^14.4.2",
     "html-entities": "^2.5.2",
     "image-size": "^1.1.1",
     "node-html-parser": "^6.1.13",
     "querystring": "^0.2.1",
-    "tough-cookie": "^4.1.4",
+    "tough-cookie": "^5.0.0",
     "ts-dedent": "^2.2.0",
     "typed-emitter": "^2.1.0",
     "xpath": "^0.0.34"

package/src/Client.test.ts

@@ -204,3 +204,44 @@ describe("Familiars", () => {
     expect(familiars).toHaveLength(206);
   });
 });
+
+describe("Raffle", () => {
+  it("can fetch the current raffle", async () => {
+    text.mockResolvedValueOnce(await loadFixture(__dirname, "raffle.html"));
+    text.mockResolvedValueOnce("<!-- itemid: 1 -->");
+    text.mockResolvedValueOnce("<!-- itemid: 2 -->");
+    text.mockResolvedValueOnce("<!-- itemid: 3 -->");
+    text.mockResolvedValueOnce("<!-- itemid: 4 -->");
+
+    const raffle = await client.getRaffle();
+
+    expect(raffle).toMatchObject({
+      today: {
+        first: 1,
+        second: 2,
+      },
+      yesterday: [
+        {
+          player: { id: 809337, name: "Collective Consciousness" },
+          item: 3,
+          tickets: 3333,
+        },
+        {
+          player: { id: 852958, name: "Ryo_Sangnoir" },
+          item: 4,
+          tickets: 1011,
+        },
+        {
+          player: { id: 1765063, name: "SSpectre_Karasu" },
+          item: 4,
+          tickets: 1000,
+        },
+        {
+          player: { id: 1652370, name: "yueli7" },
+          item: 4,
+          tickets: 2040,
+        },
+      ],
+    });
+  });
+});

package/src/Client.ts

@@ -42,7 +42,7 @@ type Familiar = {
   image: string;
 };
 
-export class Client extends (EventEmitter as new () => TypedEmitter<Events>) {
+export class Client extends (EventEmitter as unknown as new () => TypedEmitter<Events>) {
   actionMutex = new Mutex();
   session = got.extend({
     cookieJar: new CookieJar(),
@@ -55,7 +55,8 @@ export class Client extends (EventEmitter as new () => TypedEmitter<Events>) {
 
         if (options.searchParams) {
           const searchParams = options.searchParams as URLSearchParams;
-          if (searchParams.get("pwd") !== "false") searchParams.set("pwd", this.#pwd);
+          if (searchParams.get("pwd") !== "false")
+            searchParams.set("pwd", this.#pwd);
         }
 
         return next(options);
@@ -269,14 +270,20 @@ export class Client extends (EventEmitter as new () => TypedEmitter<Events>) {
   }
 
   async deleteKmails(ids: number[]) {
-    await this.fetchText("messages.php", {
-      searchParams: {
+    if (ids.length === 0) return true;
+
+    const response = await this.fetchText("messages.php", {
+      form: {
         the_action: "delete",
         box: "Inbox",
         ...Object.fromEntries(ids.map((id) => [`sel${id}`, "on"])),
         pwd: true,
       },
     });
+
+    return response.includes(
+      `<td>${ids.length} message${ids.length === 1 ? "" : "s"} deleted.</td>`,
+    );
   }
 
   async checkKmails() {
@@ -348,9 +355,9 @@ export class Client extends (EventEmitter as new () => TypedEmitter<Events>) {
         : minPrice
       : minPrice;
     const formattedMinPrice = minPrice
-      ? (minPrice === unlimitedPrice
+      ? ((minPrice === unlimitedPrice
           ? unlimitedMatch?.[1]
-          : limitedMatch?.[1]) ?? ""
+          : limitedMatch?.[1]) ?? "")
       : "";
     return {
       mallPrice: unlimitedPrice,
@@ -503,4 +510,47 @@ export class Client extends (EventEmitter as new () => TypedEmitter<Events>) {
 
     return familiars;
   }
+
+  static #descIdToIdCache: Map<number, number> = new Map();
+
+  async descIdToId(descId: number): Promise<number> {
+    if (Client.#descIdToIdCache.has(descId)) return Client.#descIdToIdCache.get(descId)!;
+    const page = await this.fetchText("desc_item.php", {
+      searchParams: {
+        whichitem: descId,
+      },
+    });
+    const id = Number(page.match(/<!-- itemid: (\d+) -->/)?.[1] ?? -1);
+    Client.#descIdToIdCache.set(descId, id);
+    return id;
+  }
+
+  async getRaffle() {
+    const page = await this.fetchText("raffle.php");
+    const today = page.matchAll(
+      /<tr><td align=right>(?:First|Second) Prize:<\/td>.*?descitem\((\d+)\)/g,
+    );
+    const [first, second] = await Promise.all(
+      today
+        ? [...today].map(async (p) => await this.descIdToId(Number(p[1])))
+        : [null, null],
+    );
+    const winners = page.matchAll(
+      /<tr><td class=small><a href='showplayer\.php\?who=\d+'>(.*?) \(#(\d+)\).*?descitem\((\d+)\).*?([\d,]+)<\/td><\/tr>/g,
+    );
+    const yesterday = await Promise.all(
+      winners
+        ? [...winners].map(async (w) => ({
+            player: new Player(this, Number(w[2]), w[1]),
+            item: await this.descIdToId(Number(w[3])),
+            tickets: Number(w[4].replace(",", "")),
+          }))
+        : [],
+    );
+
+    return {
+      today: { first, second },
+      yesterday,
+    };
+  }
 }

package/src/Player.test.ts

@@ -17,18 +17,37 @@ vi.mock("./Client.js", async (importOriginal) => {
 
 const client = new Client("", "");
 
-test("Can search for a player by name", async () => {
-  vi.mocked(text).mockResolvedValueOnce(
-    await loadFixture(__dirname, "searchplayer_mad_carew.html"),
-  );
+describe("Player searching", () => {
+  test("Can search for a player by name", async () => {
+    vi.mocked(text).mockResolvedValueOnce(
+      await loadFixture(__dirname, "searchplayer_mad_carew.html"),
+    );
+
+    const player = await Player.fromName(client, "mad carew");
+
+    expectNotNull(player);
+
+    expect(player.id).toBe(263717);
+    // Learns correct capitalisation
+    expect(player.name).toBe("Mad Carew");
+  });
+
+  test("Can search for a player in Valhalla by name ", async () => {
+    vi.mocked(text).mockResolvedValueOnce(
+      await loadFixture(__dirname, "searchplayer_beldur.html"),
+    );
 
-  const player = await Player.fromName(client, "mad carew");
+    const player = await Player.fromName(client, "Beldur");
 
-  expectNotNull(player);
+    expectNotNull(player);
 
-  expect(player.id).toBe(263717);
-  // Learns correct capitalisation
-  expect(player.name).toBe("Mad Carew");
+    expect(player.id).toBe(1046951);
+    // Learns correct capitalisation
+    expect(player.name).toBe("Beldur");
+    expect(player.level).toBe(0);
+    // We display Astral Spirit even though the search page says Seal Clubber.
+    expect(player.kolClass).toBe("Astral Spirit");
+  });
 });
 
 describe("Profile parsing", () => {

package/src/Player.ts

@@ -82,7 +82,7 @@ export class Player<IsFull extends boolean = boolean> {
   ): Promise<Player<false> | null> {
     try {
       const matcher =
-        /href="showplayer.php\?who=(?<playerId>\d+)">(?<playerName>.*?)<\/a>\D+(clan=\d+[^<]+\D+)?\d+\D*(?<level>(\d+)|(inf_large\.gif))\D+valign=top>(?<class>[^<]*)<\/td>/i;
+        /<tr><td class=small><b><a target=mainpane href="showplayer\.php\?who=(?<playerId>\d+)">(?<playerName>[^<]+)<\/a><\/b>.*?<\/td><td valign=top class=small>\d*<\/td><td valign=top class=small>(?:<img src=".*?">|(?<level>\d+))<\/td><td class=small valign=top>(?<class>[^<]+)<\/td><\/tr>/i;
       const search = await client.fetchText("searchplayer.php", {
         searchParams: {
           searchstring: name.replace(/_/g, "\\_"),
@@ -98,12 +98,14 @@ export class Player<IsFull extends boolean = boolean> {
         return null;
       }
 
+      const clazz = match.level ? match.class : "Astral Spirit";
+
       return new Player(
         client,
         Number(match.playerId),
         match.playerName,
-        parseInt(match.level),
-        match.class,
+        parseInt(match.level) || 0,
+        clazz,
       );
     } catch (error) {
       return null;
@@ -206,4 +208,8 @@ export class Player<IsFull extends boolean = boolean> {
       response?.output.includes("This player is currently online") ?? false
     );
   }
+
+  toString() {
+    return `${this.name} (#${this.id})`;
+  }
 }

package/src/__fixtures__/raffle.html

@@ -0,0 +1,41 @@
+<html><head>
+  <script language=Javascript>
+  <!--
+  if (parent.frames.length == 0) location.href="game.php";
+  var actions = { "sendmessage.php" : { "action" : 1, "title" : "Send Message", "arg" : "toid" } }
+  var notchat = true;//-->
+  </script>
+  <script language=Javascript src="https://d2uyhvukfffg5a.cloudfront.net/scripts/keybinds.min.2.js"></script>
+  <script language=Javascript src="https://d2uyhvukfffg5a.cloudfront.net/scripts/window.20111231.js"></script>
+  <script language="javascript">function chatFocus(){if(top.chatpane.document.chatform.graf) top.chatpane.document.chatform.graf.focus();}
+  if (typeof defaultBind != 'undefined') { defaultBind(47, 2, chatFocus); defaultBind(190, 2, chatFocus);defaultBind(191, 2, chatFocus); defaultBind(47, 8, chatFocus);defaultBind(190, 8, chatFocus); defaultBind(191, 8, chatFocus); }</script><script language=Javascript>
+  var confirm_ = 0;
+  function conf()
+  {
+    if (!confirm_)
+      return true;
+  
+    var select = document.f.where;
+    var where = select.options[select.selectedIndex].value;
+    if (where == 1)
+      return true;
+    else
+      return confirm("You are currently in ronin/hardcore. Are you sure you want to buy these tickets using your on-hand Meat?");
+  }
+  </script><script language=Javascript src="https://d2uyhvukfffg5a.cloudfront.net/scripts/jquery-1.3.1.min.js"></script>
+  <script language=Javascript src='https://d2uyhvukfffg5a.cloudfront.net/scripts/rcm.20160406.js'></script>	<link rel="stylesheet" type="text/css" href="https://d2uyhvukfffg5a.cloudfront.net/styles.20230117d.css">
+  <style type='text/css'>
+  .faded {
+    zoom: 1;
+    filter: alpha(opacity=35);
+    opacity: 0.35;
+    -khtml-opacity: 0.35; 
+      -moz-opacity: 0.35;
+  }
+  </style>
+  
+  </head>
+  
+  <body>
+  <div id='menu' class=rcm></div><center><table  width=95%  cellspacing=0 cellpadding=0><tr><td style="color: white;" align=center bgcolor=blue><b>Raffle House</b></td></tr><tr><td style="padding: 5px; border: 1px solid blue;"><center><table><tr><td><table><tr><td valign=center><img src='https://d2uyhvukfffg5a.cloudfront.net/otherimages/town/shoppeng.gif'></td><td>Greetings, Adventurer, and welcome to our Raffle House, which is completely and totally legitimate and fully-licensed by the Council of Loathing.<p> Here's how it works: you buy some raffle tickets, and every day (at rollover) we'll draw one to see who wins our Fabulous Prize, which will be delivered to you in one of our special packages. Tickets are non-transferrable, but we will accept tickets from Hagnk's if you should ascend before the drawing.<p> All proceeds will be donated to an unspecified but very worthy charity of our choosing. So, how many tickets do you want?</td></tr></table><center><b>Today's Raffle Prize:</b></center><center><table><tr><td align=right>First Prize:</td><td><img class=hand onclick='descitem(352170676);' alt='maypole' style='vertical-align: middle' src='https://d2uyhvukfffg5a.cloudfront.net/itemimages/maypole.gif'> <b>miniature gravy-covered maypole</b></td></tr></table><center><table><tr><td align=right>Second Prize:</td><td><img class=hand onclick='descitem(992809861);' alt='vcase' style='vertical-align: middle' src='https://d2uyhvukfffg5a.cloudfront.net/itemimages/vcase.gif'> <b>Doll Moll violin case</b></td></tr></table><table><tr><td>1 first prize lot  and 3 second prize lots are available. One prize lot per winner. All ticket sales are final.  Void where prohibited by law.  Part of a complete breakfast.<p></td></tr></table><p>You haven't bought any tickets for today's raffle.<p><b>Winners of Yesterday's Raffle:</b><br><div style='max-height: 300px; overflow: auto; border: 1px dashed black; margin-left: 5%; margin-right: 5%'><table><tr><td align=center><b>Name</b></td><td align=center><b>Prize</b></td><td align=center><b>Tickets<br>Purchased</b></td></tr><tr><td class=small><a href='showplayer.php?who=809337'>Collective Consciousness (#809337)</a></td><td><img class=hand onclick='descitem(828455718);' style='vertical-align: middle' src='https://d2uyhvukfffg5a.cloudfront.net/itemimages/wintercatalog.gif'> <b>Discontent&trade; Winter Garden Catalog</b></td><td class=small>&nbsp;&nbsp;3,333</td></tr><tr><td class=small><a href='showplayer.php?who=852958'>Ryo_Sangnoir (#852958)</a></td><td><img class=hand onclick='descitem(211748296);' style='vertical-align: middle' src='https://d2uyhvukfffg5a.cloudfront.net/itemimages/wine.gif'> <b>Colera Peste Nebbiolo</b></td><td class=small>&nbsp;&nbsp;1,011</td></tr><tr><td class=small><a href='showplayer.php?who=1765063'>SSpectre_Karasu (#1765063)</a></td><td><img class=hand onclick='descitem(211748296);' style='vertical-align: middle' src='https://d2uyhvukfffg5a.cloudfront.net/itemimages/wine.gif'> <b>Colera Peste Nebbiolo</b></td><td class=small>&nbsp;&nbsp;1,000</td></tr><tr><td class=small><a href='showplayer.php?who=1652370'>yueli7 (#1652370)</a></td><td><img class=hand onclick='descitem(211748296);' style='vertical-align: middle' src='https://d2uyhvukfffg5a.cloudfront.net/itemimages/wine.gif'> <b>Colera Peste Nebbiolo</b></td><td class=small>&nbsp;&nbsp;2,040</td></tr></table></div><form name=f style='display: inline' action=raffle.php method=post onsubmit='return conf();'><input type=hidden name=action value=buy><input type=hidden name=pwd value=4cf70f166096b3abab3d98431af7094a><table><tr><td colspan=3 align=center><b>Buy Raffle Tickets:</b></td></tr><tr><td align=right><img style='vertical-align: middle' class=hand src='https://d2uyhvukfffg5a.cloudfront.net/itemimages/raffle.gif' onclick='descitem(488779797)'></td><td><b>raffle ticket</b></td><td>10,000 Meat</td></tr><tr><td colspan=3><center><input type=hidden name=where value=0><input type=submit class=button value='Buy Tickets'> <input type=text class=text name=quantity value=1 size=3></center></td></tr></table></form></center><center><p><a href='bordertown.php'>Go back to Bordertown</a></center></td></tr></table></center></td></tr><tr><td height=4></td></tr></table></center></body></html>
+  

package/src/__fixtures__/searchplayer_beldur.html

@@ -0,0 +1,54 @@
+<html><head><title>Search for a player</title>
+  <link rel="stylesheet" type="text/css" href="/images/styles.20230117d.css">
+  <script>
+  var actions = { "sendmessage.php" : { "action" : 1, "title" : "Send Message", "arg" : "toid" }, "town_sendgift.php" : { "action" : 1, "title" : "Send Gift", "arg" : "towho" }, "makeoffer.php" : { "action" : 1, "title" : "Propose Trade", "arg" : "towho" }, "mallstore.php" : { "action" : 1, "title" : "Mall Store", "arg" : "whichstore" }, "/./curse.php" : { "action" : 1, "title" : "Throw TP", "arg" : "whichitem=1923&targetplayer" }, "/msg" : { "action" : 3, "useid" : true, "query" : "Enter message to send to %:" } }
+  var notchat = true;
+  </script>
+  <script language=Javascript src='/images/scripts/rcm.3.js'></script>
+  <script language="Javascript" src="/basics.js"></script><link rel="stylesheet" href="/basics.1.css" /></head>
+  <style type="text/css">
+  <!--
+  BODY, TD, UL {
+  size : 1;
+  }
+  a {
+    text-decoration: none;
+  }
+  .small { font-size: .8em; }
+  -->
+  </style>
+  
+  <script src="/onfocus.1.js"></script></html>
+  <body bgcolor=white text=black link=black alink=black vlink=black>
+  <div id='menu' class=rcm></div>
+  
+  <center><b>Search Results:<br><table align=center><tr><td class=small><b><u>Name</u></b></td><td class=small><b><u>PlayerID</u></b></td><td class=small><b><u>Level</u></b></td><td class=small><b><u>Class</u></b></td></tr><tr><td class=small><b><a target=mainpane href="showplayer.php?who=1046951">Beldur</a></b> </td><td valign=top class=small>1046951</td><td valign=top class=small><img src="https://d2uyhvukfffg5a.cloudfront.net/otherimages/inf_small.gif"></td><td class=small valign=top>Seal Clubber</td></tr><tr><td class=small><b><a target=mainpane href="showplayer.php?who=3498868">Beldur2</a></b> </td><td valign=top class=small>3498868</td><td valign=top class=small>1</td><td class=small valign=top>Sauceror</td></tr></table></center>
+  <form name="search" action="searchplayer.php" method="post">
+  <input type="hidden" name="searching" value="Yep.">
+  <input type="hidden" name="for" value="">
+  <center>
+  <b>Search for names:</b>
+  <input class="text" type="text" name="searchstring" size="30" value="Beldur"><br />
+  <div style="font-weight: normal">
+    starting with <input type="radio" name="startswith" value="1" checked="checked">&nbsp;&nbsp;
+    containing<input type="radio" name="startswith" value="2">&nbsp;&nbsp;
+    ending with <input type="radio" name="startswith" value="3">
+  </div>
+  <table>
+  <tr><td valign="center" align="center">
+  Level: <input class="text" type="text" size=3 name=searchlevel>
+  Fame: <input class="text" type="text" size=3 name=searchranking>
+  </td></tr>
+  <tr><td valign="center"><input type="checkbox" name="pvponly" >PvP players only</td>
+  <td><input type="radio" name="hardcoreonly" value="1">Hardcore only<br>
+  <input type="radio" name="hardcoreonly" value="2">Not in Hardcore<br>
+  <input type="radio" name="hardcoreonly" value="0" checked>Don't Care</td>
+  </tr>
+  </table>
+  <input class="button" type="submit" value="Search">
+  </form>
+  
+  </font>
+  </body>
+  </html>
+  

package/src/utils/leaderboard.ts

@@ -1,5 +1,5 @@
 import xpath, { select } from "xpath";
-import { DOMParser } from "@xmldom/xmldom";
+import { DOMParser, MIME_TYPE } from "@xmldom/xmldom";
 
 export type LeaderboardInfo = {
   name: string;
@@ -19,11 +19,8 @@ type RunInfo = {
 };
 
 const parser = new DOMParser({
-  locator: {},
-  errorHandler: {
-    warning: () => {},
-    error: () => {},
-    fatalError: console.error,
+  onError: (level, message) => {
+    if (level === "fatalError") console.error(message);
   },
 });
 
@@ -34,8 +31,9 @@ const selectMulti = (expression: string, node: Node) => {
 };
 
 export function parseLeaderboard(page: string): LeaderboardInfo {
-  const document = parser.parseFromString(page);
-  const [board, ...boards] = selectMulti("//table", document);
+  const doc = parser.parseFromString(page, MIME_TYPE.HTML);
+  // @ts-expect-error see https://github.com/xmldom/xmldom/issues/724
+  const [board, ...boards] = selectMulti("//table", doc);
 
   return {
     name: selectMulti(".//text()", board.firstChild!)