kol.js 0.0.1 → 0.0.2

package/dist/Cache.js

@@ -9,7 +9,7 @@ export class Cache {
 export class PlayerCache extends Cache {
     async fetch(identifier, full = false) {
         const player = await (async () => {
-            const cached = this.cache.find(p => p.matchesIdentifier(identifier));
+            const cached = this.cache.find((p) => p.matchesIdentifier(identifier));
             if (cached) {
                 return cached;
             }

package/dist/Client.d.ts

@@ -24,6 +24,11 @@ type Events = {
     public: (message: KoLMessage) => void;
     rollover: () => void;
 };
+type Familiar = {
+    id: number;
+    name: string;
+    image: string;
+};
 declare const Client_base: new () => TypedEmitter<Events>;
 export declare class Client extends Client_base {
     #private;
@@ -73,6 +78,7 @@ export declare class Client extends Client_base {
     joinClan(id: number): Promise<boolean>;
     addToWhitelist(playerId: number, clanId: number): Promise<boolean>;
     getLeaderboard(leaderboardId: number): Promise<import("./utils/leaderboard.js").LeaderboardInfo>;
-    useFamiliar(familiarId: number): Promise<void>;
+    useFamiliar(familiarId: number): Promise<boolean>;
+    getFamiliars(): Promise<Familiar[]>;
 }
 export {};

package/dist/Client.js

@@ -30,19 +30,19 @@ export class Client extends EventEmitter {
             method: "POST",
             ...options,
         };
-        const qs = formatQuerystring(params);
+        const qs = formatQuerystring({ ...params, pwd: this.#pwd });
         return await this.session(`https://www.kingdomofloathing.com/${path}${qs ? `?${qs}` : ""}`, {
             method,
             body: body ? createBody({ ...body, pwd: this.#pwd }) : undefined,
         });
     }
     async fetchText(path, options = {}) {
-        if (!await this.login())
+        if (!(await this.login()))
             return options.fallback ?? "";
         return (await this.#fetch(path, options)).text();
     }
     async fetchJson(path, options = {}) {
-        if (!await this.login())
+        if (!(await this.login()))
             return options.fallback ?? null;
         return (await this.#fetch(path, options)).json();
     }
@@ -315,11 +315,29 @@ export class Client extends EventEmitter {
         return parseLeaderboard(page);
     }
     async useFamiliar(familiarId) {
-        await this.fetchText("familiar.php", {
+        const result = await this.fetchText("familiar.php", {
             params: {
                 action: "newfam",
                 newfam: familiarId.toFixed(0),
             },
         });
+        return result.includes(`var currentfam = ${familiarId};`);
+    }
+    async getFamiliars() {
+        const terrarium = await this.fetchText("familiar.php");
+        const matches = terrarium.matchAll(/onClick='fam\((\d+)\)'(?:><img)? src=".*?\/(\w+\/\w+.(?:gif|png))".*?\d+-pound (.*?) \(/g);
+        const familiars = [...matches].map((m) => ({
+            id: Number(m[1]),
+            image: m[2],
+            name: m[3],
+        }));
+        if (terrarium.includes("fam(278)")) {
+            familiars.push({
+                id: 278,
+                image: "otherimages/righthandbody.png",
+                name: "Left-Hand Man",
+            });
+        }
+        return familiars;
     }
 }

package/dist/Client.test.js

@@ -2,9 +2,14 @@ import { describe, expect, test, vi } from "vitest";
 import { Client } from "./Client.js";
 import { loadFixture } from "./testUtils.js";
 const { json, text } = vi.hoisted(() => ({ json: vi.fn(), text: vi.fn() }));
-vi.mock("./utils/visit.js", () => ({
-    createSession: vi.fn().mockReturnValue({ json, text }),
-}));
+vi.mock("./Client.js", async (importOriginal) => {
+    const client = await importOriginal();
+    client.Client.prototype.login = async () => true;
+    client.Client.prototype.checkLoggedIn = async () => true;
+    client.Client.prototype.fetchText = text;
+    client.Client.prototype.fetchJson = json;
+    return client;
+});
 const client = new Client("", "");
 describe("LoathingChat", () => {
     test("Can parse a regular message", async () => {
@@ -130,3 +135,28 @@ describe("Skill descriptions", () => {
         });
     });
 });
+describe("Familiars", () => {
+    test("can fetch all familiars", async () => {
+        text.mockResolvedValueOnce(await loadFixture(__dirname, "familiar_in_standard_run.html"));
+        const familiars = await client.getFamiliars();
+        // Current
+        expect(familiars).toContainEqual({
+            id: 294,
+            name: "Jill-of-All-Trades",
+            image: "itemimages/darkjill2f.gif",
+        });
+        // Problematic
+        expect(familiars).toContainEqual({
+            id: 278,
+            name: "Left-Hand Man",
+            image: "otherimages/righthandbody.png",
+        });
+        expect(familiars).toContainEqual({
+            id: 279,
+            name: "Melodramedary",
+            image: "otherimages/camelfam_left.gif",
+        });
+        // Just to be sure
+        expect(familiars).toHaveLength(206);
+    });
+});

package/dist/Player.js

@@ -131,6 +131,6 @@ export class Player {
     }
     async isOnline() {
         const response = await this.#client.useChatMacro(`/whois ${this.name}`);
-        return response?.output.includes("This player is currently online") ?? false;
+        return (response?.output.includes("This player is currently online") ?? false);
     }
 }

package/dist/Player.test.js

@@ -4,9 +4,14 @@ import { Player } from "./Player.js";
 import { expectNotNull, loadFixture } from "./testUtils.js";
 import { Client } from "./Client.js";
 const { json, text } = vi.hoisted(() => ({ json: vi.fn(), text: vi.fn() }));
-vi.mock("./utils/visit.js", () => ({
-    createSession: vi.fn().mockReturnValue({ json, text }),
-}));
+vi.mock("./Client.js", async (importOriginal) => {
+    const client = await importOriginal();
+    client.Client.prototype.login = async () => true;
+    client.Client.prototype.checkLoggedIn = async () => true;
+    client.Client.prototype.fetchText = text;
+    client.Client.prototype.fetchJson = json;
+    return client;
+});
 const client = new Client("", "");
 test("Can search for a player by name", async () => {
     vi.mocked(text).mockResolvedValueOnce(await loadFixture(__dirname, "searchplayer_mad_carew.html"));

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,4 +1,3 @@
 export { Player } from "./Player.js";
 export { Client } from "./Client.js";
-export { createSession } from "./utils/visit.js";
 export { resolveKoLImage } from "./utils/utils.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kol.js",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "dist/index.js",
   "type": "module",
   "files": [
@@ -10,7 +10,8 @@
   "scripts": {
     "build": "tsc",
     "test": "vitest",
-    "format": "prettier --write ."
+    "format": "prettier --write .",
+    "prepack": "yarn run build"
   },
   "devDependencies": {
     "prettier": "^3.2.5",

package/dist/start.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/start.js

@@ -1,4 +0,0 @@
-import { Client } from "./Client.js";
-const client = new Client("onweb", "beer146beef31");
-const gausie = await client.players.fetch("gausie", true);
-console.log(gausie);