kol.js 0.0.2 → 0.1.1

package/src/Player.ts

@@ -0,0 +1,209 @@
+import { Client } from "./Client.js";
+import { generateAvatarSvg } from "./utils/avatar.js";
+import { parsePlayerDate } from "./utils/utils.js";
+
+export type If<
+  Value extends boolean,
+  TrueResult,
+  FalseResult = null,
+> = Value extends true
+  ? TrueResult
+  : Value extends false
+    ? FalseResult
+    : TrueResult | FalseResult;
+
+export class Player<IsFull extends boolean = boolean> {
+  #client: Client;
+
+  id: number;
+  name: string;
+
+  level: If<IsFull, number>;
+  kolClass: If<IsFull, string>;
+  avatar: If<IsFull, string>;
+  ascensions: If<IsFull, number>;
+  trophies: If<IsFull, number>;
+  tattoos: If<IsFull, number>;
+  favoriteFood: If<IsFull, string | null>;
+  favoriteBooze: If<IsFull, string | null>;
+  createdDate: If<IsFull, Date>;
+  lastLogin: If<IsFull, Date>;
+  hasDisplayCase: If<IsFull, boolean>;
+
+  constructor(
+    client: Client,
+    id: number,
+    name: string,
+    level: number | null = null,
+    kolClass: string | null = null,
+  ) {
+    this.#client = client;
+    this.id = id;
+    this.name = name;
+    this.level = level as If<IsFull, number>;
+    this.kolClass = kolClass as If<IsFull, string>;
+    this.avatar = null as If<IsFull, string>;
+    this.ascensions = null as If<IsFull, number>;
+    this.trophies = null as If<IsFull, number>;
+    this.tattoos = null as If<IsFull, number>;
+    this.favoriteFood = null as If<IsFull, string>;
+    this.favoriteBooze = null as If<IsFull, string>;
+    this.createdDate = null as If<IsFull, Date>;
+    this.lastLogin = null as If<IsFull, Date>;
+    this.hasDisplayCase = null as If<IsFull, boolean>;
+  }
+
+  isFull(): this is Player<true> {
+    return this.createdDate !== null;
+  }
+
+  isPartial(): this is Player<false> {
+    return this.createdDate === null;
+  }
+
+  static async getNameFromId(
+    client: Client,
+    id: number,
+  ): Promise<string | null> {
+    try {
+      const profile = await client.fetchText("showplayer.php", {
+        searchParams: { who: id },
+      });
+      const name = profile.match(/<b>([^>]*?)<\/b> \(#(\d+)\)<br>/)?.[1];
+      return name || null;
+    } catch {
+      return null;
+    }
+  }
+
+  static async fromName(
+    client: Client,
+    name: string,
+  ): 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;
+      const search = await client.fetchText("searchplayer.php", {
+        searchParams: {
+          searchstring: name.replace(/_/g, "\\_"),
+          searching: "Yep.",
+          for: "",
+          startswith: 1,
+          hardcoreonly: 0,
+        },
+      });
+      const match = matcher.exec(search)?.groups;
+
+      if (!match) {
+        return null;
+      }
+
+      return new Player(
+        client,
+        Number(match.playerId),
+        match.playerName,
+        parseInt(match.level),
+        match.class,
+      );
+    } catch (error) {
+      return null;
+    }
+  }
+
+  static async fromId(
+    client: Client,
+    id: number,
+  ): Promise<Player<false> | null> {
+    const name = await Player.getNameFromId(client, id);
+    if (!name) return null;
+    return await Player.fromName(client, name);
+  }
+
+  static async from(
+    client: Client,
+    identifier: string | number,
+  ): Promise<Player<false> | null> {
+    const id = Number(identifier);
+
+    if (!Number.isNaN(id) || typeof identifier === "number") {
+      return await Player.fromId(client, id);
+    }
+
+    return await Player.fromName(client, identifier);
+  }
+
+  matchesIdentifier(identifier: string | number) {
+    const id = Number(identifier);
+    if (!Number.isNaN(id) || typeof identifier === "number") {
+      return this.id === identifier;
+    }
+
+    return this.name.toLowerCase() === identifier.toLowerCase();
+  }
+
+  async full(): Promise<Player<true> | null> {
+    const t = this as unknown as Player<true>;
+
+    if (this.isFull()) return this;
+
+    try {
+      const profile = await this.#client.fetchText("showplayer.php", {
+        searchParams: {
+          who: this.id,
+        },
+      });
+      const header = profile.match(
+        /<center><table><tr><td><center>.*?<img.*?src="(.*?)".*?<b>([^>]*?)<\/b> \(#(\d+)\)<br>/,
+      );
+      if (!header) return null;
+
+      t.avatar = (await generateAvatarSvg(profile)) || header[1];
+
+      t.ascensions =
+        Number(
+          profile
+            .match(/>Ascensions<\/a>:<\/b><\/td><td>(.*?)<\/td>/)?.[1]
+            ?.replace(/,/g, ""),
+        ) || 0;
+
+      t.trophies = Number(
+        profile.match(/>Trophies Collected:<\/b><\/td><td>(.*?)<\/td>/)?.[1] ??
+          0,
+      );
+
+      t.tattoos = Number(
+        profile.match(/>Tattoos Collected:<\/b><\/td><td>(.*?)<\/td>/)?.[1] ??
+          0,
+      );
+
+      t.favoriteFood =
+        profile.match(/>Favorite Food:<\/b><\/td><td>(.*?)<\/td>/)?.[1] ?? null;
+      t.favoriteBooze =
+        profile.match(/>Favorite Booze:<\/b><\/td><td>(.*?)<\/td>/)?.[1] ??
+        null;
+
+      t.createdDate = parsePlayerDate(
+        profile.match(/>Account Created:<\/b><\/td><td>(.*?)<\/td>/)?.[1],
+      );
+
+      t.lastLogin = parsePlayerDate(
+        profile.match(/>Last Login:<\/b><\/td><td>(.*?)<\/td>/)?.[1],
+      );
+
+      t.hasDisplayCase =
+        profile.match(/Display Case<\/b><\/a> in the Museum<\/td>/) !== null;
+
+      return t;
+    } catch (error) {
+      console.error(error);
+      return null;
+    }
+  }
+
+  async isOnline() {
+    const response = await this.#client.useChatMacro(`/whois ${this.name}`);
+    return (
+      response?.output.includes("This player is currently online") ?? false
+    );
+  }
+}

package/src/__fixtures__/backoffice_prices_alien_meat.html

@@ -0,0 +1,46 @@
+<script type="text/javascript">
+  if (window.updateInv) updateInv([]);
+</script>
+<script type="text/javascript">
+  if (!window.updateInv && parent.mainpane.updateInv)
+    parent.mainpane.updateInv([]);
+</script>
+<center>
+  <table width="95%" cellspacing="0" cellpadding="0">
+    <tr>
+      <td style="color: white" align="center" bgcolor="blue">
+        <b>Results:</b>
+      </td>
+    </tr>
+    <tr>
+      <td style="padding: 5px; border: 1px solid blue">
+        <center>
+          <table>
+            <tr>
+              <td>
+                <div class="res">
+                  <table border="0">
+                    <tr>
+                      <td>unlimited:</td>
+                      <td><b>1,995</b> x12</td>
+                      <td><b>2,000</b> x2</td>
+                      <td><b>2,933</b> x41</td>
+                      <td><b>2,934</b> x2104</td>
+                    </tr>
+                    <tr>
+                      <td>limited:</td>
+                      <td><b>6,390</b>(11/day) x78</td>
+                    </tr>
+                  </table>
+                </div>
+              </td>
+            </tr>
+          </table>
+        </center>
+      </td>
+    </tr>
+    <tr>
+      <td height="4"></td>
+    </tr>
+  </table>
+</center>

package/src/__fixtures__/backoffice_prices_lov_elephant.html

@@ -0,0 +1,30 @@
+<script type="text/javascript">
+  if (window.updateInv) updateInv([]);
+</script>
+<script type="text/javascript">
+  if (!window.updateInv && parent.mainpane.updateInv)
+    parent.mainpane.updateInv([]);
+</script>
+<center>
+  <table width="95%" cellspacing="0" cellpadding="0">
+    <tr>
+      <td style="color: white" align="center" bgcolor="blue">
+        <b>Results:</b>
+      </td>
+    </tr>
+    <tr>
+      <td style="padding: 5px; border: 1px solid blue">
+        <center>
+          <table>
+            <tr>
+              <td><div class="res">None in the mall</div></td>
+            </tr>
+          </table>
+        </center>
+      </td>
+    </tr>
+    <tr>
+      <td height="4"></td>
+    </tr>
+  </table>
+</center>

package/src/__fixtures__/backoffice_prices_magical_mystery_juice.html

@@ -0,0 +1,30 @@
+<script type="text/javascript">
+  if (window.updateInv) updateInv([]);
+</script>
+<script type="text/javascript">
+  if (!window.updateInv && parent.mainpane.updateInv)
+    parent.mainpane.updateInv([]);
+</script>
+<center>
+  <table width="95%" cellspacing="0" cellpadding="0">
+    <tr>
+      <td style="color: white" align="center" bgcolor="blue">
+        <b>Results:</b>
+      </td>
+    </tr>
+    <tr>
+      <td style="padding: 5px; border: 1px solid blue">
+        <center>
+          <table>
+            <tr>
+              <td><div class="res">None in the mall</div></td>
+            </tr>
+          </table>
+        </center>
+      </td>
+    </tr>
+    <tr>
+      <td height="4"></td>
+    </tr>
+  </table>
+</center>

package/src/__fixtures__/backoffice_prices_tofurkey_leg.html

@@ -0,0 +1,48 @@
+<script type="text/javascript">
+  if (window.updateInv) updateInv([]);
+</script>
+<script type="text/javascript">
+  if (!window.updateInv && parent.mainpane.updateInv)
+    parent.mainpane.updateInv([]);
+</script>
+<center>
+  <table width="95%" cellspacing="0" cellpadding="0">
+    <tr>
+      <td style="color: white" align="center" bgcolor="blue">
+        <b>Results:</b>
+      </td>
+    </tr>
+    <tr>
+      <td style="padding: 5px; border: 1px solid blue">
+        <center>
+          <table>
+            <tr>
+              <td>
+                <div class="res">
+                  <table border="0">
+                    <tr>
+                      <td>unlimited:</td>
+                      <td><b>502</b> x7</td>
+                      <td><b>502</b> x5</td>
+                      <td><b>502</b> x6</td>
+                      <td><b>502</b> x3</td>
+                    </tr>
+                    <tr>
+                      <td>limited:</td>
+                      <td><b>3,850</b>(1/day) x6</td>
+                      <td><b>4,000</b>(1/day) x1</td>
+                      <td><b>9,989</b>(5/day) x3</td>
+                    </tr>
+                  </table>
+                </div>
+              </td>
+            </tr>
+          </table>
+        </center>
+      </td>
+    </tr>
+    <tr>
+      <td height="4"></td>
+    </tr>
+  </table>
+</center>

package/src/__fixtures__/backoffice_prices_turtle_wax_greaves.html

@@ -0,0 +1,42 @@
+<script type="text/javascript">
+  if (window.updateInv) updateInv([]);
+</script>
+<script type="text/javascript">
+  if (!window.updateInv && parent.mainpane.updateInv)
+    parent.mainpane.updateInv([]);
+</script>
+<center>
+  <table width="95%" cellspacing="0" cellpadding="0">
+    <tr>
+      <td style="color: white" align="center" bgcolor="blue">
+        <b>Results:</b>
+      </td>
+    </tr>
+    <tr>
+      <td style="padding: 5px; border: 1px solid blue">
+        <center>
+          <table>
+            <tr>
+              <td>
+                <div class="res">
+                  <table border="0">
+                    <tr>
+                      <td>unlimited:</td>
+                      <td><b>300</b> x1</td>
+                      <td><b>450</b> x1</td>
+                      <td><b>500</b> x1</td>
+                      <td><b>650</b> x1</td>
+                    </tr>
+                  </table>
+                </div>
+              </td>
+            </tr>
+          </table>
+        </center>
+      </td>
+    </tr>
+    <tr>
+      <td height="4"></td>
+    </tr>
+  </table>
+</center>

package/src/__fixtures__/backoffice_prices_turtle_wax_helmet.html

@@ -0,0 +1,42 @@
+<script type="text/javascript">
+  if (window.updateInv) updateInv([]);
+</script>
+<script type="text/javascript">
+  if (!window.updateInv && parent.mainpane.updateInv)
+    parent.mainpane.updateInv([]);
+</script>
+<center>
+  <table width="95%" cellspacing="0" cellpadding="0">
+    <tr>
+      <td style="color: white" align="center" bgcolor="blue">
+        <b>Results:</b>
+      </td>
+    </tr>
+    <tr>
+      <td style="padding: 5px; border: 1px solid blue">
+        <center>
+          <table>
+            <tr>
+              <td>
+                <div class="res">
+                  <table border="0">
+                    <tr>
+                      <td>unlimited:</td>
+                      <td><b>100</b> x1</td>
+                      <td><b>331</b> x2</td>
+                      <td><b>331</b> x1</td>
+                      <td><b>350</b> x1</td>
+                    </tr>
+                  </table>
+                </div>
+              </td>
+            </tr>
+          </table>
+        </center>
+      </td>
+    </tr>
+    <tr>
+      <td height="4"></td>
+    </tr>
+  </table>
+</center>

package/src/__fixtures__/backoffice_prices_turtle_wax_shield.html

@@ -0,0 +1,47 @@
+<script type="text/javascript">
+  if (window.updateInv) updateInv([]);
+</script>
+<script type="text/javascript">
+  if (!window.updateInv && parent.mainpane.updateInv)
+    parent.mainpane.updateInv([]);
+</script>
+<center>
+  <table width="95%" cellspacing="0" cellpadding="0">
+    <tr>
+      <td style="color: white" align="center" bgcolor="blue">
+        <b>Results:</b>
+      </td>
+    </tr>
+    <tr>
+      <td style="padding: 5px; border: 1px solid blue">
+        <center>
+          <table>
+            <tr>
+              <td>
+                <div class="res">
+                  <table border="0">
+                    <tr>
+                      <td>unlimited:</td>
+                      <td><b>500</b> x1</td>
+                      <td><b>500</b> x2</td>
+                      <td><b>500</b> x3</td>
+                      <td><b>500</b> x4</td>
+                    </tr>
+                    <tr>
+                      <td>limited:</td>
+                      <td><b>999</b>(1/day) x3</td>
+                      <td><b>999,999,999</b>(1/day) x2</td>
+                    </tr>
+                  </table>
+                </div>
+              </td>
+            </tr>
+          </table>
+        </center>
+      </td>
+    </tr>
+    <tr>
+      <td height="4"></td>
+    </tr>
+  </table>
+</center>

package/src/__fixtures__/desc_effect_pasta_oneness.html

@@ -0,0 +1,31 @@
+
+<html><head>
+<title>Effect Description</title>
+<script language="Javascript" src="/basics.js"></script><link rel="stylesheet" href="/basics.1.css" /></head>
+<body bgcolor=white text=black link=black alink=black vlink=black>
+<div id="description">
+
+<font face=Arial,Helvetica size=2><!-- effectid: 23 --><center><img src="/images/itemimages/mandala.gif" width=30 height=30><p><u><a class="hand" style="cursor: pointer;" onclick='window.open("http://kol.coldfront.net/thekolwiki/index.php/Pasta_Oneness", "_blank");window.close();'><b>Pasta Oneness</b></u></a><p></center><blockquote>You feel at one with the forces of the pastaverse.  Your fingers pulse with Magicalness.</blockquote><center><font color=blue><b>Mysticality +2</b></font></center></font></font>
+</div>
+<script type="text/javascript">
+<!--
+var resizetries = 0;
+var fsckinresize;
+setTimeout(fsckinresize = function ()  {
+	var desch = document.getElementById('description').offsetHeight;
+	if (desch < 100 && resizetries < 5) {
+		setTimeout(fsckinresize, 100);
+		resizetries++;
+	}
+	if (desch < 100) desch = 200; 
+	//alert('resizing on try #' + resizetries);
+	if (self.resizeTo && window.outerHeight) { 
+		self.resizeTo(400, desch + (window.outerHeight - window.innerHeight) + 50); 
+	}
+	else if (self.resizeTo ) { self.resizeTo(400, desch+130); }
+	else { window.innerHeight = newh; }
+}, 100);
+//-->
+</script>
+</body>
+<script src="/onfocus.1.js"></script></html>

package/src/__fixtures__/desc_effect_the_visible_adventurer.html

@@ -0,0 +1,31 @@
+
+<html><head>
+<title>Effect Description</title>
+<script language="Javascript" src="/basics.js"></script><link rel="stylesheet" href="/basics.1.css" /></head>
+<body bgcolor=white text=black link=black alink=black vlink=black>
+<div id="description">
+
+<font face=Arial,Helvetica size=2><!-- effectid: 1888 --><center><img src="/images/itemimages/handmirror.gif" width=30 height=30><p><u><a class="hand" style="cursor: pointer;" onclick='window.open("http://kol.coldfront.net/thekolwiki/index.php/The_Visible_Adventurer", "_blank");window.close();'><b>The Visible Adventurer</b></u></a><p></center><blockquote>You turned your skin transparent so that you could see what your skeleton looks like. It turns out it look like Charlie Brown's skeleton. Maybe you should see a doctor.</blockquote><center><font color=blue><b>Makes you look like a skeleton</b></font></center></font></font>
+</div>
+<script type="text/javascript">
+<!--
+var resizetries = 0;
+var fsckinresize;
+setTimeout(fsckinresize = function ()  {
+	var desch = document.getElementById('description').offsetHeight;
+	if (desch < 100 && resizetries < 5) {
+		setTimeout(fsckinresize, 100);
+		resizetries++;
+	}
+	if (desch < 100) desch = 200; 
+	//alert('resizing on try #' + resizetries);
+	if (self.resizeTo && window.outerHeight) { 
+		self.resizeTo(400, desch + (window.outerHeight - window.innerHeight) + 50); 
+	}
+	else if (self.resizeTo ) { self.resizeTo(400, desch+130); }
+	else { window.innerHeight = newh; }
+}, 100);
+//-->
+</script>
+</body>
+<script src="/onfocus.1.js"></script></html>

package/src/__fixtures__/desc_item_alien_meat.html

@@ -0,0 +1,38 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+	"http://www.w3.org/TR/html4/loose.dtd">
+<html><head>
+<title>Item Description</title>
+<link rel="stylesheet" type="text/css" href="/images/styles.20230117d.css">
+<style>
+a.hand {
+	cursor: pointer;
+}
+</style>
+<script language=Javascript src="/images/scripts/keybinds.min.2.js"></script>
+<script language=Javascript src="/images/scripts/window.20111231.js"></script>
+<script language="Javascript" src="/basics.js"></script><link rel="stylesheet" href="/basics.1.css" /></head>
+<body>
+
+<div id="description" class=small><center><img  src="/images/itemimages/alienmeat.gif" height=30 width=30 alt="alienmeat"><br><u><a class="hand" style="cursor: pointer;" onclick='window.open("http://kol.coldfront.net/thekolwiki/index.php/alien_meat", "_blank");window.close();'><b>alien meat</b></u></a></center><p><blockquote>This is a slab of meat from an alien animal.<!-- itemid: 9423 --><br><br>(Cooking ingredient)<br>Type: <b>food <font color=green>(good)</font></b><br>Size: <b>1</b><br>Selling Price: <b>8 Meat.</b><p><center><b><font color=blue>Gives 5 Adventures of a random positive effect</font></b></center></blockquote><script type="text/javascript">
+<!--
+var resizetries = 0;
+var fsckinresize;
+setTimeout(fsckinresize = function ()  {
+	var desch = document.getElementById('description').offsetHeight;
+	if (desch < 100 && resizetries < 5) {
+		setTimeout(fsckinresize, 100);
+		resizetries++;
+	}
+	if (desch < 100) desch = 200; 
+	//alert('resizing on try #' + resizetries);
+	if (self.resizeTo && window.outerHeight) { 
+		self.resizeTo(400, desch + (window.outerHeight - window.innerHeight) + 50); 
+	}
+	else if (self.resizeTo ) { self.resizeTo(400, desch+130); }
+	else { window.innerHeight = newh; }
+}, 100);
+//-->
+</script>
+</div>
+</body>
+<script src="/onfocus.1.js"></script></html>

package/src/__fixtures__/desc_item_hypodermic_needle.html

@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+	"http://www.w3.org/TR/html4/loose.dtd">
+<html><head>
+<title>Item Description</title>
+<link rel="stylesheet" type="text/css" href="/images/styles.20230117d.css">
+<style>
+a.hand {
+	cursor: pointer;
+}
+</style>
+<script language=Javascript src="/images/scripts/keybinds.min.2.js"></script>
+<script language=Javascript src="/images/scripts/window.20111231.js"></script>
+<script language=Javascript src="/images/scripts/jquery-1.3.1.min.js"></script>
+<script language="javascript" src="/tcrs.js"></script><link rel="stylesheet" href="/tcrs.css" /><script language="Javascript" src="/basics.js"></script><link rel="stylesheet" href="/basics.1.css" /></head>
+<body>
+
+<div id="description" class=small><center><img  src="/images/itemimages/syringe.gif" height=30 width=30 alt="syringe"><br><u><a class="hand" style="cursor: pointer;" onclick='window.open("http://kol.coldfront.net/thekolwiki/index.php/hypodermic_needle", "_blank");window.close();'><b>hypodermic needle</b></u></a></center><p><blockquote>This is a tiny syringe that has been custom-made to be operated by a mosquito. How, you might ask? Yup, you certainly might ask. This should make the mosquito's blood collection much more efficient.<!-- itemid: 848 --><br><br>Type: <b>familiar equipment</b><br>Familiar: <b>Mosquito</b></b><br>Selling Price: <b>75 Meat.</b><p><center><b><font color=blue>+5 to Familiar Weight<br></font></b></center></blockquote><script type="text/javascript">
+<!--
+var resizetries = 0;
+var fsckinresize;
+setTimeout(fsckinresize = function ()  {
+	var desch = document.getElementById('description').offsetHeight;
+	if (desch < 100 && resizetries < 5) {
+		setTimeout(fsckinresize, 100);
+		resizetries++;
+	}
+	if (desch < 100) desch = 200; 
+	//alert('resizing on try #' + resizetries);
+	if (self.resizeTo && window.outerHeight) { 
+		self.resizeTo(400, desch + (window.outerHeight - window.innerHeight) + 50); 
+	}
+	else if (self.resizeTo ) { self.resizeTo(400, desch+130); }
+	else { window.innerHeight = newh; }
+}, 100);
+//-->
+</script>
+</div>
+</body>
+<script src="/onfocus.1.js"></script></html>