libram 0.7.11 → 0.7.13

package/dist/resources/2015/ChateauMantegna.js

@@ -1,14 +1,28 @@
 import { buy, getChateau, Item, runCombat, visitUrl } from "kolmafia";
 import { get } from "../../property";
+/**
+ * @returns Whether we own the Chateau Mantegna
+ */
 export function have() {
     return get("chateauAvailable");
 }
+/**
+ * @returns `null` for an empty painting; otherwise, the monster trapped in our painting
+ */
 export function paintingMonster() {
     return get("chateauMonster");
 }
+/**
+ * @returns Whether or not we've fought our painted monster today
+ */
 export function paintingFought() {
     return get("_chateauMonsterFought");
 }
+/**
+ * Fights your currently installed painting monster if able
+ *
+ * @returns The result of `runCombat`, which is the page html of the final round of combat
+ */
 export function fightPainting() {
     visitUrl("place.php?whichplace=chateau&action=chateau_painting", false);
     return runCombat();
@@ -28,16 +42,29 @@ export const nightstands = [
     "bowl of potpourri",
     "electric muscle stimulator",
 ];
+/**
+ * @returns The currently installed desk in your chateau; `null` for none
+ */
 export function getDesk() {
     return desks.find((desk) => Object.keys(getChateau()).includes(desk)) ?? null;
 }
+/**
+ * @returns The currently installed ceiling in your chateau; `null` for none
+ */
 export function getCeiling() {
     return (ceilings.find((ceiling) => Object.keys(getChateau()).includes(ceiling)) ??
         null);
 }
+/**
+ * @returns The currently installed nightstand in your chateau; `null` for none
+ */
 export function getNightstand() {
     return (nightstands.find((nightstand) => Object.keys(getChateau()).includes(nightstand)) ?? null);
 }
+/**
+ * @param desk The desk to change to
+ * @returns Whether our desk currently matches the one requested
+ */
 export function changeDesk(desk) {
     if (getDesk() === desk)
         return true;
@@ -46,6 +73,10 @@ export function changeDesk(desk) {
     buy(Item.get(desk));
     return getDesk() === desk;
 }
+/**
+ * @param ceiling The ceiling to change to
+ * @returns Whether our ceiling currently matches the one requested
+ */
 export function changeCeiling(ceiling) {
     if (getCeiling() === ceiling)
         return true;
@@ -54,6 +85,10 @@ export function changeCeiling(ceiling) {
     buy(Item.get(ceiling));
     return getCeiling() === ceiling;
 }
+/**
+ * @param nightstand The nightstand to change to
+ * @returns Whether our nightstand currently matches the one requested
+ */
 export function changeNightstand(nightstand) {
     if (getNightstand() === nightstand)
         return true;

package/dist/resources/2015/DeckOfEveryCard.d.ts

@@ -1,8 +1,30 @@
+/**
+ * @returns Do we `have` the Deck of Every Card?
+ */
 export declare function have(): boolean;
 declare const cards: readonly ["X of Clubs", "X of Diamonds", "X of Hearts", "X of Spades", "X of Papayas", "X of Kumquats", "X of Salads", "X of Cups", "X of Coins", "X of Swords", "X of Wands", "XVI - The Tower", "Professor Plum", "Spare Tire", "Extra Tank", "Sheep", "Year of Plenty", "Mine", "Laboratory", "Plains", "Swamp", "Mountain", "Forest", "Island", "Lead Pipe", "Rope", "Wrench", "Candlestick", "Knife", "Revolver", "Gift Card", "1952 Mickey Mantle", "XXI - The World", "III - The Empress", "VI - The Lovers", "Healing Salve", "Dark Ritual", "Lightning Bolt", "Giant Growth", "Ancestral Recall", "XI - Strength", "I - The Magician", "0 - The Fool", "X - The Wheel of Fortune", "The Race Card", "Green Card", "IV - The Emperor", "IX - The Hermit", "Werewolf", "The Hive", "XVII - The Star", "VII - The Chariot", "XV - The Devil", "V - The Hierophant", "Fire Elemental", "Christmas Card", "Go Fish", "Goblin Sapper", "II - The High Priestess", "XIV - Temperance", "XVIII - The Moon", "Hunky Fireman Card", "Aquarius Horoscope", "XII - The Hanged Man", "Suit Warehouse Discount Card", "Pirate Birthday Card", "Plantable Greeting Card", "Slimer Trading Card", "XIII - Death", "Unstable Portal"];
-declare type Card = keyof typeof cards;
+declare type Card = typeof cards[number];
+/**
+ * @returns The number of cards we've drawn so far today--remember, cheating counts as 5
+ */
 export declare function getCardsDrawn(): number;
+/**
+ * @returns The number of draws we have remaining today--remember, cheating counts as 5
+ */
 export declare function getRemainingDraws(): number;
+/**
+ * @returns The number of additional cards we can cheat today
+ */
+export declare function getRemainingCheats(): number;
+/**
+ * @returns An array of the Cards we've seen today
+ */
 export declare function getCardsSeen(): Card[];
+/**
+ * Cheat a card of your choice from the Deck
+ *
+ * @param card The card in question
+ * @returns `true` if we succeed or if we've already cheated that card today; `false` if we fail or are out of draws/cheats for the day.
+ */
 export declare function cheatCard(card: Card): boolean;
 export {};

package/dist/resources/2015/DeckOfEveryCard.js

@@ -3,6 +3,9 @@ import { have as have_ } from "../../lib";
 import { get } from "../../property";
 import { $item } from "../../template-string";
 import { clamp } from "../../utils";
+/**
+ * @returns Do we `have` the Deck of Every Card?
+ */
 export function have() {
     return have_($item `Deck of Every Card`);
 }
@@ -78,17 +81,38 @@ const cards = [
     "XIII - Death",
     "Unstable Portal",
 ];
+/**
+ * @returns The number of cards we've drawn so far today--remember, cheating counts as 5
+ */
 export function getCardsDrawn() {
     return clamp(get("_deckCardsDrawn"), 0, 15);
 }
+/**
+ * @returns The number of draws we have remaining today--remember, cheating counts as 5
+ */
 export function getRemainingDraws() {
     return 15 - getCardsDrawn();
 }
+/**
+ * @returns The number of additional cards we can cheat today
+ */
+export function getRemainingCheats() {
+    return Math.floor(getRemainingDraws() / 5);
+}
+/**
+ * @returns An array of the Cards we've seen today
+ */
 export function getCardsSeen() {
     return get("_deckCardsSeen")
         ? get("_deckCardsSeen").split("|")
         : [];
 }
+/**
+ * Cheat a card of your choice from the Deck
+ *
+ * @param card The card in question
+ * @returns `true` if we succeed or if we've already cheated that card today; `false` if we fail or are out of draws/cheats for the day.
+ */
 export function cheatCard(card) {
     if (getCardsSeen().includes(card))
         return true;

package/dist/resources/2015/Dinseylandfill.d.ts

@@ -14,6 +14,7 @@ declare class QuestData {
     questLocation: Location;
     /**
      * Process for determining where to put a wanderer to extract additional value from it
+     *
      * @param name easy to refer to name of the quest
      * @param priority ranked preference of quests
      * @param questNameKiosk returns the name of the quest as found at the dinseylandfill Job Kiosk

package/dist/resources/2015/Dinseylandfill.js

@@ -1,3 +1,4 @@
+/* eslint "jsdoc/require-jsdoc": "warn" */
 import { indexOf, myAdventures, myAscensions, runChoice, visitUrl, } from "kolmafia";
 import { getRemainingLiver, have as haveItem } from "../../lib";
 import { get, set } from "../../property";
@@ -21,6 +22,7 @@ class QuestData {
     questLocation;
     /**
      * Process for determining where to put a wanderer to extract additional value from it
+     *
      * @param name easy to refer to name of the quest
      * @param priority ranked preference of quests
      * @param questNameKiosk returns the name of the quest as found at the dinseylandfill Job Kiosk

package/dist/resources/2015/MayoClinic.d.ts

@@ -1,4 +1,3 @@
-import "core-js/modules/es.object.values";
 import { Item } from "kolmafia";
 export declare const Mayo: {
     nex: Item;
@@ -6,11 +5,19 @@ export declare const Mayo: {
     zapine: Item;
     flex: Item;
 };
+/**
+ * @returns Whether the Mayo Clinic is our current active workshed
+ */
 export declare function installed(): boolean;
+/**
+ * @returns Whether we `have` the Mayo Clinic, or it's installed
+ */
 export declare function have(): boolean;
 /**
  * Sets mayo minder to a particular mayo, and ensures you have enough of it.
+ *
  * @param mayo Mayo to use
  * @param quantity Quantity to ensure
+ * @returns Whether we succeeded in this endeavor; a trivial `false` for people without the clinic `installed`
  */
 export declare function setMayoMinder(mayo: Item, quantity?: number): boolean;

package/dist/resources/2015/MayoClinic.js

@@ -1,4 +1,3 @@
-import "core-js/modules/es.object.values";
 import { buy, getWorkshed, retrieveItem, toInt, use } from "kolmafia";
 import { have as haveItem } from "../../lib";
 import logger from "../../logger";
@@ -10,16 +9,24 @@ export const Mayo = {
     zapine: $item `Mayozapine`,
     flex: $item `Mayoflex`,
 };
+/**
+ * @returns Whether the Mayo Clinic is our current active workshed
+ */
 export function installed() {
     return getWorkshed() === $item `portable Mayo Clinic`;
 }
+/**
+ * @returns Whether we `have` the Mayo Clinic, or it's installed
+ */
 export function have() {
     return haveItem($item `portable Mayo Clinic`) || installed();
 }
 /**
  * Sets mayo minder to a particular mayo, and ensures you have enough of it.
+ *
  * @param mayo Mayo to use
  * @param quantity Quantity to ensure
+ * @returns Whether we succeeded in this endeavor; a trivial `false` for people without the clinic `installed`
  */
 export function setMayoMinder(mayo, quantity = 1) {
     if (getWorkshed() !== $item `portable Mayo Clinic`)

package/dist/resources/2016/SourceTerminal.d.ts

@@ -1,7 +1,9 @@
-import "core-js/modules/es.object.values";
 import { Effect, Item, Monster, Skill } from "kolmafia";
 import { Copier } from "../../Copier";
 export declare const item: Item;
+/**
+ * @returns Is the terminal currently installed & available in our campground?
+ */
 export declare function have(): boolean;
 /**
  * Buffs that can be acquired from Enhance
@@ -23,8 +25,10 @@ export declare const Buffs: {
 };
 /**
  * Acquire a buff from the Source Terminal
+ *
  * @param buff The buff to acquire
  * @see Buffs
+ * @returns Whether we successfully acquired the buff
  */
 export declare function enhance(buff: Effect): boolean;
 /**
@@ -42,8 +46,10 @@ export declare const RolloverBuffs: {
 };
 /**
  * Acquire a buff from the Source Terminal
- * @param buff The buff to acquire
+ *
+ * @param rolloverBuff The buff to acquire
  * @see RolloverBuffs
+ * @returns Whether we successfully `enquire`d the terminal for our rollover buff
  */
 export declare function enquiry(rolloverBuff: Effect): boolean;
 /**
@@ -66,14 +72,20 @@ export declare const Skills: {
 /**
  * Make a skill available.
  * The Source Terminal can give the player access to two skills at any time
- * @param skill Skill to learn
+ *
+ * @param skills Skill or 2-tuple of Skills to learn
  * @see Skills
+ * @returns Whether our current skills match the ones we asked for
  */
 export declare function educate(skills: Skill | [Skill, Skill]): boolean;
 /**
- * Return the Skills currently available from Source Terminal
+ * @returns The Skills currently available from Source Terminal
  */
 export declare function getSkills(): Skill[];
+/**
+ * @param skills A Skill or 2-tuple of Skills to check if we currently have active
+ * @returns Whether the input agrees with our current skills
+ */
 export declare function isCurrentSkill(skills: Skill | [Skill, Skill]): boolean;
 /**
  * Items that can be generated by the Source Terminal
@@ -81,81 +93,90 @@ export declare function isCurrentSkill(skills: Skill | [Skill, Skill]): boolean;
 export declare const Items: Map<Item, string>;
 /**
  * Collect an item from the Source Terminal (up to three times a day)
+ *
  * @param item Item to collect
  * @see Items
+ * @returns Whether the `cliExecute` succeeded
  */
 export declare function extrude(item: Item): boolean;
 declare type Chip = "INGRAM" | "DIAGRAM" | "ASHRAM" | "SCRAM" | "TRIGRAM" | "CRAM" | "DRAM" | "TRAM";
 /**
- * Return chips currently installed to player's Source Terminal
+ * @returns chips currently installed to player's Source Terminal
  */
 export declare function getChips(): Chip[];
 /**
- * Return number of times digitize was cast today
+ * @returns number of times digitize was cast today
  */
 export declare function getDigitizeUses(): number;
 /**
- * Return Monster that is currently digitized, else null
+ * @returns Monster that is currently digitized, else `null`
  */
 export declare function getDigitizeMonster(): Monster | null;
 /**
- * Return number of digitized monsters encountered since it was last cast
+ * @returns number of digitized monsters encountered since it was last cast
  */
 export declare function getDigitizeMonsterCount(): number;
 /**
- * Return maximum number of digitizes player can cast
+ * @returns maximum number of digitizes player can cast
  */
 export declare function getMaximumDigitizeUses(): number;
 /**
- * Returns the current day's number of remaining digitize uses
+ * @returns the current day's number of remaining digitize uses
  */
 export declare function getDigitizeUsesRemaining(): number;
 /**
- * Returns whether the player could theoretically cast Digitize
+ * @returns whether the player could theoretically cast Digitize
  */
 export declare function couldDigitize(): boolean;
+/**
+ * Sets Digitize to be one of our skilsl if it currently isn't
+ *
+ * @returns Whether we expect that Digitize is one of our active skills now
+ */
 export declare function prepareDigitize(): boolean;
 /**
- * Returns whether the player can cast Digitize immediately
+ * Determines whether the player can cast Digitize immediately
  * This only considers whether the player has learned the skill
  * and has sufficient daily casts remaining, not whether they have sufficient MP
+ *
+ * @returns Whether the player can currently cast digitize, ignoring the MP cost but accounting for other factors
  */
 export declare function canDigitize(): boolean;
 export declare const Digitize: Copier;
 /**
- * Return number of times duplicate was cast today
+ * @returns number of times duplicate was cast today
  */
 export declare function getDuplicateUses(): number;
 /**
- * Return number of times enhance was cast today
+ * @returns number of times enhance was cast today
  */
 export declare function getEnhanceUses(): number;
 /**
- * Return number of times portscan was cast today
+ * @returns number of times portscan was cast today
  */
 export declare function getPortscanUses(): number;
 /**
- * Returns maximum number of times duplicate can be used
+ * @returns maximum number of times duplicate can be used
  */
 export declare function maximumDuplicateUses(): number;
 /**
- * Returns number of remaining times duplicate can be used today
+ * @returns number of remaining times duplicate can be used today
  */
 export declare function duplicateUsesRemaining(): number;
 /**
- * Return number of times enhance can be used per day
+ * @returns number of times enhance can be used per day
  */
 export declare function maximumEnhanceUses(): number;
 /**
- * Returns number of remaining times enahce can be used today
+ * @returns number of remaining times enahce can be used today
  */
 export declare function enhanceUsesRemaining(): number;
 /**
- * Returns expected duration of an enhance buff
+ * @returns expected duration of an enhance buff
  */
 export declare function enhanceBuffDuration(): number;
 /**
- * Returns expected duration of an enquiry buff
+ * @returns expected duration of an enquiry buff
  */
 export declare function enquiryBuffDuration(): number;
 export {};

package/dist/resources/2016/SourceTerminal.js

@@ -1,4 +1,3 @@
-import "core-js/modules/es.object.values";
 import { cliExecute, Path, myPath, Skill, } from "kolmafia";
 import { Copier } from "../../Copier";
 import { haveInCampground } from "../../lib";
@@ -6,6 +5,9 @@ import { get } from "../../property";
 import { $effect, $item, $skill } from "../../template-string";
 import { arrayEquals } from "../../utils";
 export const item = $item `Source terminal`;
+/**
+ * @returns Is the terminal currently installed & available in our campground?
+ */
 export function have() {
     return haveInCampground(item);
 }
@@ -29,8 +31,10 @@ export const Buffs = {
 };
 /**
  * Acquire a buff from the Source Terminal
+ *
  * @param buff The buff to acquire
  * @see Buffs
+ * @returns Whether we successfully acquired the buff
  */
 export function enhance(buff) {
     if (!Object.values(Buffs).includes(buff)) {
@@ -53,8 +57,10 @@ export const RolloverBuffs = {
 };
 /**
  * Acquire a buff from the Source Terminal
- * @param buff The buff to acquire
+ *
+ * @param rolloverBuff The buff to acquire
  * @see RolloverBuffs
+ * @returns Whether we successfully `enquire`d the terminal for our rollover buff
  */
 export function enquiry(rolloverBuff) {
     if (!Object.values(RolloverBuffs).includes(rolloverBuff)) {
@@ -82,8 +88,10 @@ export const Skills = {
 /**
  * Make a skill available.
  * The Source Terminal can give the player access to two skills at any time
- * @param skill Skill to learn
+ *
+ * @param skills Skill or 2-tuple of Skills to learn
  * @see Skills
+ * @returns Whether our current skills match the ones we asked for
  */
 export function educate(skills) {
     const skillsArray = Array.isArray(skills) ? skills.slice(0, 2) : [skills];
@@ -97,7 +105,7 @@ export function educate(skills) {
     return true;
 }
 /**
- * Return the Skills currently available from Source Terminal
+ * @returns The Skills currently available from Source Terminal
  */
 export function getSkills() {
     return ["sourceTerminalEducate1", "sourceTerminalEducate2"]
@@ -105,6 +113,10 @@ export function getSkills() {
         .filter((s) => s !== "")
         .map((s) => Skill.get(s.slice(0, -4)));
 }
+/**
+ * @param skills A Skill or 2-tuple of Skills to check if we currently have active
+ * @returns Whether the input agrees with our current skills
+ */
 export function isCurrentSkill(skills) {
     const currentSkills = getSkills();
     const skillsArray = Array.isArray(skills) ? skills.slice(0, 2) : [skills];
@@ -127,8 +139,10 @@ export const Items = new Map([
 ]);
 /**
  * Collect an item from the Source Terminal (up to three times a day)
+ *
  * @param item Item to collect
  * @see Items
+ * @returns Whether the `cliExecute` succeeded
  */
 export function extrude(item) {
     const fileName = Items.get(item);
@@ -137,48 +151,53 @@ export function extrude(item) {
     return cliExecute(`terminal extrude ${fileName}`);
 }
 /**
- * Return chips currently installed to player's Source Terminal
+ * @returns chips currently installed to player's Source Terminal
  */
 export function getChips() {
     return get("sourceTerminalChips").split(",");
 }
 /**
- * Return number of times digitize was cast today
+ * @returns number of times digitize was cast today
  */
 export function getDigitizeUses() {
     return get("_sourceTerminalDigitizeUses");
 }
 /**
- * Return Monster that is currently digitized, else null
+ * @returns Monster that is currently digitized, else `null`
  */
 export function getDigitizeMonster() {
     return get("_sourceTerminalDigitizeMonster");
 }
 /**
- * Return number of digitized monsters encountered since it was last cast
+ * @returns number of digitized monsters encountered since it was last cast
  */
 export function getDigitizeMonsterCount() {
     return get("_sourceTerminalDigitizeMonsterCount");
 }
 /**
- * Return maximum number of digitizes player can cast
+ * @returns maximum number of digitizes player can cast
  */
 export function getMaximumDigitizeUses() {
     const chips = getChips();
     return (1 + (chips.includes("TRAM") ? 1 : 0) + (chips.includes("TRIGRAM") ? 1 : 0));
 }
 /**
- * Returns the current day's number of remaining digitize uses
+ * @returns the current day's number of remaining digitize uses
  */
 export function getDigitizeUsesRemaining() {
     return getMaximumDigitizeUses() - getDigitizeUses();
 }
 /**
- * Returns whether the player could theoretically cast Digitize
+ * @returns whether the player could theoretically cast Digitize
  */
 export function couldDigitize() {
     return getDigitizeUses() < getMaximumDigitizeUses();
 }
+/**
+ * Sets Digitize to be one of our skilsl if it currently isn't
+ *
+ * @returns Whether we expect that Digitize is one of our active skills now
+ */
 export function prepareDigitize() {
     if (!isCurrentSkill(Skills.Digitize)) {
         return educate(Skills.Digitize);
@@ -186,58 +205,60 @@ export function prepareDigitize() {
     return true;
 }
 /**
- * Returns whether the player can cast Digitize immediately
+ * Determines whether the player can cast Digitize immediately
  * This only considers whether the player has learned the skill
  * and has sufficient daily casts remaining, not whether they have sufficient MP
+ *
+ * @returns Whether the player can currently cast digitize, ignoring the MP cost but accounting for other factors
  */
 export function canDigitize() {
     return couldDigitize() && getSkills().includes(Skills.Digitize);
 }
 export const Digitize = new Copier(() => couldDigitize(), () => prepareDigitize(), () => canDigitize(), () => getDigitizeMonster());
 /**
- * Return number of times duplicate was cast today
+ * @returns number of times duplicate was cast today
  */
 export function getDuplicateUses() {
     return get("_sourceTerminalDuplicateUses");
 }
 /**
- * Return number of times enhance was cast today
+ * @returns number of times enhance was cast today
  */
 export function getEnhanceUses() {
     return get("_sourceTerminalEnhanceUses");
 }
 /**
- * Return number of times portscan was cast today
+ * @returns number of times portscan was cast today
  */
 export function getPortscanUses() {
     return get("_sourceTerminalPortscanUses");
 }
 /**
- * Returns maximum number of times duplicate can be used
+ * @returns maximum number of times duplicate can be used
  */
 export function maximumDuplicateUses() {
     return myPath() === Path.get("The Source") ? 5 : 1;
 }
 /**
- * Returns number of remaining times duplicate can be used today
+ * @returns number of remaining times duplicate can be used today
  */
 export function duplicateUsesRemaining() {
     return maximumDuplicateUses() - getDuplicateUses();
 }
 /**
- * Return number of times enhance can be used per day
+ * @returns number of times enhance can be used per day
  */
 export function maximumEnhanceUses() {
     return (1 + getChips().filter((chip) => ["CRAM", "SCRAM"].includes(chip)).length);
 }
 /**
- * Returns number of remaining times enahce can be used today
+ * @returns number of remaining times enahce can be used today
  */
 export function enhanceUsesRemaining() {
     return maximumEnhanceUses() - getEnhanceUses();
 }
 /**
- * Returns expected duration of an enhance buff
+ * @returns expected duration of an enhance buff
  */
 export function enhanceBuffDuration() {
     return (25 +
@@ -245,7 +266,7 @@ export function enhanceBuffDuration() {
         (getChips().includes("INGRAM") ? 25 : 0));
 }
 /**
- * Returns expected duration of an enquiry buff
+ * @returns expected duration of an enquiry buff
  */
 export function enquiryBuffDuration() {
     return (50 +

package/dist/resources/2016/Witchess.d.ts

@@ -1,6 +1,18 @@
 import { Monster } from "kolmafia";
 export declare const item: import("kolmafia").Item;
+/**
+ * @returns Is the Witchess installed and available in our campground?
+ */
 export declare function have(): boolean;
+/**
+ * @returns How many Witchess fights have we done so far today?
+ */
 export declare function fightsDone(): number;
 export declare const pieces: Monster[];
+/**
+ * Fight a Witchess piece of your choice
+ *
+ * @param piece The piece to fight
+ * @returns The value of `runCombat()`, which is the page html of the final round
+ */
 export declare function fightPiece(piece: Monster): string;

package/dist/resources/2016/Witchess.js

@@ -3,9 +3,15 @@ import { haveInCampground } from "../../lib";
 import { get } from "../../property";
 import { $item } from "../../template-string";
 export const item = $item `Witchess Set`;
+/**
+ * @returns Is the Witchess installed and available in our campground?
+ */
 export function have() {
     return haveInCampground(item);
 }
+/**
+ * @returns How many Witchess fights have we done so far today?
+ */
 export function fightsDone() {
     return get("_witchessFights");
 }
@@ -19,6 +25,12 @@ export const pieces = Monster.get([
     "Witchess Witch",
     "Witchess Ox",
 ]);
+/**
+ * Fight a Witchess piece of your choice
+ *
+ * @param piece The piece to fight
+ * @returns The value of `runCombat()`, which is the page html of the final round
+ */
 export function fightPiece(piece) {
     if (!pieces.includes(piece))
         throw new Error("That is not a valid piece.");