libram 0.8.28 → 0.8.30

package/dist/resources/2020/Guzzlr.d.ts

@@ -0,0 +1,160 @@
+import { Item, Location } from "kolmafia";
+/**
+ * Determines whether you `have` Guzzlr
+ *
+ * @returns Whether you `have` Guzzlr
+ */
+export declare function have(): boolean;
+/**
+ * Determines whether you currently have an active Guzzlr quest
+ *
+ * @returns Whether you currently have an active Guzzlr quest
+ */
+export declare function isQuestActive(): boolean;
+/**
+ * Determines total number of Platinum deliveries completed
+ *
+ * @returns Platinum deliveries completed overall
+ */
+export declare function getPlatinum(): number;
+/**
+ * Determines the number of Platinum deliveries completed today
+ *
+ * @returns Platinum deliveries completed today
+ */
+export declare function getPlatinumToday(): number;
+/**
+ * Determines whether you are currently eligible to do a Platinum delivery
+ *
+ * @returns Whether you are currently eligible to do a Platinum delivery
+ */
+export declare function canPlatinum(): boolean;
+/**
+ * Determines whether you have fully unlocked the Platinum delivery bonuses (done >= 30)
+ *
+ * @returns Whether you have fully unlocked the Platinum delivery enchantment bonuses
+ */
+export declare function haveFullPlatinumBonus(): boolean;
+/**
+ * Accepts a Platinum delivery
+ *
+ * @returns Whether we succeeded in this endeavor
+ */
+export declare function acceptPlatinum(): boolean;
+/**
+ * Determines total number of Gold deliveries completed
+ *
+ * @returns Gold deliveries completed overall
+ */
+export declare function getGold(): number;
+/**
+ * Determines the number of Gold deliveries completed today
+ *
+ * @returns Gold deliveries completed today
+ */
+export declare function getGoldToday(): number;
+/**
+ * Determines whether you are currently eligible to do a Gold delivery
+ *
+ * @returns Whether you are currently eligible to do a Gold delivery
+ */
+export declare function canGold(): boolean;
+/**
+ * Determines whether you have fully unlocked the Gold delivery bonuses (done >= 150)
+ *
+ * @returns Whether you have fully unlocked the Gold delivery enchantment bonuses
+ */
+export declare function haveFullGoldBonus(): boolean;
+/**
+ * Accepts a Gold delivery
+ *
+ * @returns Whether we succeeded in this endeavor
+ */
+export declare function acceptGold(): boolean;
+/**
+ * Determines total number of Bronze deliveries completed
+ *
+ * @returns Bronze deliveries completed overall
+ */
+export declare function getBronze(): number;
+/**
+ * Determines whether you have fully unlocked the Bronze delivery bonuses (done >= 196)
+ *
+ * @returns Whether you have fully unlocked the Bronze delivery enchantment bonuses
+ */
+export declare function haveFullBronzeBonus(): boolean;
+/**
+ * Accepts a Bronze delivery
+ *
+ * @returns Whether we succeeded in this endeavor
+ */
+export declare function acceptBronze(): boolean;
+/**
+ * Determines whether we can abandon the current Guzzlr quest
+ *
+ * @returns Whether we are able to abandon our current Guzzlr quest
+ */
+export declare function canAbandon(): boolean;
+/**
+ * Abandons Guzzlr quest
+ *
+ * @returns `false` if we were unable to abandon a quest; `true` otherwise
+ */
+export declare function abandon(): boolean;
+/**
+ * Determines the target location for your current Guzzlr quest
+ *
+ * @returns The current target location for your Guzzlr quest, if it exists
+ */
+export declare function getLocation(): Location | null;
+/**
+ * Determines the tier of your current Guzzlr quest
+ *
+ * @returns The tier of your current Guzzlr quest; `null` if there is no active quest
+ */
+export declare function getTier(): "platinum" | "gold" | "bronze" | null;
+/**
+ * Determines the current booze item you need to deliver for your current Guzzlr quest
+ *
+ * @returns The booze item associated with your Guzzlr quest if it exists; `null` otherwise
+ */
+export declare function getBooze(): Item | null;
+/**
+ * List of the platinum cocktails
+ */
+export declare const Cocktails: Item[];
+/**
+ * Determines whether you currently have a Platinum cocktail available
+ *
+ * @returns `true` if you have at least one Platinum cocktail in your inventory; `false` otherwise
+ */
+export declare function havePlatinumBooze(): boolean;
+/**
+ * Determines if you currently have in your inventory the booze necessary to progress your Guzzlr quest
+ *
+ * @returns `true` if you have the booze necessary to progress your Guzzlr quest
+ */
+export declare function haveBooze(): boolean;
+export declare const ingredientToPlatinumCocktail: Map<Item, Item>;
+export declare const platinumCocktailToIngredient: Map<Item, Item>;
+/**
+ * Determines the cheapest Platinum cocktail to obtain or produce
+ *
+ * @param freeCraft Defaults to `true`; if set to `false`, will count the price of any turns spent cocktailcrafting
+ * @returns The expected price of the cheapest Platinum cocktail to obtain or produce
+ */
+export declare function getCheapestPlatinumCocktail(freeCraft?: boolean): Item;
+/**
+ * Calculates the number of turns remaining for your Guzzlr quest
+ *
+ * @param useShoes Whether or not the calculation should assume you are using Guzzlr shoes
+ * @returns The expected number of turns needed to finish your current delivery
+ */
+export declare function turnsLeftOnQuest(useShoes?: boolean): number;
+/**
+ * Calculates the expected Guzzlrbuck reward for completing your current Guzzlr quest
+ *
+ * @param usePants Whether or not we should account for Guzzlr pants in our calculation
+ * @returns The expected Guzzlrbuck reward of our current Guzzlr quest
+ */
+export declare function expectedReward(usePants?: boolean): number;

package/dist/resources/2020/Guzzlr.js

@@ -0,0 +1,275 @@
+import { Item, itemAmount, mallPrice, runChoice, use, visitUrl, } from "kolmafia";
+import { have as haveItem } from "../../lib";
+import { get, withChoice } from "../../property";
+import { $item, $items } from "../../template-string";
+import { invertMap, maxBy } from "../../utils";
+const item = $item `Guzzlr tablet`;
+/**
+ * Determines whether you `have` Guzzlr
+ *
+ * @returns Whether you `have` Guzzlr
+ */
+export function have() {
+    return haveItem(item);
+}
+/**
+ * Internal function used to navigate the Guzzlr interface
+ *
+ * @param option Choice option to select
+ */
+function useTabletWithChoice(option) {
+    withChoice(1412, option, () => use(1, item));
+}
+/**
+ * Determines whether you currently have an active Guzzlr quest
+ *
+ * @returns Whether you currently have an active Guzzlr quest
+ */
+export function isQuestActive() {
+    return get("questGuzzlr") !== "unstarted";
+}
+/**
+ * Determines total number of Platinum deliveries completed
+ *
+ * @returns Platinum deliveries completed overall
+ */
+export function getPlatinum() {
+    return get("guzzlrPlatinumDeliveries");
+}
+/**
+ * Determines the number of Platinum deliveries completed today
+ *
+ * @returns Platinum deliveries completed today
+ */
+export function getPlatinumToday() {
+    return get("_guzzlrPlatinumDeliveries");
+}
+/**
+ * Determines whether you are currently eligible to do a Platinum delivery
+ *
+ * @returns Whether you are currently eligible to do a Platinum delivery
+ */
+export function canPlatinum() {
+    return !isQuestActive() && getGold() >= 5 && getPlatinumToday() < 1;
+}
+/**
+ * Determines whether you have fully unlocked the Platinum delivery bonuses (done >= 30)
+ *
+ * @returns Whether you have fully unlocked the Platinum delivery enchantment bonuses
+ */
+export function haveFullPlatinumBonus() {
+    return getPlatinum() >= 30;
+}
+/**
+ * Accepts a Platinum delivery
+ *
+ * @returns Whether we succeeded in this endeavor
+ */
+export function acceptPlatinum() {
+    if (!canPlatinum())
+        return false;
+    useTabletWithChoice(4);
+    return true;
+}
+/**
+ * Determines total number of Gold deliveries completed
+ *
+ * @returns Gold deliveries completed overall
+ */
+export function getGold() {
+    return get("guzzlrGoldDeliveries");
+}
+/**
+ * Determines the number of Gold deliveries completed today
+ *
+ * @returns Gold deliveries completed today
+ */
+export function getGoldToday() {
+    return get("_guzzlrGoldDeliveries");
+}
+/**
+ * Determines whether you are currently eligible to do a Gold delivery
+ *
+ * @returns Whether you are currently eligible to do a Gold delivery
+ */
+export function canGold() {
+    return !isQuestActive() && getBronze() >= 5 && getGoldToday() < 3;
+}
+/**
+ * Determines whether you have fully unlocked the Gold delivery bonuses (done >= 150)
+ *
+ * @returns Whether you have fully unlocked the Gold delivery enchantment bonuses
+ */
+export function haveFullGoldBonus() {
+    return getGold() >= 150;
+}
+/**
+ * Accepts a Gold delivery
+ *
+ * @returns Whether we succeeded in this endeavor
+ */
+export function acceptGold() {
+    if (!canGold())
+        return false;
+    useTabletWithChoice(3);
+    return true;
+}
+/**
+ * Determines total number of Bronze deliveries completed
+ *
+ * @returns Bronze deliveries completed overall
+ */
+export function getBronze() {
+    return get("guzzlrBronzeDeliveries");
+}
+/**
+ * Determines whether you have fully unlocked the Bronze delivery bonuses (done >= 196)
+ *
+ * @returns Whether you have fully unlocked the Bronze delivery enchantment bonuses
+ */
+export function haveFullBronzeBonus() {
+    return getBronze() >= 196;
+}
+/**
+ * Accepts a Bronze delivery
+ *
+ * @returns Whether we succeeded in this endeavor
+ */
+export function acceptBronze() {
+    if (isQuestActive())
+        return false;
+    useTabletWithChoice(2);
+    return true;
+}
+/**
+ * Determines whether we can abandon the current Guzzlr quest
+ *
+ * @returns Whether we are able to abandon our current Guzzlr quest
+ */
+export function canAbandon() {
+    return isQuestActive() && !get("_guzzlrQuestAbandoned");
+}
+/**
+ * Abandons Guzzlr quest
+ *
+ * @returns `false` if we were unable to abandon a quest; `true` otherwise
+ */
+export function abandon() {
+    if (!canAbandon())
+        return false;
+    visitUrl("inventory.php?tap=guzzlr", false);
+    runChoice(1);
+    runChoice(5);
+    return true;
+}
+/**
+ * Determines the target location for your current Guzzlr quest
+ *
+ * @returns The current target location for your Guzzlr quest, if it exists
+ */
+export function getLocation() {
+    return get("guzzlrQuestLocation");
+}
+/**
+ * Determines the tier of your current Guzzlr quest
+ *
+ * @returns The tier of your current Guzzlr quest; `null` if there is no active quest
+ */
+export function getTier() {
+    const tier = get("guzzlrQuestTier");
+    return tier === "" ? null : tier;
+}
+/**
+ * Determines the current booze item you need to deliver for your current Guzzlr quest
+ *
+ * @returns The booze item associated with your Guzzlr quest if it exists; `null` otherwise
+ */
+export function getBooze() {
+    const booze = get("guzzlrQuestBooze");
+    if (booze === "")
+        return null;
+    return Item.get(booze);
+}
+/**
+ * List of the platinum cocktails
+ */
+export const Cocktails = $items `Buttery Boy, Steamboat, Ghiaccio Colada, Nog-on-the-Cob, Sourfinger`;
+/**
+ * Determines whether you currently have a Platinum cocktail available
+ *
+ * @returns `true` if you have at least one Platinum cocktail in your inventory; `false` otherwise
+ */
+export function havePlatinumBooze() {
+    return Cocktails.some((cock) => itemAmount(cock) > 0);
+}
+/**
+ * Determines if you currently have in your inventory the booze necessary to progress your Guzzlr quest
+ *
+ * @returns `true` if you have the booze necessary to progress your Guzzlr quest
+ */
+export function haveBooze() {
+    const booze = getBooze();
+    switch (booze) {
+        case null:
+            return false;
+        case $item `Guzzlr cocktail set`:
+            return havePlatinumBooze();
+        default:
+            return itemAmount(booze) > 0;
+    }
+}
+export const ingredientToPlatinumCocktail = new Map([
+    [$item `miniature boiler`, $item `Steamboat`],
+    [$item `cold wad`, $item `Ghiaccio Colada`],
+    [$item `robin's egg`, $item `Nog-on-the-Cob`],
+    [$item `mangled finger`, $item `Sourfinger`],
+    [$item `Dish of Clarified Butter`, $item `Buttery Boy`],
+]);
+export const platinumCocktailToIngredient = invertMap(ingredientToPlatinumCocktail);
+/**
+ * Determines the cheapest Platinum cocktail to obtain or produce
+ *
+ * @param freeCraft Defaults to `true`; if set to `false`, will count the price of any turns spent cocktailcrafting
+ * @returns The expected price of the cheapest Platinum cocktail to obtain or produce
+ */
+export function getCheapestPlatinumCocktail(freeCraft = true) {
+    if (freeCraft) {
+        return maxBy(Array.from(ingredientToPlatinumCocktail), (ingredientAndCocktail) => Math.min(...ingredientAndCocktail.map((item) => mallPrice(item))), true)[1];
+    }
+    else {
+        return maxBy(Array.from(ingredientToPlatinumCocktail), ([, cocktail]) => mallPrice(cocktail))[1];
+    }
+}
+/**
+ * Calculates the number of turns remaining for your Guzzlr quest
+ *
+ * @param useShoes Whether or not the calculation should assume you are using Guzzlr shoes
+ * @returns The expected number of turns needed to finish your current delivery
+ */
+export function turnsLeftOnQuest(useShoes = false) {
+    const progressPerTurn = useShoes
+        ? Math.floor((10 - get("_guzzlrDeliveries")) * 1.5)
+        : 10 - get("_guzzlrDeliveries");
+    return Math.ceil((100 - get("guzzlrDeliveryProgress")) / progressPerTurn);
+}
+/**
+ * Calculates the expected Guzzlrbuck reward for completing your current Guzzlr quest
+ *
+ * @param usePants Whether or not we should account for Guzzlr pants in our calculation
+ * @returns The expected Guzzlrbuck reward of our current Guzzlr quest
+ */
+export function expectedReward(usePants = false) {
+    switch (getTier()) {
+        case "platinum":
+            // 20-25
+            return 22.5 + (usePants ? 5 : 0);
+        case "gold":
+            // 5-7
+            return 6 + (usePants ? 3 : 0);
+        case "bronze":
+            // 2-4
+            return 3 + (usePants ? 3 : 0);
+        default:
+            return 0;
+    }
+}

package/dist/resources/2020/RetroCape.d.ts

@@ -0,0 +1,51 @@
+import { Skill } from "kolmafia";
+import { Modifiers } from "../../modifier";
+/**
+ * Determines whether you have() the Retro Cape.
+ *
+ * @returns Whether you have the Retro Cape available.
+ */
+export declare function have(): boolean;
+declare const Heroes: {
+    vampire: {
+        "Muscle Percent": number;
+        "Maximum HP": number;
+    };
+    heck: {
+        "Mysticality Percent": number;
+        "Maximum MP": number;
+    };
+    robot: {
+        "Moxie Percent": number;
+        "Maximum HP": number;
+        "Maximum MP": number;
+    };
+};
+declare type Hero = keyof typeof Heroes;
+declare type Mode = "hold" | "thrill" | "kiss" | "kill";
+export declare const currentHero: () => "vampire" | "heck" | "robot";
+export declare const currentMode: () => Mode;
+/**
+ * Tunes retro cape to a given setting
+ *
+ * @param hero The Superhero to set it to
+ * @param mode The washing instructions to set it to
+ * @returns Whether we successfully tuned the Retro Cape.
+ */
+export declare function set(hero: Hero, mode: Mode): boolean;
+/**
+ * Returns the expected Modifiers of the Retro Cape for a particular setting
+ *
+ * @param hero The Superhero setting
+ * @param mode The washing instructions setting
+ * @returns A Modifiers object describing the Retro Cape were it to be tuned to that setting.
+ */
+export declare function getModifier(hero?: "vampire" | "heck" | "robot", mode?: Mode): Modifiers;
+/**
+ * Tunes the Retro Cape to allow it to grant a particular skill.
+ *
+ * @param skill The skill to tune the Retro Cape to.
+ * @returns Whether we successfully tuned the cape.
+ */
+export declare function tuneToSkill(skill: Skill): boolean;
+export {};

package/dist/resources/2020/RetroCape.js

@@ -0,0 +1,115 @@
+import { cliExecute } from "kolmafia";
+import { have as haveItem } from "../../lib";
+import { get } from "../../property";
+import { $item, $skill } from "../../template-string";
+const item = $item `unwrapped knock-off retro superhero cape`;
+/**
+ * Determines whether you have() the Retro Cape.
+ *
+ * @returns Whether you have the Retro Cape available.
+ */
+export function have() {
+    return haveItem(item);
+}
+const Heroes = {
+    vampire: {
+        "Muscle Percent": 30,
+        "Maximum HP": 50,
+    },
+    heck: {
+        "Mysticality Percent": 30,
+        "Maximum MP": 50,
+    },
+    robot: {
+        "Moxie Percent": 30,
+        "Maximum HP": 25,
+        "Maximum MP": 25,
+    },
+};
+export const currentHero = () => get("retroCapeSuperhero");
+export const currentMode = () => get("retroCapeWashingInstructions");
+const modeMap = new Map([
+    [
+        ["vampire", "hold"],
+        {
+            "Hot Resistance": 3,
+            "Cold Resistance": 3,
+            "Stench Resistance": 3,
+            "Spooky Resistance": 3,
+            "Sleaze Resistance": 3,
+        },
+    ],
+    [
+        ["vampire", "thrill"],
+        {
+            "Muscle Experience": 3,
+        },
+    ],
+    [
+        ["vampire", "kiss"],
+        {
+            Skill: $skill `Smooch of the Daywalker`,
+        },
+    ],
+    [
+        ["vampire", "kill"],
+        {
+            Skill: $skill `Slay the Dead`,
+        },
+    ],
+    [["heck", "thrill"], { "Mysticality Experience": 3 }],
+    [["heck", "kiss"], { Skill: $skill `Unleash the Devil's Kiss` }],
+    [["robot", "hold"], { Skill: $skill `Deploy Robo-Handcuffs` }],
+    [["robot", "thrill"], { "Moxie Experience": 3 }],
+    [["robot", "kiss"], { Skill: $skill `Blow a Robo-Kiss` }],
+    [["robot", "kill"], { Skill: $skill `Precision Shot` }],
+]);
+/**
+ * Tunes retro cape to a given setting
+ *
+ * @param hero The Superhero to set it to
+ * @param mode The washing instructions to set it to
+ * @returns Whether we successfully tuned the Retro Cape.
+ */
+export function set(hero, mode) {
+    if (!have())
+        return false;
+    if (currentHero() === hero && currentMode() === mode)
+        return true;
+    cliExecute(`retrocape ${hero} ${mode}`);
+    return currentHero() === hero && currentMode() === mode;
+}
+/**
+ * Returns the expected Modifiers of the Retro Cape for a particular setting
+ *
+ * @param hero The Superhero setting
+ * @param mode The washing instructions setting
+ * @returns A Modifiers object describing the Retro Cape were it to be tuned to that setting.
+ */
+export function getModifier(hero = currentHero(), mode = currentMode()) {
+    return {
+        ...Heroes[hero],
+        ...(modeMap.get([hero, mode]) ?? {}),
+    };
+}
+const skills = new Map([
+    [$skill `Smooch of the Daywalker`, ["vampire", "kiss"]],
+    [$skill `Slay the Dead`, ["vampire", "kill"]],
+    [$skill `Unleash the Devil's Kiss`, ["heck", "kiss"]],
+    [$skill `Deploy Robo-Handcuffs`, ["robot", "hold"]],
+    [$skill `Blow a Robo-Kiss`, ["robot", "kiss"]],
+    [$skill `Precision Shot`, ["robot", "kill"]],
+]);
+/**
+ * Tunes the Retro Cape to allow it to grant a particular skill.
+ *
+ * @param skill The skill to tune the Retro Cape to.
+ * @returns Whether we successfully tuned the cape.
+ */
+export function tuneToSkill(skill) {
+    const setting = skills.get(skill);
+    if (!setting || !have())
+        return false;
+    set(...setting);
+    return [currentHero(), currentMode()].every((element, index) => element === setting[index]);
+}

package/dist/resources/2021/CrystalBall.d.ts

@@ -0,0 +1,14 @@
+import { Location, Monster, Item } from "kolmafia";
+export declare const orb: Item;
+/**
+ * Determines whether you `have` the Miniature Crystal Ball
+ *
+ * @returns Whether you `have` the Miniature Crystal Ball
+ */
+export declare function have(): boolean;
+/**
+ * Ponders your orb (if it is able to do so safely) and then returns a Map keyed by location consisting of extant predictions
+ *
+ * @returns A map of all predictions currently active in an adventurer's miniature crystal ball, after visiting the "ponder" URL to refresh them.
+ */
+export declare function ponder(): Map<Location, Monster>;

package/dist/resources/2021/CrystalBall.js

@@ -0,0 +1,41 @@
+import { toLocation, toMonster, availableAmount, Item, visitUrl, myTotalTurnsSpent, totalTurnsPlayed, } from "kolmafia";
+import { canVisitUrl } from "../../lib";
+import logger from "../../logger";
+import { get } from "../../property";
+export const orb = Item.get("miniature crystal ball");
+/**
+ * Determines whether you `have` the Miniature Crystal Ball
+ *
+ * @returns Whether you `have` the Miniature Crystal Ball
+ */
+export function have() {
+    return availableAmount(orb) > 0;
+}
+const parsedProp = () => get("crystalBallPredictions")
+    .split("|")
+    .filter(Boolean)
+    .map((element) => element.split(":"))
+    .filter((tuple) => tuple.length === 3)
+    .map(([, location, monster]) => [toLocation(location), toMonster(monster)]);
+const getLastPondered = () => `${myTotalTurnsSpent()};${totalTurnsPlayed()};${get("lastAdventure")}`;
+let lastPondered = "";
+/**
+ * Ponders your orb (if it is able to do so safely) and then returns a Map keyed by location consisting of extant predictions
+ *
+ * @returns A map of all predictions currently active in an adventurer's miniature crystal ball, after visiting the "ponder" URL to refresh them.
+ */
+export function ponder() {
+    if (!have())
+        return new Map();
+    if (lastPondered !== getLastPondered()) {
+        if (canVisitUrl()) {
+            logger.debug("Now pondering Crystal Ball.");
+            visitUrl("inventory.php?ponder=1", false);
+            lastPondered = getLastPondered();
+        }
+        else {
+            logger.debug("Failed to ponder Crystall Ball.");
+        }
+    }
+    return new Map(parsedProp());
+}

package/dist/resources/2021/DaylightShavings.d.ts

@@ -0,0 +1,40 @@
+import { Effect } from "kolmafia";
+/**
+ * Returns whether the player owns an unpackaged Daylight Shavings Helmet, and it's available in either the inventory or other zones as determined by autoSatisfy settings.
+ *
+ * @returns whether we have the Daylight Shavings Helmet.
+ */
+export declare function have(): boolean;
+export declare const buffs: Effect[];
+/**
+ * Tells you whether you currently have a beardbuff active. Warning: because of spaghetti, this does not determine buff eligibility.
+ *
+ * @returns Whether you currently have a beardbuff active
+ */
+export declare function hasBuff(): boolean;
+/**
+ * Checks to see if there are any beardbuffs you have more than 1 turn of, determining whether you are eligible to receive a buff post-combat.
+ *
+ * @returns Whether you current are able to get a buff from the Daylight Shaving Helmet.
+ */
+export declare function buffAvailable(): boolean;
+/**
+ * Calculates and returns the cycle of buffs that the hat should cycle through.
+ *
+ * @param playerclass The class to generate a cycle for
+ * @returns An ordered array consisting of the cycle for this class. The first element of the array will be the first buff a player should expect to get in a given ascension.
+ */
+export declare function buffCycle(playerclass?: import("kolmafia").Class): Effect[];
+/**
+ * Returns the next buff we expect to get from the shaving hat.
+ *
+ * @returns The next buff we expect to get from the shaving hat.
+ */
+export declare function nextBuff(): Effect;
+/**
+ * Returns the number of buffs we expect it'll take to get to a given buff. Returns 1 for the next buff, 2 for the one after that, and so on. Returns 11 for the most recent buff.
+ *
+ * @param buff The shaving buff in question
+ * @returns The number of buffs we expect it'll take to get to the inputted buff; null if said buff is not granted by the shaving hat.
+ */
+export declare function buffsUntil(buff: Effect): number | null;