kol.js 0.2.0 → 0.3.0

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "kol.js",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "main": "src/index.ts",
   "type": "module",
   "files": [
     "/src"
   ],
+  "repository": "https://github.com/loathers/oaf.git",
   "license": "MIT",
   "scripts": {
     "build": "tsc",
@@ -13,23 +14,23 @@
     "format": "prettier --write ."
   },
   "devDependencies": {
-    "prettier": "^3.6.2",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.9"
+    "prettier": "^3.8.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
     "async-mutex": "^0.5.0",
-    "css-select": "^5.1.0",
+    "css-select": "^6.0.0",
     "date-fns": "^4.1.0",
     "domhandler": "^5.0.3",
     "domutils": "^3.2.2",
-    "got": "^14.4.6",
-    "html-entities": "^2.5.3",
-    "htmlparser2": "^10.0.0",
-    "image-size": "^2.0.1",
+    "entities": "^7.0.1",
+    "got": "^14.6.6",
+    "htmlparser2": "^10.1.0",
+    "image-size": "^2.0.2",
     "querystring": "^0.2.1",
-    "tough-cookie": "^5.1.2",
+    "tough-cookie": "^6.0.0",
     "ts-dedent": "^2.2.0",
     "typed-emitter": "^2.1.0"
   }
-}
+}

package/src/Client.ts

@@ -1,25 +1,29 @@
 import { Mutex } from "async-mutex";
 import { EventEmitter } from "node:events";
-import TypedEventEmitter, { EventMap } from "typed-emitter";
+import TypedEventEmitter, { type EventMap } from "typed-emitter";
 
 import { sanitiseBlueText, wait } from "./utils/utils.js";
 import { Player } from "./Player.js";
 import { parseLeaderboard } from "./utils/leaderboard.js";
 import {
-  ChatMessage,
-  KmailMessage,
-  KoLChatMessage,
-  KoLKmail,
-  KoLMessage,
+  type ChatMessage,
+  type KmailMessage,
+  type KoLChatMessage,
+  type KoLKmail,
+  type KoLMessage,
   isValidMessage,
+  parseKmailMessage,
 } from "./utils/kmail.js";
 import { PlayerCache } from "./Cache.js";
 import { CookieJar } from "tough-cookie";
-import got, { OptionsOfJSONResponseBody, OptionsOfTextResponseBody } from "got";
+import got, {
+  type OptionsOfJSONResponseBody,
+  type OptionsOfTextResponseBody,
+} from "got";
 
 type TypedEmitter<T extends EventMap> = TypedEventEmitter.default<T>;
 
-type MallPrice = {
+export type MallPrice = {
   formattedMallPrice: string;
   formattedLimitedMallPrice: string;
   formattedMinPrice: string;
@@ -29,7 +33,7 @@ type MallPrice = {
 };
 
 type Events = {
-  kmail: (message: KoLMessage) => void;
+  kmail: (message: KmailMessage) => void;
   whisper: (message: KoLMessage) => void;
   system: (message: KoLMessage) => void;
   public: (message: KoLMessage) => void;
@@ -288,8 +292,8 @@ export class Client extends (EventEmitter as unknown as new () => TypedEmitter<E
       id: Number(msg.id),
       type: "kmail" as const,
       who: new Player(this, Number(msg.fromid), msg.fromname),
-      msg: msg.message,
       time: new Date(Number(msg.azunixtime) * 1000),
+      ...parseKmailMessage(msg.message, msg.type),
     }));
   }
 

package/src/index.ts

@@ -1,6 +1,6 @@
 export { Player } from "./Player.js";
-export { Client } from "./Client.js";
+export { Client, type MallPrice } from "./Client.js";
 
 export { resolveKoLImage } from "./utils/utils.js";
-export type { KoLMessage } from "./utils/kmail.js";
+export type { KmailItem, KoLMessage } from "./utils/kmail.js";
 export type { SubboardInfo } from "./utils/leaderboard.js";

package/src/utils/avatar.test.ts

@@ -13,7 +13,6 @@ describe("Avatars", () => {
   it("can parse an avatar with a broken url", async () => {
     const page = await loadFixture(__dirname, "showplayer_broken_avatar.html");
     const svg = await generateAvatarSvg(page);
-    console.log(svg);
     expect(svg).toContain(`title="/adventureimages/nopic.gif"`);
   });
 });

package/src/utils/kmail.test.ts

@@ -0,0 +1,110 @@
+import { describe, expect, it } from "vitest";
+import { parseKmailMessage } from "./kmail.js";
+
+describe("Kmail parsing", () => {
+  it("strips a valentine", () => {
+    const result = parseKmailMessage(
+      "<center><table><tr><td><img src=\"https://d2uyhvukfffg5a.cloudfront.net/adventureimages/smiley.gif\" width=100 height=100></td><td valign=center>You zerg rush'd my heart<br>Your love gets me high<br>Come give me a kiss<br>You're oh em gee KAWAIIIIIIII!!11!!11!!!?!!?!</td></tr></table></center>",
+      "normal",
+    );
+
+    expect(result.msg).toBe("");
+    expect(result.valentine).toBe("smiley");
+    expect(result.items).toEqual([]);
+    expect(result.meat).toBe(0);
+    expect(result.insideNote).toBeNull();
+  });
+
+  it("parses a kmail with items and a message", () => {
+    const result = parseKmailMessage(
+      'Enjoy!<center><table class="item" style="float: none" rel="id=641&s=14&q=0&d=1&g=0&t=1&n=1&m=0&p=0&u=e"><tr><td><img src="https://d2uyhvukfffg5a.cloudfront.net/itemimages/toast.gif" alt="toast" title="toast" class=hand onClick=\'descitem(931984879)\' ></td><td valign=center class=effect>You acquire an item: <b>toast</b></td></tr></table></center>',
+      "normal",
+    );
+
+    expect(result.msg).toBe("Enjoy!");
+    expect(result.valentine).toBeNull();
+    expect(result.items).toEqual([
+      { id: 641, name: "toast", quantity: 1, descid: "931984879" },
+    ]);
+    expect(result.meat).toBe(0);
+    expect(result.insideNote).toBeNull();
+  });
+
+  it("parses a kmail with items but no message", () => {
+    const result = parseKmailMessage(
+      '<center><table class="item" style="float: none" rel="id=6863&s=1&q=0&d=1&g=0&t=1&n=2&m=0&p=0&u=e"><tr><td><img src="https://d2uyhvukfffg5a.cloudfront.net/itemimages/butterpat.gif" alt="pat of butter" title="pat of butter" class=hand onClick=\'descitem(310457727)\' ></td><td valign=center class=effect>You acquire <b>2 pats of butter</b></td></tr></table></center>',
+      "normal",
+    );
+
+    expect(result.msg).toBe("");
+    expect(result.valentine).toBeNull();
+    expect(result.items).toEqual([
+      {
+        id: 6863,
+        name: "pat of butter",
+        quantity: 2,
+        descid: "310457727",
+      },
+    ]);
+    expect(result.meat).toBe(0);
+    expect(result.insideNote).toBeNull();
+  });
+
+  it("parses a kmail with meat", () => {
+    const result = parseKmailMessage(
+      "<center>You acquire <b>5,000</b> Meat.<br>You gain 5,000 Meat</center>",
+      "normal",
+    );
+
+    expect(result.msg).toBe("");
+    expect(result.items).toEqual([]);
+    expect(result.meat).toBe(5000);
+    expect(result.insideNote).toBeNull();
+  });
+
+  it("parses a kmail with items and meat", () => {
+    const result = parseKmailMessage(
+      'Here you go<center><table class="item" style="float: none" rel="id=641&s=14&q=0&d=1&g=0&t=1&n=1&m=0&p=0&u=e"><tr><td><img src="https://d2uyhvukfffg5a.cloudfront.net/itemimages/toast.gif" alt="toast" title="toast" class=hand onClick=\'descitem(931984879)\' ></td><td valign=center class=effect>You acquire an item: <b>toast</b></td></tr></table></center><center>You gain 1,000 Meat</center>',
+      "normal",
+    );
+
+    expect(result.msg).toBe("Here you go");
+    expect(result.items).toEqual([
+      { id: 641, name: "toast", quantity: 1, descid: "931984879" },
+    ]);
+    expect(result.meat).toBe(1000);
+    expect(result.insideNote).toBeNull();
+  });
+
+  it("parses a plain text kmail", () => {
+    const result = parseKmailMessage("Hello there!", "normal");
+
+    expect(result.msg).toBe("Hello there!");
+    expect(result.valentine).toBeNull();
+    expect(result.items).toEqual([]);
+    expect(result.meat).toBe(0);
+    expect(result.insideNote).toBeNull();
+  });
+
+  it("parses a gift shop kmail", () => {
+    const result = parseKmailMessage(
+      "Thanks for everything!<p>Inside Note:<p>Hope you enjoy this!",
+      "giftshop",
+    );
+
+    expect(result.msg).toBe("Thanks for everything!");
+    expect(result.kmailType).toBe("giftshop");
+    expect(result.insideNote).toBe("Hope you enjoy this!");
+    expect(result.items).toEqual([]);
+    expect(result.meat).toBe(0);
+  });
+
+  it("decodes HTML entities", () => {
+    const result = parseKmailMessage(
+      "That&apos;s a &quot;great&quot; idea &amp; I love it",
+      "normal",
+    );
+
+    expect(result.msg).toBe(`That's a "great" idea & I love it`);
+  });
+});

package/src/utils/kmail.ts

@@ -1,5 +1,17 @@
+import { selectAll, selectOne } from "css-select";
+import { type AnyNode, Element } from "domhandler";
+import { decodeHTML } from "entities";
+import { parseDocument } from "htmlparser2";
+
 import { Player } from "../Player.js";
 
+export type KmailItem = {
+  id: number;
+  name: string;
+  quantity: number;
+  descid: string;
+};
+
 export type KoLChatMessage = {
   who?: Player<false>;
   type?: string;
@@ -39,6 +51,89 @@ export type BaseKoLMessage = {
 export interface KmailMessage extends BaseKoLMessage {
   type: "kmail";
   id: number;
+  kmailType: "normal" | "giftshop";
+  valentine: string | null;
+  items: KmailItem[];
+  meat: number;
+  insideNote: string | null;
+}
+
+function extractItemsFromHtml(html: string): KmailItem[] {
+  const doc = parseDocument(html);
+  const tables = selectAll<AnyNode, Element>("table.item", doc);
+
+  return tables.map((table) => {
+    const rel = table.attribs.rel ?? "";
+    const params = new URLSearchParams(rel);
+
+    const img = selectOne<AnyNode, Element>("img", table);
+    const name = img?.attribs.title ?? "";
+    const onClick = img?.attribs.onClick ?? img?.attribs.onclick ?? "";
+    const descMatch = onClick.match(/descitem\((\d+)\)/);
+
+    return {
+      id: Number(params.get("id") ?? 0),
+      name,
+      quantity: Number(params.get("n") ?? 1),
+      descid: descMatch?.[1] ?? "",
+    };
+  });
+}
+
+function extractMeatFromHtml(html: string): number {
+  const match = html.match(/You (?:gain|acquire) ([\d,]+) Meat/);
+  if (!match) return 0;
+  return Number(match[1].replace(/,/g, ""));
+}
+
+export function parseKmailMessage(
+  rawMessage: string,
+  type: string,
+): {
+  msg: string;
+  kmailType: "normal" | "giftshop";
+  valentine: string | null;
+  items: KmailItem[];
+  meat: number;
+  insideNote: string | null;
+} {
+  let text = rawMessage;
+  let insideText: string | undefined;
+  let valentine: string | null = null;
+  const kmailType = type as "normal" | "giftshop";
+
+  if (type === "normal") {
+    if (text.startsWith("<center><table>")) {
+      const endIdx = text.indexOf("</center>");
+      const header = text.slice(0, endIdx);
+      const imgMatch = header.match(/adventureimages\/(\w+)\.\w+/);
+      valentine = imgMatch?.[1] ?? "unknown";
+      text = text.slice(endIdx + 9);
+    }
+  } else if (type === "giftshop") {
+    [text, insideText] = text.split("<p>Inside Note:<p>");
+  }
+
+  const split = (s: string): [string, string | null] => {
+    const idx = s.indexOf("<");
+    if (idx === -1) return [s, null];
+    return [s.slice(0, idx), s.slice(idx)];
+  };
+
+  const [outsideNote, outsideAttachments] = split(text);
+  const [insideNote, insideAttachments] =
+    insideText !== undefined ? split(insideText) : [null, null];
+
+  const allAttachments = `${outsideAttachments ?? ""}${insideAttachments ?? ""}`;
+
+  return {
+    msg: decodeHTML(outsideNote),
+    kmailType,
+    valentine,
+    items: allAttachments ? extractItemsFromHtml(allAttachments) : [],
+    meat: allAttachments ? extractMeatFromHtml(allAttachments) : 0,
+    insideNote: insideNote !== null ? decodeHTML(insideNote) : null,
+  };
 }
 
 export interface ChatMessage extends BaseKoLMessage {

package/src/utils/utils.ts

@@ -1,5 +1,5 @@
 import { parse as parseDate } from "date-fns";
-import { decode } from "html-entities";
+import { decodeHTML } from "entities";
 
 export function parsePlayerDate(input?: string) {
   if (!input) return new Date();
@@ -8,7 +8,7 @@ export function parsePlayerDate(input?: string) {
 
 export function sanitiseBlueText(blueText: string | undefined): string {
   if (!blueText) return "";
-  return decode(
+  return decodeHTML(
     blueText
       .replace(/\r/g, "")
       .replace(/\r/g, "")