remove circular import from chest mimic code

.github/workflows/main.yml

@@ -6,7 +6,7 @@ on:
     branches: [main]
 
 env:
-  node-version: "16"
+  node-version: "18"
   path: "KoLmafia"
 
 jobs:

.github/workflows/publish.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: "16.x"
+          node-version: "18.x"
           registry-url: "https://registry.npmjs.org"
       - run: yarn
       - run: yarn publish

__tests__/Kmail.ts

@@ -0,0 +1,198 @@
+import { isGiftable, Item, visitUrl } from "kolmafia";
+import { $item, Kmail } from "../src";
+
+import mocked = jest.mocked;
+
+jest.mock("kolmafia");
+
+const USER = 11;
+
+const mockItem1 = $item`Jumbo Dr. Lucifer`;
+const mockItem2 = $item`worthless trinket`;
+
+beforeEach(() => {
+  jest.clearAllMocks();
+});
+
+describe(Kmail.send, () => {
+  beforeEach(() => {
+    mocked(visitUrl).mockReturnValue(`<div>Message sent.</div>`);
+    mocked(isGiftable).mockReturnValue(true);
+  });
+
+  it("should send a kmail with a message", () => {
+    Kmail.send(USER, "Hello, world!");
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      "sendmessage.php?action=send&pwd&towho=11&message=Hello%2C%20world!&sendmeat=0",
+      true,
+      true
+    );
+  });
+
+  it("should send a kmail with a message and meat", () => {
+    Kmail.send(USER, "Hello, world!", [], 100);
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      "sendmessage.php?action=send&pwd&towho=11&message=Hello%2C%20world!&sendmeat=100",
+      true,
+      true
+    );
+  });
+
+  it("should send a kmail with a message and items", () => {
+    Kmail.send(USER, "Hello, world!", [mockItem1]);
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      `sendmessage.php?action=send&pwd&towho=11&message=Hello%2C%20world!&sendmeat=0&whichitem1=${mockItem1.id}&howmany1=1`,
+      true,
+      true
+    );
+  });
+
+  it("should send a kmail with a message, items, and meat", () => {
+    Kmail.send(
+      USER,
+      "Hello, world!",
+      new Map([
+        [mockItem1, 11],
+        [mockItem2, 42],
+      ]),
+      100
+    );
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      `sendmessage.php?action=send&pwd&towho=11&message=Hello%2C%20world!&sendmeat=100&whichitem1=${mockItem1.id}&howmany1=11&whichitem2=${mockItem2.id}&howmany2=42`,
+      true,
+      true
+    );
+  });
+
+  it("should send at most 11 items per chunk", () => {
+    const mockItems = Array(15)
+      .fill(undefined)
+      .map((_, i) => Item.get(`mock item ${i}`));
+
+    Kmail.send(USER, "Hello, world!", mockItems, 100);
+
+    expect(visitUrl).toHaveBeenCalledTimes(2);
+    expect(visitUrl).toHaveBeenNthCalledWith(
+      1,
+      `sendmessage.php?action=send&pwd&towho=11&message=Hello%2C%20world!&sendmeat=100&whichitem1=${mockItems[0].id}&howmany1=1&whichitem2=${mockItems[1].id}&howmany2=1&whichitem3=${mockItems[2].id}&howmany3=1&whichitem4=${mockItems[3].id}&howmany4=1&whichitem5=${mockItems[4].id}&howmany5=1&whichitem6=${mockItems[5].id}&howmany6=1&whichitem7=${mockItems[6].id}&howmany7=1&whichitem8=${mockItems[7].id}&howmany8=1&whichitem9=${mockItems[8].id}&howmany9=1&whichitem10=${mockItems[9].id}&howmany10=1&whichitem11=${mockItems[10].id}&howmany11=1`,
+      true,
+      true
+    );
+    expect(visitUrl).toHaveBeenNthCalledWith(
+      2,
+      `sendmessage.php?action=send&pwd&towho=11&message=Hello%2C%20world!&sendmeat=0&whichitem1=${mockItems[11].id}&howmany1=1&whichitem2=${mockItems[12].id}&howmany2=1&whichitem3=${mockItems[13].id}&howmany3=1&whichitem4=${mockItems[14].id}&howmany4=1`,
+      true,
+      true
+    );
+  });
+
+  it.todo(
+    "should send a kmail with a message, items, and meat, and skip ungiftable items"
+  );
+
+  it.todo(
+    "should fallback to sending a gift if the user cannot receive meat or items"
+  );
+
+  it("should properly encode ampersand characters", () => {
+    Kmail.send(USER, "Hi there, give me all your money!&sendmeat=10000000000");
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      "sendmessage.php?action=send&pwd&towho=11&message=Hi%20there%2C%20give%20me%20all%20your%20money!%26sendmeat%3D10000000000&sendmeat=0",
+      true,
+      true
+    );
+  });
+});
+
+describe(Kmail.gift, () => {
+  it("should send a gift with a message", () => {
+    Kmail.gift(USER, "Hello, world!");
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      "town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=Hello%2C%20world!&insidenote=&towho=11&whichpackage=0&sendmeat=0",
+      true,
+      true
+    );
+  });
+
+  it("should send a gift with a message and an inside note", () => {
+    Kmail.gift(
+      USER,
+      "Hello, world!",
+      undefined,
+      undefined,
+      "This is not even funny."
+    );
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      "town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=Hello%2C%20world!&insidenote=This%20is%20not%20even%20funny.&towho=11&whichpackage=0&sendmeat=0",
+      true,
+      true
+    );
+  });
+
+  it("should send a gift with a message and meat", () => {
+    Kmail.gift(USER, "Hello, world!", [], 100);
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      "town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=Hello%2C%20world!&insidenote=&towho=11&whichpackage=0&sendmeat=100",
+      true,
+      true
+    );
+  });
+
+  it("should send a gift with a message and one item", () => {
+    Kmail.gift(USER, "Hello, world!", [mockItem1]);
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      `town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=Hello%2C%20world!&insidenote=&towho=11&whichpackage=1&sendmeat=0&whichitem1=${mockItem1.id}&howmany1=1`,
+      true,
+      true
+    );
+  });
+
+  it("should send a gift with a message and multiple items", () => {
+    Kmail.gift(
+      USER,
+      "Hello, world!",
+      new Map([
+        [mockItem1, 11],
+        [mockItem2, 42],
+      ]),
+      100
+    );
+
+    expect(visitUrl).toHaveBeenCalledWith(
+      `town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=Hello%2C%20world!&insidenote=&towho=11&whichpackage=2&sendmeat=100&whichitem1=${mockItem1.id}&howmany1=11&whichitem2=${mockItem2.id}&howmany2=42`,
+      true,
+      true
+    );
+  });
+
+  it("should send at most 3 items per chunk", () => {
+    const mockItems = Array(5)
+      .fill(undefined)
+      .map((_, i) => Item.get(`mock item ${i}`));
+
+    Kmail.gift(USER, "Hello, world!", mockItems, 100);
+
+    expect(visitUrl).toHaveBeenCalledTimes(2);
+    expect(visitUrl).toHaveBeenNthCalledWith(
+      1,
+      `town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=Hello%2C%20world!&insidenote=&towho=11&whichpackage=3&sendmeat=100&whichitem1=${mockItems[0].id}&howmany1=1&whichitem2=${mockItems[1].id}&howmany2=1&whichitem3=${mockItems[2].id}&howmany3=1`,
+      true,
+      true
+    );
+    expect(visitUrl).toHaveBeenNthCalledWith(
+      2,
+      `town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=Hello%2C%20world!&insidenote=&towho=11&whichpackage=2&sendmeat=0&whichitem1=${mockItems[3].id}&howmany1=1&whichitem2=${mockItems[4].id}&howmany2=1`,
+      true,
+      true
+    );
+  });
+});

__tests__/__mocks__/kolmafia.ts

@@ -0,0 +1,173 @@
+function mockOneOrMany<
+  Ctor extends new (name: string) => T,
+  T extends MafiaClass
+>(
+  ctor: Ctor,
+  n: number | string | (number | string)[],
+  knownInstances: T[]
+): T | T[] {
+  function mockOne(name: number | string): T {
+    // to make mocking easier, we'll just tread ids as names
+    if (typeof name === "number") {
+      name = name.toString();
+    }
+    const existingInstance = knownInstances.find((i) => i.name === name);
+    if (existingInstance) {
+      return existingInstance;
+    }
+    const instance = new ctor(name);
+    knownInstances.push(instance);
+    return instance;
+  }
+
+  if (Array.isArray(n)) {
+    return n.map((name) => mockOne(name));
+  }
+  return mockOne(n);
+}
+
+abstract class MafiaClass {
+  constructor(readonly name: string) {}
+}
+
+export class Bounty extends MafiaClass {
+  private static knownInstances: Bounty[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Bounty, n, Bounty.knownInstances));
+  static all = jest.fn(() => Bounty.knownInstances);
+  static none = {};
+}
+export class Class extends MafiaClass {
+  private static knownInstances: Class[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Class, n, Class.knownInstances));
+  static all = jest.fn(() => Class.knownInstances);
+  static none = {};
+}
+export class Coinmaster extends MafiaClass {
+  private static knownInstances: Coinmaster[] = [];
+  static get = jest.fn((n) =>
+    mockOneOrMany(Coinmaster, n, Coinmaster.knownInstances)
+  );
+  static all = jest.fn(() => Coinmaster.knownInstances);
+  static none = {};
+}
+export class Effect extends MafiaClass {
+  private static knownInstances: Effect[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Effect, n, Effect.knownInstances));
+  static all = jest.fn(() => Effect.knownInstances);
+  static none = {};
+}
+export class Element extends MafiaClass {
+  private static knownInstances: Element[] = [];
+  static get = jest.fn((n) =>
+    mockOneOrMany(Element, n, Element.knownInstances)
+  );
+  static all = jest.fn(() => Element.knownInstances);
+  static none = {};
+}
+export class Familiar extends MafiaClass {
+  private static knownInstances: Familiar[] = [];
+  static get = jest.fn((n) =>
+    mockOneOrMany(Familiar, n, Familiar.knownInstances)
+  );
+  static all = jest.fn(() => Familiar.knownInstances);
+  static none = {};
+}
+export class Item extends MafiaClass {
+  private static knownInstances: Item[] = [];
+  private static mockId = 11;
+  static get = jest.fn((n) => mockOneOrMany(Item, n, Item.knownInstances));
+  static all = jest.fn(() => Item.knownInstances);
+  static none = new Item("", -1, "");
+
+  constructor(
+    readonly name: string,
+    readonly id: number = ++Item.mockId,
+    readonly plural: string = `Multiple ${name}`
+  ) {
+    super(name);
+  }
+}
+
+export class Location extends MafiaClass {
+  private static knownInstances: Location[] = [];
+  static get = jest.fn((n) =>
+    mockOneOrMany(Location, n, Location.knownInstances)
+  );
+  static all = jest.fn(() => Location.knownInstances);
+  static none = {};
+}
+export class Modifier extends MafiaClass {
+  private static knownInstances: Modifier[] = [];
+  static get = jest.fn((n) =>
+    mockOneOrMany(Modifier, n, Modifier.knownInstances)
+  );
+  static all = jest.fn(() => Modifier.knownInstances);
+  static none = {};
+}
+export class Monster extends MafiaClass {
+  private static knownInstances: Monster[] = [];
+  static get = jest.fn((n) =>
+    mockOneOrMany(Monster, n, Monster.knownInstances)
+  );
+  static all = jest.fn(() => Monster.knownInstances);
+  static none = {};
+}
+export class Path extends MafiaClass {
+  private static knownInstances: Path[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Path, n, Path.knownInstances));
+  static all = jest.fn(() => Path.knownInstances);
+  static none = {};
+}
+export class Phylum extends MafiaClass {
+  private static knownInstances: Phylum[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Phylum, n, Phylum.knownInstances));
+  static all = jest.fn(() => Phylum.knownInstances);
+  static none = {};
+}
+export class Servant extends MafiaClass {
+  private static knownInstances: Servant[] = [];
+  static get = jest.fn((n) =>
+    mockOneOrMany(Servant, n, Servant.knownInstances)
+  );
+  static all = jest.fn(() => Servant.knownInstances);
+  static none = {};
+}
+export class Skill extends MafiaClass {
+  private static knownInstances: Skill[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Skill, n, Skill.knownInstances));
+  static all = jest.fn(() => Skill.knownInstances);
+  static none = {};
+}
+export class Slot extends MafiaClass {
+  private static knownInstances: Slot[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Slot, n, Slot.knownInstances));
+  static all = jest.fn(() => Slot.knownInstances);
+  static none = {};
+}
+export class Stat extends MafiaClass {
+  private static knownInstances: Stat[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Stat, n, Stat.knownInstances));
+  static all = jest.fn(() => Stat.knownInstances);
+  static none = {};
+}
+export class Thrall extends MafiaClass {
+  private static knownInstances: Thrall[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Thrall, n, Thrall.knownInstances));
+  static all = jest.fn(() => Thrall.knownInstances);
+  static none = {};
+}
+export class Vykea extends MafiaClass {
+  private static knownInstances: Vykea[] = [];
+  static get = jest.fn((n) => mockOneOrMany(Vykea, n, Vykea.knownInstances));
+  static all = jest.fn(() => Vykea.knownInstances);
+  static none = {};
+}
+
+export const getProperty = jest.fn();
+
+export const isGiftable = jest.fn();
+
+export const print = jest.fn((msg) => console.log(`[kolmafia.print] ${msg}`));
+
+export const toItem = jest.fn((name) => Item.get(name));
+export const visitUrl = jest.fn();