libram 0.7.10 → 0.7.13

package/dist/utils.js

@@ -1,6 +1,18 @@
+/**
+ * Type guard against null value
+ *
+ * @param value Value that can be null
+ * @returns Whether the value is not null or... not
+ */
 export function notNull(value) {
     return value !== null;
 }
+/**
+ * Parse string to number, stripping commas
+ *
+ * @param n Numberical string to parse
+ * @returns Numerical value of string
+ */
 export function parseNumber(n) {
     return Number.parseInt(n.replace(/,/g, ""));
 }
@@ -10,6 +22,7 @@ export function parseNumber(n) {
  * @param n Number to clamp.
  * @param min Lower bound.
  * @param max Upper bound.
+ * @returns Clamped value
  */
 export function clamp(n, min, max) {
     return Math.max(min, Math.min(max, n));
@@ -19,6 +32,7 @@ export function clamp(n, min, max) {
  *
  * @param array Array to split
  * @param chunkSize Size of chunk
+ * @returns Split array
  */
 export function chunk(array, chunkSize) {
     const result = [];
@@ -27,6 +41,12 @@ export function chunk(array, chunkSize) {
     }
     return result;
 }
+/**
+ * Count distinct values in an array
+ *
+ * @param array Array of values
+ * @returns Map of distinct values to count
+ */
 export function arrayToCountedMap(array) {
     if (!Array.isArray(array))
         return array;
@@ -36,25 +56,46 @@ export function arrayToCountedMap(array) {
     });
     return map;
 }
+/**
+ * Turn map of distinct values to count into array of values
+ *
+ * @param map Map to turn into array
+ * @returns Array of values
+ */
 export function countedMapToArray(map) {
     return [].concat(...[...map].map(([item, quantity]) => Array(quantity).fill(item)));
 }
+/**
+ * Stringify a counted map
+ *
+ * @param map Map of counted values
+ * @returns String representing map of counted values
+ */
 export function countedMapToString(map) {
     return [...map].map(([item, quantity]) => `${quantity} x ${item}`).join(", ");
 }
 /**
  * Sum an array of numbers.
+ *
  * @param addends Addends to sum.
- * @param mappingFunction function to turn elements into numbers
+ * @param x Property or mapping function of addends to sum
+ * @returns Sum of numbers
  */
-export function sum(addends, mappingFunction) {
-    return addends.reduce((subtotal, element) => subtotal + mappingFunction(element), 0);
+export function sum(addends, x) {
+    return addends.reduce((subtotal, element) => subtotal + (typeof x === "function" ? x(element) : element[x]), 0);
 }
+/**
+ * Sum array of numbers
+ *
+ * @param addends Numbers to sum
+ * @returns Sum of numbers
+ */
 export function sumNumbers(addends) {
     return sum(addends, (x) => x);
 }
 /**
  * Checks if a given item is in a readonly array, acting as a typeguard.
+ *
  * @param item Needle
  * @param array Readonly array haystack
  * @returns Whether the item is in the array, and narrows the type of the item.
@@ -64,6 +105,7 @@ export function arrayContains(item, array) {
 }
 /**
  * Checks if two arrays contain the same elements in the same quantity.
+ *
  * @param a First array for comparison
  * @param b Second array for comparison
  * @returns Whether the two arrays are equal, irrespective of order.
@@ -76,7 +118,9 @@ export function setEqual(a, b) {
 }
 /**
  * Reverses keys and values for a given map
+ *
  * @param map Map to invert
+ * @returns Inverted map
  */
 export function invertMap(map) {
     const returnValue = new Map();
@@ -85,16 +129,9 @@ export function invertMap(map) {
     }
     return returnValue;
 }
-/**
- * Creates a Type Guard function for a string union type defined via an array as const.
- */
-export function createStringUnionTypeGuardFunction(array) {
-    return function (x) {
-        return array.includes(x);
-    };
-}
 /**
  * Splits a string by commas while also respecting escaping commas with a backslash
+ *
  * @param str String to split
  * @returns List of tokens
  */
@@ -120,3 +157,61 @@ export function splitByCommasWithEscapes(str) {
     returnValue.push(currentString.trim());
     return returnValue;
 }
+/**
+ * Find the best element of an array, where "best" is defined by some given criteria.
+ *
+ * @param array The array to traverse and find the best element of.
+ * @param optimizer Either a key on the objects we're looking at that corresponds to numerical values, or a function for mapping these objects to numbers. Essentially, some way of assigning value to the elements of the array.
+ * @param reverse Make this true to find the worst element of the array, and false to find the best. Defaults to false.
+ * @returns Best element by optimizer function
+ */
+export function maxBy(array, optimizer, reverse = false) {
+    if (!array.length)
+        throw new Error("Cannot call maxBy on an empty array!");
+    if (typeof optimizer === "function") {
+        return [...array].reduce(({ value, item }, other) => {
+            const otherValue = optimizer(other);
+            return value >= otherValue !== reverse
+                ? { value, item }
+                : { value: otherValue, item: other };
+        }, { item: array[0], value: optimizer(array[0]) }).item;
+    }
+    else {
+        return array.reduce((a, b) => a[optimizer] >= b[optimizer] !== reverse ? a : b);
+    }
+}
+/**
+ * Compare arrays shallowly
+ *
+ * @param left One array to compare
+ * @param right The other array to compare
+ * @returns Whether the two arrays are shallowly equal
+ */
+export function arrayEquals(left, right) {
+    if (left.length !== right.length)
+        return false;
+    return left.every((element, index) => element === right[index]);
+}
+/**
+ * Used to collapse a Delayed<T> object into an entity of type "T" as represented by the object.
+ *
+ * @param delayedObject Object of type Delayed<T> that represents either a value of type T or a function returning a value of type T.
+ * @returns The return value of the function, if delayedObject is a function. Otherwise, this returns the original element.
+ */
+export function undelay(delayedObject) {
+    return typeof delayedObject === "function" ? delayedObject() : delayedObject;
+}
+/**
+ * Makes a byX function, like byStat or byClass
+ *
+ * @param source A method for finding your stat, or class, or whatever X is in this context
+ * @returns A function akin to byStat or byClass; it accepts an object that either is "complete" in the sense that it has a key for every conceivable value, or contains a `default` parameter. If an inappropriate input is provided, returns undefined.
+ */
+export function makeByXFunction(source) {
+    return function (options) {
+        const val = undelay(source);
+        if ("default" in options)
+            return options[val] ?? options.default;
+        return options[val];
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libram",
-  "version": "0.7.10",
+  "version": "0.7.13",
   "description": "JavaScript helper library for KoLmafia",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,8 +11,7 @@
   "scripts": {
     "build": "yarn run build:tsc && yarn run build:bundled",
     "build:tsc": "tsc",
-    "build:bundled": "webpack",
-    "build:watch": "tsc --watch",
+    "build:bundled": "node build.mjs",
     "clean": "rm -rf dist",
     "docs": "yarn run typedoc",
     "format": "yarn run prettier --write .",
@@ -27,12 +26,12 @@
   "devDependencies": {
     "@babel/compat-data": "^7.17.0",
     "@babel/core": "^7.17.2",
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
     "@babel/plugin-proposal-object-rest-spread": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.15.0",
     "@babel/preset-env": "^7.16.11",
     "@babel/preset-typescript": "^7.15.0",
     "@tsconfig/node16": "^1.0.2",
+    "@types/array.prototype.flat": "^1.2.1",
     "@types/jest": "^27.0.1",
     "@types/lodash-es": "^4.17.4",
     "@types/node": "^16.11.11",
@@ -40,30 +39,30 @@
     "@typescript-eslint/eslint-plugin": "^5.5.0",
     "@typescript-eslint/parser": "^5.5.0",
     "babel-loader": "^8.2.3",
+    "esbuild": "^0.17.0",
+    "esbuild-plugin-babel": "^0.2.3",
     "eslint": "^7.16.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-jest": "^25.2.3",
-    "eslint-plugin-libram": "^0.2.25",
+    "eslint-plugin-jsdoc": "^40.0.1",
+    "eslint-plugin-libram": "^0.2.29",
     "husky": "^4.3.6",
     "java-parser": "^1.4.0",
     "jest": "^27.1.0",
-    "kolmafia": "^5.27075.0",
+    "kolmafia": "^5.27260.0",
     "lint-staged": ">=10",
     "node-fetch": "^2.6.1",
     "prettier": "^2.1.2",
     "ts-jest": "^27.0.5",
     "ts-node": "^10.4.0",
     "typedoc": "^0.22.10",
-    "typescript": "^4.5.2",
-    "webpack": "^5.67.0",
-    "webpack-cli": "^4.9.2"
+    "typescript": "^4.5.2"
   },
   "dependencies": {
     "@babel/runtime-corejs3": "^7.17.2",
-    "core-js": "^3.21.0",
-    "lodash": "^4.17.21"
+    "array.prototype.flat": "^1.3.1"
   },
   "peerDependencies": {
     "kolmafia": "^5.26781.0"

package/dist/dungeons/Dreadsylvania.d.ts

@@ -1,5 +0,0 @@
-import { Item } from "kolmafia";
-export declare function close(): boolean;
-export declare function open(paymentPolicy?: "None" | "All" | "Difference"): boolean;
-export declare function distribute(idOrName?: number | string, loot?: Item | Item[] | Map<Item, number>, distributeAllOfAGivenItem?: boolean): void;
-export declare function findLoot(): Map<Item, number>;

package/dist/dungeons/Dreadsylvania.js

@@ -1,14 +0,0 @@
-import { myId } from "kolmafia";
-import { close as closeDungeon, distribute as distributeDungeon, Dreadsylvania, findLoot as findLootDungeon, open as openDungeon, } from "./Dungeon";
-export function close() {
-    return closeDungeon(Dreadsylvania);
-}
-export function open(paymentPolicy = "Difference") {
-    return openDungeon(Dreadsylvania, paymentPolicy);
-}
-export function distribute(idOrName = myId(), loot = Dreadsylvania.loot, distributeAllOfAGivenItem = true) {
-    distributeDungeon(Dreadsylvania, idOrName, loot, distributeAllOfAGivenItem);
-}
-export function findLoot() {
-    return findLootDungeon(Dreadsylvania);
-}

package/dist/dungeons/Dungeon.d.ts

@@ -1,29 +0,0 @@
-import { Item } from "kolmafia";
-export declare type Dungeon = {
-    name: string;
-    loot: Item[];
-    openAction: string;
-    closeAction: string;
-    openCost: number;
-    openImage: string;
-    closedImage: string;
-};
-/**
- * Distributes loot from given dungeon
- * @param dungeon The dungeon to distribute loot from
- * @param idOrName The player you're trying to distribute to, either as a username or a player ID. Defaults to self.
- * @param loot The loot you're looking to distribute, specific to this dungeon
- * @param distributeAllOfAGivenItem For items that you can get multiple of in a dungeon. When true, this will give everything of that ilk to your chosen player.
- */
-export declare function distribute(dungeon: Dungeon, idOrName?: number | string, loot?: Item | Item[] | Map<Item, number>, distributeAllOfAGivenItem?: boolean): void;
-export declare function close(dungeon: Dungeon): boolean;
-/**
- * Opens clan dungeon and, if relevant, pays meat to do so
- * @param dungeon The Dungeon to open
- * @param paymentPolicy "None", "All", or "Difference". Difference pays into the stash the exact amount needed to open the dungeon.
- */
-export declare function open(dungeon: Dungeon, paymentPolicy?: "None" | "All" | "Difference"): boolean;
-export declare const Dreadsylvania: Dungeon;
-export declare const Hobopolis: Dungeon;
-export declare const SlimeTube: Dungeon;
-export declare function findLoot(dungeon: Dungeon): Map<Item, number>;

package/dist/dungeons/Dungeon.js

@@ -1,99 +0,0 @@
-import { getClanName, myId, toItem, visitUrl, xpath } from "kolmafia";
-import { Clan } from "../Clan";
-import { getPlayerFromIdOrName } from "../lib";
-import { $items } from "../template-string";
-import { countedMapToArray } from "../utils";
-/**
- * Distributes loot from given dungeon
- * @param dungeon The dungeon to distribute loot from
- * @param idOrName The player you're trying to distribute to, either as a username or a player ID. Defaults to self.
- * @param loot The loot you're looking to distribute, specific to this dungeon
- * @param distributeAllOfAGivenItem For items that you can get multiple of in a dungeon. When true, this will give everything of that ilk to your chosen player.
- */
-export function distribute(dungeon, idOrName = myId(), loot = dungeon.loot, distributeAllOfAGivenItem = true) {
-    const player = getPlayerFromIdOrName(idOrName);
-    const lootList = loot instanceof Map
-        ? countedMapToArray(loot)
-        : Array.isArray(loot)
-            ? loot
-            : [loot];
-    const badLoot = lootList.find((lootItem) => !dungeon.loot.includes(lootItem));
-    if (badLoot) {
-        throw new Error(`${badLoot} is not a valid piece of dungeon loot`);
-    }
-    const pageText = visitUrl("clan_basement.php");
-    if (!pageText.match(new RegExp(player.name, "i"))) {
-        throw new Error(`${player.name} cannot be distributed loot from ${getClanName()}`);
-    }
-    const itemNames = xpath(pageText, "//tr/td[2]/b/text()");
-    const whichLoots = xpath(pageText, '//form[@action="clan_basement.php"]//input[@type="hidden"][@name="whichloot"]/@value');
-    itemNames.forEach((itemName, index) => {
-        if (lootList.includes(toItem(itemName))) {
-            visitUrl(`clan_basement.php?whichloot=${whichLoots[index]}&recipient=${player.id}`);
-            if (!distributeAllOfAGivenItem)
-                lootList.splice(lootList.indexOf(toItem(itemName)));
-        }
-    });
-}
-export function close(dungeon) {
-    visitUrl(`clan_basement.php?action=${dungeon.closeAction}&confirm=true`, true);
-    const pageText = visitUrl("clan_basement.php");
-    return pageText.includes(dungeon.closedImage);
-}
-/**
- * Opens clan dungeon and, if relevant, pays meat to do so
- * @param dungeon The Dungeon to open
- * @param paymentPolicy "None", "All", or "Difference". Difference pays into the stash the exact amount needed to open the dungeon.
- */
-export function open(dungeon, paymentPolicy = "Difference") {
-    const pageText = visitUrl("clan_basement.php");
-    if (pageText.includes(dungeon.openImage))
-        return true;
-    const clan = Clan.get();
-    if (paymentPolicy === "All") {
-        clan.putMeatInCoffer(dungeon.openCost);
-    }
-    else {
-        const stashMeat = clan.getMeatInCoffer();
-        const payDifference = dungeon.openCost - stashMeat;
-        if (payDifference > 0) {
-            if (paymentPolicy === "None")
-                return false;
-            clan.putMeatInCoffer(payDifference);
-        }
-    }
-    visitUrl(`clan_basement.php?action=${dungeon.openAction}`, true);
-    return visitUrl("clan_basement.php").includes(dungeon.openImage);
-}
-/**
- * Creates dungeon object for managing clan dungeons
- * @param name Name of the dungeon in question
- * @param loot Distributable loot dropped by bosses in dungeon
- * @param openAction String action used in form submission to open dungeon
- * @param closeAction String action used in form submission to close dungeon
- * @param openCost Meat cost of opening dungeon
- * @param openImage Image text to search clan_basement.php for to check if dungeon is open
- * @param closedImage Image text to search clan_basement.php for to check if dungeon is closed
- */
-function createDungeon(name, loot, openAction, closeAction, openCost, openImage, closedImage) {
-    return {
-        name: name,
-        loot: loot,
-        openAction: openAction,
-        closeAction: closeAction,
-        openCost: openCost,
-        openImage: openImage,
-        closedImage: closedImage,
-    };
-}
-export const Dreadsylvania = createDungeon("Dreadsylvania", $items `Great Wolf's headband, Great Wolf's right paw, Great Wolf's left paw, Great Wolf's lice, Great Wolf's rocket launcher, Great Wolf's beastly trousers, Drapes-You-Regally, Warms-Your-Tush, Covers-Your-Head, Protects-Your-Junk, Quiets-Your-Steps, Helps-You-Sleep, Mayor Ghost's khakis, Mayor Ghost's cloak, Mayor Ghost's toupee, Mayor Ghost's scissors, Mayor Ghost's sash, Mayor Ghost's gavel, zombie mariachi hat, zombie accordion, zombie mariachi pants, HOA regulation book, HOA zombie eyes, HOA citation pad, Unkillable Skeleton's skullcap, Unkillable Skeleton's shinguards, Unkillable Skeleton's breastplate, Unkillable Skeleton's shield, Unkillable Skeleton's sawsword, Unkillable Skeleton's restless leg, skull capacitor, Thunkula's drinking cap, Drunkula's silky pants, Drunkula's cape, Drunkula's ring of haze, Drunkula's wineglass, Drunkula's bell, bottle of Bloodweiser, bottle of Bloodweiser, bottle of Bloodweiser, bottle of Bloodweiser, electric Kool-Aid, electric Kool-Aid, electric Kool-Aid, electric Kool-Aid, ghost pepper, ghost pepper, ghost pepper, ghost pepper, Gets-You-Drunk, Gets-You-Drunk, Gets-You-Drunk, Gets-You-Drunk, wriggling severed nose, wriggling severed nose, wriggling severed nose, wriggling severed nose, Hunger™ Sauce, Hunger™ Sauce, Hunger™ Sauce, Hunger™ Sauce`, "translatemap", "foldmap", 1000000, "dvmap.gif", "foldmap.gif");
-export const Hobopolis = createDungeon("Hobopolis", $items `Ol' Scratch's ash can, Ol' Scratch's ol' britches, Ol' Scratch's stovepipe hat, Ol' Scratch's infernal pitchfork, Ol' Scratch's manacles, Ol' Scratch's stove door, Frosty's carrot, Frosty's nailbat, Frosty's old silk hat, Frosty's arm, Frosty's iceball, Frosty's snowball sack, Oscus's dumpster waders, Oscus's pelt, Wand of Oscus, Oscus's flypaper pants, Oscus's garbage can lid, Oscus's neverending soda, Zombo's grievous greaves, Zombo's shield, Zombo's skullcap, Zombo's empty eye, Zombo's shoulder blade, Zombo's skull ring, Chester's bag of candy, Chester's cutoffs, Chester's moustache, Chester's Aquarius medallion, Chester's muscle shirt, Chester's sunglasses, Hodgman's bow tie, Hodgman's porkpie hat, Hodgman's lobsterskin pants, Hodgman's almanac, Hodgman's lucky sock, Hodgman's metal detector, Hodgman's varcolac paw, Hodgman's harmonica, Hodgman's garbage sticker, Hodgman's cane, Hodgman's whackin' stick, Hodgman's disgusting technicolor overcoat, Hodgman's imaginary hamster`, "cleansewer", "floodsewer", 1000000, "opengrate.gif", "sewergrate.gif");
-export const SlimeTube = createDungeon("The Slime Tube", $items `slime-soaked brain, slime-soaked hypophysis, slime-soaked sweat gland, squirming Slime larva, caustic slime nodule, caustic slime nodule, hardened slime belt, hardened slime hat, hardened slime pants`, "cleanspot", "sealtube", 250000, "slimehole.gif", "greasespot.gif");
-export function findLoot(dungeon) {
-    const returnValue = new Map();
-    const pageText = visitUrl("clan_basement.php");
-    for (const lootItem of dungeon.loot) {
-        returnValue.set(lootItem, pageText.match(new RegExp(lootItem.name, "g"))?.length ?? 0);
-    }
-    return returnValue;
-}

package/dist/dungeons/Hobopolis.d.ts

@@ -1,5 +0,0 @@
-import { Item } from "kolmafia";
-export declare function close(): boolean;
-export declare function open(paymentPolicy?: "None" | "All" | "Difference"): boolean;
-export declare function distribute(idOrName?: number | string, loot?: Item | Item[] | Map<Item, number>, distributeAllOfAGivenItem?: boolean): void;
-export declare function findLoot(): Map<Item, number>;

package/dist/dungeons/Hobopolis.js

@@ -1,14 +0,0 @@
-import { myId } from "kolmafia";
-import { close as closeDungeon, distribute as distributeDungeon, findLoot as findLootDungeon, Hobopolis, open as openDungeon, } from "./Dungeon";
-export function close() {
-    return closeDungeon(Hobopolis);
-}
-export function open(paymentPolicy = "Difference") {
-    return openDungeon(Hobopolis, paymentPolicy);
-}
-export function distribute(idOrName = myId(), loot = Hobopolis.loot, distributeAllOfAGivenItem = true) {
-    distributeDungeon(Hobopolis, idOrName, loot, distributeAllOfAGivenItem);
-}
-export function findLoot() {
-    return findLootDungeon(Hobopolis);
-}

package/dist/dungeons/SlimeTube.d.ts

@@ -1,5 +0,0 @@
-import { Item } from "kolmafia";
-export declare function close(): boolean;
-export declare function open(paymentPolicy?: "None" | "All" | "Difference"): boolean;
-export declare function distribute(idOrName?: number | string, loot?: Item | Item[] | Map<Item, number>, distributeAllOfAGivenItem?: boolean): void;
-export declare function findLoot(): Map<Item, number>;

package/dist/dungeons/SlimeTube.js

@@ -1,14 +0,0 @@
-import { myId } from "kolmafia";
-import { close as closeDungeon, distribute as distributeDungeon, findLoot as findLootDungeon, open as openDungeon, SlimeTube, } from "./Dungeon";
-export function close() {
-    return closeDungeon(SlimeTube);
-}
-export function open(paymentPolicy = "Difference") {
-    return openDungeon(SlimeTube, paymentPolicy);
-}
-export function distribute(idOrName = myId(), loot = SlimeTube.loot, distributeAllOfAGivenItem = true) {
-    distributeDungeon(SlimeTube, idOrName, loot, distributeAllOfAGivenItem);
-}
-export function findLoot() {
-    return findLootDungeon(SlimeTube);
-}